Editing Template:Iconify/doc

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
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
* Can be used instead of parameter 4 if set to 'red', 'yellow', or 'green'.
| optional || ''As defined by [[Template:Icon]].<br>Typically either 24px or 52px.''
|-
| 3 / mod || Inserts a string between the icon and text || optional || ''none''
|-
| 4 || Name of template to apply to parameter 3 (e.g. {{[[Template:Green|green]]}}) || optional || ''none''
|-
| 5 / text || Text to display || optional || parameter 1
|-
| mod || Adds a modifier between the icon and text. Can also be used with colored variants
* <code>mod=text</code> will yield a plaintext modifier
* <code>mod green=text</code> will yield a {{green|green}} modifier
* <code>mod red=text</code> will yield a {{red|red}} modifier
* <code>mod yellow=text</code> will yield a {{yellow|yellow}} modifier
| optional || ''none''
|-
| 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. pre-ftl) || 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''
|-
| icon || Sets custom icon, uses {{template|icon link}} template instead, with parameter 1 as anchor link || option || ''none''
|-
| icon2-5 || icon2, icon3, icon4, icon5 <br> Inserts an additional icon image between the icon and text. || optional || ''none''
|-
| 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
|}

== 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|icon2=Fanatic Militarist||Some degree of}}
|-
| <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|Influence|mod=50}}</nowiki></code> || {{iconify|Influence|mod=50}}
|-
| <code><nowiki>{{iconify|Minerals||−4|red}}</nowiki></code> || {{iconify|Minerals||−4|red}}
|-
| <code><nowiki>{{iconify|Scholar}}</nowiki></code> || {{iconify|Scholar}}
|-
| <code><nowiki>{{iconify|Scholar|pre=pre-ftl}}</nowiki></code> || {{iconify|Scholar|pre=pre-ftl}}
|-
| <code><nowiki>{{iconify|Mercantile}}</nowiki></code> || {{iconify|Mercantile}}
|-
| <code><nowiki>{{iconify|Mercantile|suf=tradition}}</nowiki></code> || {{iconify|Mercantile|suf=tradition}}
|-
| <code><nowiki>{{iconify|Amenities||+2|green|suf=add}}</nowiki></code> || {{iconify|Amenities||+2|green|suf=add}}
|-
| <code><nowiki>{{iconify|Juggernaut|24px|suf=tech|tech=rare}}</nowiki></code> || {{iconify|Juggernaut|suf=tech|24px|tech=rare}}
|-
| <code><nowiki>{{iconify|Commander|24px}}</nowiki></code> || {{iconify|Commander|24px}}
|-
| <code><nowiki>{{iconify|Commander|x24px}}</nowiki></code> || {{iconify|Commander|x24px}}
|-
| <code><nowiki>{{iconify|Capacity Subsidies|icon=edict}}</nowiki></code> || {{iconify|Capacity Subsidies|icon=edict}}
|}

== List of available icons ==
By default:
{{main|Template:Icon/doc#List of available icons}}
If <code>icon</code> parameter is used:
{{main|Template:Icon link/doc#Supported icons}}