Editing Template:Icon/doc

From Eco - English Wiki

Your changes will be displayed to readers once an authorized user accepts them. (help)

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
== Description ==  
== Description ==
Use to create tiny icons (and captions). By default, the icon size is 28px but it can be re-defined.
Use to create tiny icons (and captions). By default, the icon size is 28px but it can be re-defined.
== Modules used ==
[[Module:IconUtils]]


== Syntax ==
== Syntax ==
<syntaxhighlight lang="mediawiki">{{Icon|name|style|link|size|border}}</syntaxhighlight>
<syntaxhighlight lang="mediawiki">{{Icon|name|style|link|iconsize}}</syntaxhighlight>


{| class="ecotable mw-half"
! Field
! Accepted Parameters
! Example
! Notes
|-
| <code>name</code>
| item name
| Charred Meat
| Name of the item as in the game
|-
| <code>style</code>
| 1,2,3
| 1
| Defines the (caption) style. Default is a small icon that is unlinkable with no caption.
* <code>1</code> = outputs no caption icon
* <code>2</code> = outputs the icon name as plain text next to the icon
* <code>3</code> = outputs the icon name as a small caption below the icon
* <code>4</code> = outputs the icon name  in frame with a small caption below the icon
|-
| <code>link</code>
| Page Name or 1
| Charred Meat
| Optional. Use if you want the icon to also link to a page.
*  When set to the default of 1, it will link to the same name as the item, but you can overwrite by writing in the designated page name in this field. If you are using this, you must write out <code>link=</code>
|-
| <code>size</code>
| any px size
| 50
| If you are using this, you must write out <code>size=</code> and assumes <code>px</code>.
|-
| <code>border</code>
| color name or Hex code
| green
| If you are using this, you must write html color name or Hex code as <code>border=</code>.
|}


== Samples ==
== Samples ==
{| class="ecotable mw-half" style="text-align:center"
! Example
! Syntax
! Result
|-
| Style 1, Size 100px, no link
| <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|size=100}}</syntaxhighlight>
| {{Icon|name=Charred Meat|size=100}}
|-
| Style 1, Size 50, Link itself
| <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=1|size=50}}</syntaxhighlight>
| {{Icon|name=Charred Meat|link=1|size=50}}
|-
| Style 2, No Size, Link to page Food
| <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=Food|style=2}}</syntaxhighlight>
| {{Icon|name=Charred Meat|link=Food|style=2}}
|-
| Style 3, Size 100, Link itself
| <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=1|size=100|style=3}}</syntaxhighlight>
| {{Icon|name=Charred Meat|link=1|size=100|style=3}}
|-
| Style 4, Size 50, Link itself, with border
| <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=1|size=50|style=4}}</syntaxhighlight>
| {{Icon|name=Charred Meat|link=1|size=50|style=4}}
|}


<noinclude>[[Category:Template Docs]]</noinclude>
<noinclude>[[Category:Template Docs]]</noinclude>
Please note that all contributions to Eco - English Wiki are considered to be released under the CC BY-NC-SA 4.0 (see Eco:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, please solve the following captcha:

Cancel Editing help (opens in new window)