Template:Software/doc

This is a documentation subpage for Template:Software.
Don't forget to purge the contents of the base page upon creating or editing this subpage.

Purge base's cache

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.

{{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  {{{1|3-darker}}} ► Half-Life 2 {{{1|3.1}}} ► Half-Life 2 {{{1|3.2}}} ► Half-Life 2 {{{1|4-darker}}} ► Half-Life 2 {{{1|4.1}}} ► Half-Life 2 {{{1|4.2}}} ► Half-Life 2 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. Tip:For Wikipedia links, prepend "WP:" (short for Wikipedia) to the page name (ex: WP:Gabe Newell, or Wikipedia:Gabe Newell) For external links, use {{{extlink}}}.	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:

Template:Portal2

1.  
2.  
3.  
4.  
5.  
6.  
7.  
8.  
9.  
10.  
11.  
12.  
13.  
14.  
15.  
16.  
17.  
18.  
19.  
20.  
21.  
22.  
23.  
24.  
25.  
26.  

{{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 }} <!-- Switch parser function are now used for translation. The template will automatically translate when you select different languages in the language toolbar. Suf-based translation and suf parameters 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 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|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   )

Template:Software

Summary

Aids in the creation of icon templates

Type

Metatemplate

Contributors

N/A

Creation date

04/04/2022
(04 April 2022)

Notes

N/A

Subpages

Documentation

/doc

Preload

N/A

Sandbox

/sandbox

Strings

/strings

Testcases

N/A

Other

N/A

Revision information

Latest editor

Kr0tchet

Last edited

28/07/2025
20250728055419

Revision size

11014 bytes
11.014 kilobytes
0.011014 megabytes

Technical information

Page identifier

46333

Contains translations

Yes

Uses parser functions?

Yes

Uses variables?

Yes