Editing Template:Icon/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 for embedding icons in the Stellaris wiki, thus making them more colorful, easy to read and standardized. The available icons link to the concept they represent.

== Parameters ==

{| class="wikitable"
! Parameter
! Descriptions
! Required
! Default
|-
| 1 || Identifier for the icon || '''required''' || ''none''
|-
| 2 || Width of the icon || optional || 24px (usually, depends on icon)
|}

== Usage ==

; Syntax
: <code><nowiki>{{icon|identifier}}</nowiki></code> or <code><nowiki>{{icon|identifier|width}}</nowiki></code>

: Insert the relevant identifier in the above syntax. The available identifier can be found in the table below.

; Example
: <code><nowiki>{{icon|militarist}}</nowiki></code> will generate {{icon|militarist}}.

; Related templates
See also:
* {{template|iconify}} to add the text of the identifier after the icon
* {{template|icon link}} to use icons with a custom anchor link
* {{template|file icon}} to create icons directly from image files

== Creating new icons ==
Icons are created by adding a new entry to one of the icon subtemplates found at [[:Category:Subtemplates]] or in the table below.

* New icons must also be manually added to this doc page.
* From SolSys: An important thing to note when adding new entries to the icon template is ''how often an icon is going to be used''. If an icon is going to be used only a couple of times, and in a specific page, it is best to directly link the file. The reasoning is the that templates are being called as a whole each time they are used. If they are being loaded with one-time use icons it means they become more "expensive" to use and lead to slower page loads. Due to this please use caution when adding new icons. <!--quoting SolSys -->

==== Icon images ====
* Images for icons can be found in [[:Category:Icons]] on the wiki, and in {{path|gfx/interface/icons/}} in the game files.
* The default width for most icons is 24px, although certain categories are at 52px (buildings, modules, technology, avatars).
** If the icon image is taller that it is wide, set the height with x24px instead.
* Images for modifier icons should preferably be modified to add a black circle background, but I've been unable to get anyone who makes these images to locate or upload the template to do so.

==== Subtemplates ====
Subtemplate pages where the icons are defined.

By default, most icons will be defined in one of the alphabetical pages:
{|
|- style="vertical-align:top;"
|
* [[Template:Icon/a|Icon/a]]
* [[Template:Icon/b|Icon/b]]
* [[Template:Icon/c|Icon/c]]
* [[Template:Icon/d|Icon/d]]
* [[Template:Icon/e|Icon/e]]
* [[Template:Icon/f|Icon/f]]
* [[Template:Icon/g|Icon/g]]
|
* [[Template:Icon/h|Icon/h]]
* [[Template:Icon/i|Icon/i]]
* [[Template:Icon/j|Icon/j]]
* [[Template:Icon/k|Icon/k]]
* [[Template:Icon/l|Icon/l]]
* [[Template:Icon/m|Icon/m]]
* [[Template:Icon/n|Icon/n]]
|
* [[Template:Icon/o|Icon/o]]
* [[Template:Icon/p|Icon/p]]
* [[Template:Icon/q|Icon/q]]
* [[Template:Icon/r|Icon/r]]
* [[Template:Icon/s|Icon/s]]
* [[Template:Icon/t|Icon/t]]
* [[Template:Icon/u|Icon/u]]
|
* [[Template:Icon/v|Icon/v]]
* [[Template:Icon/w|Icon/w]]
* [[Template:Icon/x|Icon/x]]
* [[Template:Icon/y|Icon/y]]
* [[Template:Icon/z|Icon/z]]
|}

Additionally, some icons are defined in dedicated subtemplate pages for their category.
* [[Template:Icon/job|Icon/job]] - for job icons
* [[Template:Icon/tech|Icon/tech]] - for technology icons
* [[Template:Icon/trait|Icon/trait]] - for species trait icons

== Improve this template ==
This template is protected due to high traffic. If you have suggestions for improvements or extensions please note them on the [[{{TALKSPACE}}:{{PAGENAME}}|talk page]].

== List of available icons ==
{{expand|with=any undocumented icons you can find in the subtemplates. The technology section in particular needs to be updated}}
<tabbertransclude>
Template:Icon/doc/dlc|DLC
Template:Icon/doc/common|Common
Template:Icon/doc/planets|Planets
Template:Icon/doc/diplomacy|Diplomacy
Template:Icon/doc/government|Government
Template:Icon/doc/jobs|Jobs
Template:Icon/doc/military|Military
Template:Icon/doc/modifiers|Modifiers
Template:Icon/doc/tech|Technology
Template:Icon/doc/collection|Collection
Template:Icon/doc/traits|Traits
Template:Icon/doc/obsolete|Obsolete
</tabbertransclude>