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.
Don't forget to purge the contents of the base page upon creating or editing this subpage.
Todo: See Template:Software/doc/draft
Todo: Replace the complicated =suf method translations with /strings and {{autolang}} + {{uselangflags}} one instead.
{{Software}} is the template that underlies the icon templates. It has 8 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.
- {{{1|1}}} ► Half-Life 2
- Enter 2 to get the icon and the name of the game after it.
- {{{1|2}}} ►
Half-Life 2
- {{{1|2}}} ►
- Enter 3 to get the same as in the case of the number 1, but with an additional design with colored text.Add
-darkerafter the number to make the background darker to make the text and icon more visible on light background).- {{{1|3}}} ► Half-Life 2
- {{{1|3-darker}}} ► Half-Life 2
- Enter 4 to get the same as in the case of the number 2, but with an additional design with colored text. Add
-darkerafter the number to make the background darker to make the text and icon more visible on light background).- {{{1|4}}} ► Half-Life 2
- {{{1|4-darker}}} ► Half-Life 2
- {{{1|4}}} ►
- Enter 3.1 or 4.1 will get the same effect as above, but without the shadow behind the text and icon.
- {{{1|3.1}}} ► Half-Life 2
- {{{1|4.1}}} ► Half-Life 2
- Enter 3.2 or 4.2 will get the same effect as above, but with different drop shadow effect.
- {{{1|3.2}}} ► Half-Life 2
- {{{1|4.2}}} ► Half-Life 2
- 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>)".
Note: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. Recommended name (not required):
file:hl2 icon.pngfor {{hl2}} - {{{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).- {{{link}}} – link to the article, External links do not work. If not used, the link will use the {{{name}}} parameter.
Write without the brackets. Underscores and spaces are interchangeable.
Tip:For Wikipedia links, prepend "Wikipedia:" to the page name (ex: Wikipedia:Gabe Newell). For external links, use {{software external}} and add {{{is outlink}}}.- {{{name}}} – display name.
- {{{name<number>}}} – this parameter displays an alternate name based on the {{{nt}}} parameter.
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}}.- {{{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. - {{{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!- {{{nt}}} – this parameter will be used in the {{{name<number>}}} parameter, some 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!Result & Copy and Paste
In the end, you should get something like this:
You can also copy and paste the code above to create a new icon template.
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:
Template:Software
Summary
Aids in the creation of icon templates
Type
Metatemplate
Contributors
N/A
Creation date
04/04/2022
(04 April 2022)
(04 April 2022)
Notes
N/A
Subpages
Documentation
Preload
N/A
Sandbox
N/A
Strings
Testcases
N/A
Other
N/A
Revision information
Latest editor
SirYodaJedi
Last edited
15/04/2024
20240415113636
20240415113636
Revision size
7806 bytes
7.806 kilobytes
0.007806 megabytes
7.806 kilobytes
0.007806 megabytes
Technical information
Page identifier
46333
Contains translations
Yes
Uses parser functions?
Yes
Uses variables?
Yes
