ADAMJR: Create template

2024-07-17T16:23:19Z

Create template

New page

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>
{{template doc page viewed directly}}</noinclude>


This template can be used to add icons as generated by [[Template:Icon]] in front of words.

Use this template to standardise the order of elements in bonuses. It also suppresses alt text for improved accessibility.

== Parameters ==
{| class="wikitable"
!Parameter
!Description
!Required
!Default
|-
|1
|The icon to use. For a list of icons see [[Template:Icon/doc]].
|'''required'''
|''none''
|-
|2
|Width of the icon

* If preceded by an 'x', sets height instead of width
|optional
|''As defined by [[Template:Icon]].''
''Typically either 24px or 52px.''
|-
|3
|String to insert between the icon and text
|optional
|''none''
|-
|4
|<nowiki>Name of template to apply to parameter 3 (e.g. {{</nowiki>[[Template:Green|green]]<nowiki>}})</nowiki>
|optional
|''none''
|-
|5 / text
|Text to display
|optional
|parameter 1
|-
|prefix / pre
|Text added to the front of parameter 1 for the purpose of determining the icon, but excluded from the displayed icon text. (e.g. ap)
|optional
|''none''
|-
|suffix / suf
|Text added to the end of parameter 1 for the purpose of determining the icon, but excluded from the displayed icon text. (e.g. tech)
|optional
|''none''
|-
|icon2
| rowspan="4" |Inserts an additional icon image between the icon and text.
| rowspan="4" |optional
| rowspan="4" |''none''
|-
|icon3
|-
|icon4
|-
|icon5
|-
|tech
|Formats the icon text using [[Template:Tech]] with this parameter as the style.

* Doesn't format text produced by parameter 3.
|optional
|''none''
|-
|link
|Sets the link of the icon. Usable only with supported icons.
|optional
|''none''
|-
|hover
|Sets the hover text of the icon. Usable only with supported icons.
|optional
|''none''
|-
|nowrap
|If set to <code>yes</code>, keeps the icon and the text in the same line.
|optional
|no
|-
|sort
|If the icon is at the front of a cell in a sortable table, makes the cell sortable.
{| class="wikitable"
!value of sort
!data-sort-key=" "
|-
|icon / icon1
|the icon name, including the prefix and suffix parameters
|-
|icon2
|the icon2 parameter
|-
|icon3
|the icon3 parameter
|-
|icon4
|the icon4 parameter
|-
|icon5
|the icon5 parameter
|-
|yes
|the full displayed text, including parameter 3
|-
|text
|parameter 5 (or the text parameter) if defined, parameter 1 otherwise
|-
|''default''
|the sort parameter
|}
|optional
|''none''
|-
|cellstyle
|Requires sort. Adds cell styles in <code>style=""</code>
|optional
|''none''
|-
|rowspan / row
|Requires sort. Sets cell rowspan.
|optional
|1
|-
|colpan / col
|Requires sort. Sets cell colspan.
|optional
|1
|}

== Examples ==
{| class="wikitable"
!Wiki text
!Produces
|-
|<code><nowiki>{{iconify|Militarist}}</nowiki></code>|| {{iconify|Militarist}}
|-
|<code><nowiki>{{iconify|Militarist|36px|<br>}}</nowiki></code>|| {{iconify|Militarist|36px|<br>}}
|-
|<code><nowiki>{{iconify|Militarist|icon2=Fanatic Militarist||Some degree of}}</nowiki></code>|| {{iconify|Militarist||Some degree of|icon0=no|icon2=Fanatic Militarist}}
|-
|<code><nowiki>{{iconify|Fanatic Purifiers|icon2=Devouring Swarm|icon3=Determined Exterminator|text=Genocidal}}</nowiki></code>|| {{iconify|Fanatic Purifiers|icon2=Devouring Swarm|icon3=Determined Exterminator|text=Genocidal}}
|-
|<code><nowiki>{{iconify|Minerals||+4}}</nowiki></code>|| {{iconify|Minerals||+4}}
|-
|<code><nowiki>{{iconify|Minerals||−4|red}}</nowiki></code>|| {{iconify|Minerals||−4|red}}
|-
|<code><nowiki>{{iconify|World Shaper}}</nowiki></code>|| {{iconify|World Shaper}}
|-
|<code><nowiki>{{iconify|World Shaper|pre=ap}}</nowiki></code>|| {{iconify|World Shaper|pre=ap}}
|-
|<code><nowiki>{{iconify|monthly influence|suf=add||+1|green}}</nowiki></code>|| {{iconify|monthly influence||+1|green|suf=add}}
|-
|<code><nowiki>{{iconify|Juggernaut|24px|suf=tech|tech=rare}}</nowiki></code>|| {{iconify|Juggernaut|24px|suf=tech|tech=rare}}
|-
|<code><nowiki>{{iconify|admiral|24px}}</nowiki></code>|| {{iconify|admiral|24px}}
|-
|<code><nowiki>{{iconify|admiral|x24px}}</nowiki></code>|| {{iconify|admiral|x24px}}
|-
|<code><nowiki>{{iconify|Militarist|sort=yes|cellstyle=text-align:center; background-color:green}}</nowiki></code>|| {{iconify|Militarist|sort=yes|cellstyle=text-align:center; background-color:lightgreen}}
|}

== List of available icons ==
{{main|Template:Icon/doc#List of available icons}}

Template:Icon/doc - Revision history

ADAMJR: Create template