Template:Icon/doc: Difference between revisions

From Eco - English Wiki
[checked revision][checked revision]
← Older edit
undoStalEF (talk | contribs)
Autochecked users, Editors, Reviewers, Administrators
5,237 edits
VisualWikitext
No edit summary
No edit summary
 
(25 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:Utils]]
* [[Module:Icon]]
* [[Module:IconUtils]]


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


{| class="ecotable mw-half"
{| class="ecotable mw-half"
Line 12: Line 17:
|-
|-
  | <code>name</code>
  | <code>name</code>
  | file name
  | item name
  | Cooking
  | Charred Meat
  | No file extension needed (assumes .png).
  | Name of the item as in the game
|-
|-
  | <code>style</code>
  | <code>style</code>
  | 1,2,3
  | 1,2,3,4,5
  | 1
  | 1
  | Defines the (caption) style. Default is a small icon that is unlinkable with no caption.
  | Defines the (caption) style. Default is a small icon that is unlinkable with no caption.
* <code>1</code> = outputs the icon name as plain text next to the icon
* <code>1</code> = outputs no caption icon
* <code>2</code> = outputs the icon name as a small caption below the icon
* <code>2</code> = outputs the icon name as plain text next to the icon
* <code>3</code> = outputs no caption, but links the icon itself to its page of the same name. Recommended to use with <code>size</code> parameter
* <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>5</code> = outputs the icon for recipes with count and border (Version from WugWugg)
|-
|-
  | <code>link</code>
  | <code>link</code>
  | Page Name
  | Page Name or 1
  | Skills
  | Charred Meat
  | Optional. Use if you want the icon to also link to a page.
  | 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 icon, 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>
*  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>
  | <code>size</code>
  | any px size
  | any px size
  | {{formatnum: 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>. Max size is 128px.
|-
| <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>.
|-
| <code>count</code>
| white,yellow,green
| green
| If you are using this, you must write count as <code>count=</code>.
|}
|}


Line 42: Line 59:
  ! Result
  ! Result
|-
|-
  | No Style, Size 100px
  | Style 1, Size 100px, no link
  | <syntaxhighlight lang="mediawiki">{{Icon|ChefSkill|size=100}}</syntaxhighlight>
  | <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|size=100}}</syntaxhighlight>
  | {{Icon|ChefSkill|size=100}}
  | {{Icon|name=Charred Meat|size=100}}
|-
| Style 1
| <syntaxhighlight lang="mediawiki">{{Icon|ChefSkill|1}}</syntaxhighlight>
| {{Icon|ChefSkill|1}}
|-
|-
  | Style 1 with link to its page
  | Style 1, Size 50, Link itself
  | <syntaxhighlight lang="mediawiki">{{Icon|ChefSkill|1|1}}</syntaxhighlight>
  | <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=1|size=50}}</syntaxhighlight>
  | {{Icon|ChefSkill|1|1}}
  | {{Icon|name=Charred Meat|link=1|size=50}}
|-
|-
  | Style 2
  | Style 2, No Size, Link to page Food
  | <syntaxhighlight lang="mediawiki">{{Icon|ChefSkill|2}}</syntaxhighlight>
  | <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=Food|style=2}}</syntaxhighlight>
  | {{Icon|ChefSkill|2}}
  | {{Icon|name=Charred Meat|link=Food|style=2}}
|-
|-
  | Style 2 with link to Skills page
  | Style 3, Size 100, Link itself
  | <syntaxhighlight lang="mediawiki">{{Icon|ChefSkill|2|Skills}}</syntaxhighlight>
  | <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=1|size=100|style=3}}</syntaxhighlight>
  | {{Icon|ChefSkill|2|Skills}}
  | {{Icon|name=Charred Meat|link=1|size=100|style=3}}
|-
|-
  | Style 2, Size 100px
  | Style 4, Size 50, Link itself, with border
  | <syntaxhighlight lang="mediawiki">{{Icon|ChefSkill|2|size=100}}</syntaxhighlight>
  | <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=1|size=50|style=4}}</syntaxhighlight>
  | {{Icon|ChefSkill|2|size=100}}
  | {{Icon|name=Charred Meat|link=1|size=50|style=4}}
|-
|-
  | Style 3, different link, Size 80px
  | Style 5, Size 64, Link itself, with green border and count 100
  | <syntaxhighlight lang="mediawiki">{{Icon|ChefSkill|3|Skills|size=80}}</syntaxhighlight>
  | <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|link=1|size=64|style=5|border=green|count=100}}</syntaxhighlight>
  | {{Icon|ChefSkill|3|link=Skills|size=80}}
  | {{Icon|name=Charred Meat|link=1|size=64|style=5|border=green|count=100}}
|}
|}


<noinclude>[[Category:Template Docs]]</noinclude>
<noinclude>[[Category:Template Docs]]</noinclude>

Latest revision as of 06:16, 24 February 2026

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]

Syntax

[edit source]
{{Icon|name|style|link|size|border|count}}
Field Accepted Parameters Example Notes
name item name Charred Meat Name of the item as in the game
style 1,2,3,4,5 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
  • 5 = outputs the icon for recipes with count and border (Version from WugWugg)
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. Max size is 128px.
border color name or Hex code green If you are using this, you must write html color name or Hex code as border=.
count white,yellow,green green If you are using this, you must write count as count=.

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}}

Charred Meat
Style 5, Size 64, Link itself, with green border and count 100 
{{Icon|name=Charred Meat|link=1|size=64|style=5|border=green|count=100}}
100
Retrieved from "https://wiki.play.eco/en/index.php?title=Template:Icon/doc&oldid=16377"
CC BY-NC-SA 4.0
Powered by MediaWiki