Template:Icon/doc

Description

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

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

Example	Syntax	Result
Style 1, Size 100px, no link	{{Icon|name=Charred Meat|size=100}}	Module:IconUtils 'name' must be specified.
Style 1, Size 50, Link itself	{{Icon|name=Charred Meat|link=1|size=50}}	Module:IconUtils 'name' must be specified.
Style 2, No Size, Link to page Food	{{Icon|name=Charred Meat|link=Food|style=2}}	Module:IconUtils 'name' must be specified.
Style 3, Size 100, Link itself	{{Icon|name=Charred Meat|link=1|size=100|style=3}}	Module:IconUtils 'name' must be specified.
Style 4, Size 50, Link itself, with border	{{Icon|name=Charred Meat|link=1|size=50|style=4}}	Module:IconUtils 'name' must be specified.