From Valve Developer Community
Jump to navigation
Jump to search
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.Todo: Use backward compatibility in all child templates. The improvement work may not continue soon, but some progress has already been made.
Bug:{{{addtext}}} does not work with all {{{1}}} options. Same is probably the case for {{{addtext-front}}}. [todo tested in?]
Available doc translations
…
English
This template uses a strings subpagePlease follow the format on this subpage(s) to add translations.
Todo: Replace the =suf method translations with /strings and #switch: {{language}} instead.
{{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.
|
{{{1}}} ►  (without specifying numbers)
{{{1|1}}} ► Half-Life 2
{{{1|1.bold}}} ► Half-Life 2
{{{1|2}}} ► Half-Life 2
{{{1|2.bold}}} ► Half-Life 2
{{{1|3}}} ► Half-Life 2
{{{1|4}}} ► Half-Life 2
Click "Expand" to see more
Enter "col" (without quotes) to get the text color of the game/software.
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!Note:Colored text should be used when appropriate, otherwise it would clutter the page.
|
{{{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}}.
|
Half-Life 2
|
{{{bold}}}
|
Same as above, with bold text.
|
Half-Life 2
|
{{{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.
|
Hl2 icon.png
|
{{{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
|
{{{col}}}
|
The color of the game. If it is not specified, just do not enter this parameter, the standard color will be used: #ADD8E6.
It's highly recommended that you use brighter color for better readability with dark/black pages, but not too bright or over-saturated.
|
#E6AC39
|
{{{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
|
{{{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
|
Result & Copy and Paste
In the end, you should get something like this:
{{doc|docpage=Template:Hl2/doc}}
<includeonly><onlyinclude>{{Software
| {{{1}}}
| ico = portal2 icon.png <!-- Icons with higher-resolution (256px or more for example) are now supported.
User with low DPI monitor will see 16px, but users with 4K/Apple Retina will see 32px or higher, providing better quality. -->
| ico size = 16px <!-- Note: This should always be kept at or near 16px, even with higher-res icon, unless the image is wider. For example, a 1:2 aspect ratio would be 32px. -->
| link = Portal 2
| name = {{#switch: {{language}}
| #default = Portal 2
| ko = 포탈 2
| zh = 传送门 2
| zh-tw = 傳送門 2
}}
<!-- Autolang is now used for translation, which is done automatically by selecting the languages in the language toolbar. Suf-based translation are now deprecated. -->
| name0 = portal2
| namePortal 2 = {{#switch: {{language}}
| #default = Portal 2
| ko = 포탈 2
| zh = 传送门 2
| zh-tw = 傳送門 2
}}
| namemoddir = portal2
| col = #23B1E5
| 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 by the {{In text}} Template.
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|3-darker}}
|
Portal 2
|
{{portal2|3.1}}
|
Portal 2
|
{{portal2|3.2}}
|
Portal 2
|
{{portal2|4}}
|
Portal 2
|
{{portal2|4-darker}}
|
Portal 2
|
{{portal2|4.1}}
|
Portal 2
|
{{portal2|4.2}}
|
Portal 2
|
{{portal2|ico}}
|
Icon-Portal2.png
|
{{portal2|col}}
|
#23B1E5
|
{{portal2|name}}
|
Portal 2
|
{{portal2|bold}}
|
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   )
|
Summary
Aids in the creation of icon templates
Creation date
04/04/2022
(04 April 2022)
Last edited
18/11/2024
20241118205246
Revision size
9363 bytes
9.363 kilobytes
0.009363 megabytes
Contains translations
Yes
Uses parser functions?
Yes
