Template:Icon/doc: Difference between revisions

From Eco - English Wiki
[checked revision][checked revision]
No edit summary
Tag: 2017 source edit
No edit summary
Tag: 2017 source edit
 
(9 intermediate revisions by the same user not shown)
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}}</syntaxhighlight>
<syntaxhighlight lang="mediawiki">{{Icon|name|style|link|size|border}}</syntaxhighlight>


{| class="ecotable mw-half"
{| class="ecotable mw-half"
Line 13: Line 16:
  | <code>name</code>
  | <code>name</code>
  | item name
  | item name
  | Cooking
  | Charred Meat
  |  
  | Name of the item as in the game
|-
|-
  | <code>style</code>
  | <code>style</code>
Line 23: Line 26:
* <code>2</code> = outputs the icon name as plain text next to the 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>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>
  | <code>link</code>
Line 34: Line 38:
  | 50
  | 50
  | If you are using this, you must write out <code>size=</code> and assumes <code>px</code>.
  | 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>.
|}
|}


Line 46: Line 55:
  | {{Icon|name=Charred Meat|size=100}}
  | {{Icon|name=Charred Meat|size=100}}
|-
|-
  | Style 1, no Size, Link itself
  | Style 1, Size 50, Link itself
  | <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=1}}</syntaxhighlight>
  | <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=1|size=50}}</syntaxhighlight>
  | {{Icon|name=Charred Meat|link=1}}
| {{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>

Latest revision as of 08:46, 19 June 2024

Description[edit source]

Use to create tiny icons (and captions). By default, the icon size is 28px but it can be re-defined.

Modules used[edit source]

Module:IconUtils

Syntax[edit source]

{{Icon|name|style|link|size|border}}
Field Accepted Parameters Example Notes
name item name Charred Meat Name of the item as in the game
style 1,2,3 1 Defines the (caption) style. Default is a small icon that is unlinkable with no caption.
  • 1 = outputs no caption icon
  • 2 = outputs the icon name as plain text next to the icon
  • 3 = outputs the icon name as a small caption below the icon
  • 4 = outputs the icon name in frame with a small caption below the icon
link 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 link=
size any px size 50 If you are using this, you must write out size= and assumes px.
border color name or Hex code green If you are using this, you must write html color name or Hex code as border=.

Samples[edit source]

Example Syntax Result
Style 1, Size 100px, no link
{{Icon|name=Charred Meat|size=100}}
Style 1, Size 50, Link itself
{{Icon|name=Charred Meat|link=1|size=50}}
Style 2, No Size, Link to page Food
{{Icon|name=Charred Meat|link=Food|style=2}}
Food
Style 3, Size 100, Link itself
{{Icon|name=Charred Meat|link=1|size=100|style=3}}

Charred Meat
Style 4, Size 50, Link itself, with border
{{Icon|name=Charred Meat|link=1|size=50|style=4}}