From Valve Developer Community
Jump to navigation
Jump to search
Test changes in the template's
/sandbox or
/testcases subpages, or in your own user subpage.
Consider discussing changes on the
talk page before implementing them.
Important: Colored links have been removed, but some old code remains for backward compatibility. Please do not bring back colored links just because they looked better in some places. Links to games, tools, and other software are clearly not what users should be focusing on when reading about a shader or something else.
Todo: Replace the old name with the current name in all child templates (as in Template:Half-Life 2).
Todo: Remove name, 3.1 and 4.1 from the wiki pages (darn, manually).
Template Documentation
Documentation language
...
English
Tip: This template now supports icons with 32px or larger, this meant that users can upload a large icon (128px for example) directly, without having to downscale the icon to 16px, as the MediaWiki software will do this automatically.
With the higher resolution icon available, these will benefits most 4K and Apple Retina display, and won't look blurry. See File:Icon-HL2.png.
Warning: When creating icon templates, the page title must include the full name of the game (example: Template:Half-Life 2), and instead create redirects for short name or abbreviation of a game name (Template:hl2).
For certain templates (such as {{This is a}}), do not use short names or abbreviated template redirect instead of full game name, since it will add the page into wrong category (Category:Hl2 point entities instead of Category:Half-Life 2 point entities).
{{Software}} is the template that underlies the icon templates. It has 8 main parameters:
| Parameter
|
Description
|
Value & Previews
|
{{{1}}}
|
The way the icon will be displayed. Displays the icon only when not specified.
|
{{hl2}} ►  (without specifying numbers)
{{hl2|1}} ► Half-Life 2
{{hl2|2}} ► Half-Life 2
{{hl2|3}} ► Half-Life 2
{{hl2|4}} ► Half-Life 2
{{hl2|imageonly}} ►
Enter "in", "also", "only", "since", "removed" or "not" (without quotes) to get the icon displayed along with additional text, like "(also in )".
 Note: However, the {{{1}}} parameter cannot be touched, it should always be "{{{1}}}" in the icon templates!
|
{{{name}}}
|
Simply display the name. However this param is also used to add the abbreviation of the game for example (when you create/edit this template).
Note: it is strongly recommended to write the abbreviation of the game in the parameter {{{name0}}}, {{{name1}}}, etc... or {{{nameiPadOS}}} (if supported, in templates such as {{iOS}}.
|
{{{ico}}}
|
The name of the icon is written here, but only the name itself, without "File:" and square brackets.
This same param is also used to display the icon you have specified when you create a new {{Software}} template. If the icon doesn't exist, it simply shows red link.
|
{{{ico size}}}
|
Width of the icon. Should be 16px for most icons, unless it's double, like  , in which case it should be 32px, or more. Experimentation may be necessary for non-square icons.
Tip: The software icon should be scaled to be in-line with the text size (using {{{ico size}}}). While this is nominally "16 pixels tall", high-DPI displays (particulary such as Apple Retina display, or 4K+ displays) will benefit from the file being higher resolutions; 32 or 64 pixels tall is generally sufficient, although any resolution can be used (MediaWiki will downscale the image automatically and only deliver the necessary resolution).
|
N/A
|
{{{link}}}
|
Link to the article, if not specified, the link will use the {{{name}}} parameter.
Write without the brackets. Underscores and spaces are interchangeable.
|
N/A
|
{{{extlink}}}
|
External link, for example: https://developer.valvesoftware.com/
Important: This param can not be used with {{{link}}}!
|
N/A
|
{{{addtext}}}
|
Additional text that will be written immediately after the icon. It is mainly needed to add other icons.
Note: Make sure to include | addtext = {{{addtext|}}} in the icon templates!
|
{{hl2|4|addtext=®}} ► Half-Life 2®
|
{{{nt}}}
|
This parameter will be used in the {{{name<number>}}} parameter, some software templates may also have {{{name<text>}}}, such as {{iOS}} and {{Mac}}.
Note: Make sure that the | nt = {{{nt|}}} part must be included on the icon templates for it to work! This parameters requires text to be displayed using {{{1}}} to use.
|
HL2
|
{{Software}} also supports 3 more icons:
| Parameter
|
Description
|
Value & Previews
|
{{{ico1}}} ~ {{{ico3}}}
|
The name of the icon is written here, but only the name itself, without "File:" and square brackets.
|
N/A
|
{{{ico1 size}}} ~ {{{ico3 size}}}
|
Width of the icon.
|
N/A
|
{{{ico1 name}}} ~ {{{ico3 name}}}
|
Name of the icon.
|
N/A
|
{{{IcoEnable1}}} ~ {{{IcoEnable3}}}
|
Show/Hide the icon, default is yes.
|
N/A
|
Result & Copy and Paste
In the end, you should get something like this:
{{Documentation|docpage = Template:Half-Life 2/doc}}
<includeonly>
<onlyinclude>{{Software link core
| {{{1|}}}
| ico = Icon-Portal2.png
| ico size = 16px
| link = Portal 2
| name = {{#switch:{{language}}
| #default = Portal 2
| ko = 포탈 2
| zh = 传送门2
| zh-tw = 傳送門 2
}}
| name0 = portal2
| addtext = {{{addtext|}}}
| nt = {{{nt|}}}
}}</onlyinclude>
</includeonly>
You can also copy and paste the code above to create a new icon template, or to convert old template ({{New icon}}) to {{Software}} and update {{Software}} templates.
Translations
Translations are handled on the /strings page.
How To Use
This is how the use of the template in articles will look like:
| Code
|
Result
|
{{portal2}}
|
|
{{portal2|1}}
|
Portal 2
|
{{portal2|2}}
|
Portal 2
|
{{portal2|3}}
|
Portal 2
|
{{portal2|4}}
|
Portal 2
|
{{portal2|in}}
|
(in )
|
{{portal2|only}}
|
(only in )
|
{{portal2|since}}
|
(in all games since )
|
{{portal2|not}}
|
(not in )
|
{{portal2|also|addtext= {{csgo}} {{l4d2}}}}
|
(also in   )
|
Template:Software link core
Summary
Aids in the creation of icon templates
Creation date
04/04/2022
(04 April 2022)
Last edited
12/06/2026
20260612052532
Revision size
4323 bytes
4.323 kilobytes
0.004323 megabytes
Contains translations
Yes
Uses parser functions?
Yes
This template uses a strings subpagePlease follow the format on this subpage(s) to add translations.
Number of strings:6
Approximate status of translation: 100% 
100%
66.67%
100%
100%
100%
16.67%
16.67%
16.67%
100%
100%
100%
100%
100%
