Template:Software/doc

From Valve Developer Community
Jump to navigation Jump to search

Template:New_icon is the template that underlies the icon templates. It has 7 main parameters:

  • {{{1}}} - the way the icon will be displayed.
    • Do not enter this value if you need a regular icon.
    • Enter 1 to get the name of the game with a link to an article about the game.
    • Enter 2 to get the icon and the name of the game after it.
    • Enter 3 to get the same as in the case of the number 1, but with an additional design.
    • Enter 4 to get the same as in the case of the number 2, but with an additional design.
    • Enter "col" (without quotes) to get the color of the game. This is mainly needed for other templates.
    • Enter "in", "also", "only", "since", "removed" or "not" (without quotes) to get the icon displayed along with additional text, like "(also in <game icon>)". There is also an automatic translation here, so if you type "suf=:es" the text will also be in Spanish.
Note.pngNote:however, the {{{1}}} parameter cannot be touched, it should always be "{{{1}}}" in the icon templates!
  • {{{ico}}} - the name of the icon is written here, but only the name itself, without "File:" and square brackets.
  • {{{link}}} - link to the article, external links do not work. If not used, the link will use the {{{name}}} parameter. Write without the "_".
  • {{{name}}} - display name. Write without the "_".
    • {{{name:<lang_code>}}} - Instead of <lang_code>, write down the code of the language you need and the localized name. It will be shown depending on the parameter {{{suf}}}.
  • {{{suf}}} - the suffix that is added at the end of the link to the article so that you can make links to different languages of the article. Be sure to write ":es" but not "es".
Note.pngNote:{{{suf}}} should also be "suf={{{suf|}}}" in the icon templates, but after "{{{suf" there should be "|}}}" so that entering this parameter is optional.
  • {{{col}}} - the color of the game. If it is not specified, just do not enter this parameter, the standard color will be used: #ADD8E6.
  • {{{addtext}}} - additional text that will be written immediately after the icon. It is mainly needed to add other icons, however, they will not be associated with the template in any way, so for them you will have to enter the "suf" parameter again.
Note.pngNote:"addtext={{{addtext|}}}" in the icon templates!

Result

In the end, you should get something like this (Template:Portal2 was taken as an example):

<onlyinclude><includeonly>{{New icon|{{{1}}}|ico=Portal2-16px.png|name=Portal 2|suf={{{suf|}}}|col=#23B1E5|addtext={{{addtext|}}}}}</includeonly></onlyinclude>
{{documentation|Template:Hl2/doc}}

How To Use

This is how the use of the icon template in articles will look like:

Note.pngNote:Some of the examples given may lead to non-existent pages.
{{portal2}} Portal 2
{{portal2|1}} Portal 2
{{portal2|2}} Portal 2 Portal 2
{{portal2|3}} Portal 2
{{portal2|4}} Portal 2 Portal 2
{{portal2|1|suf=:es}} Portal 2
{{portal2|4|suf=:zh-cn}} Portal 2 Portal 2
{{portal2|col}} #23B1E5
{{portal2|in}} (in Portal 2)
{{portal2|only}} (only in Portal 2)
{{portal2|since}} (in all games since Portal 2)
{{portal2|not}} (not in Portal 2)
{{portal2|removed|suf=:ru}} (removed since Portal 2)
{{portal2|also|suf=:de|addtext={{csgo|suf=:de}} {{l4d2|suf=:de}}}} (also in Portal 2Counter-Strike: Global Offensive Left 4 Dead 2)