Template:Icon/doc: Difference between revisions

[checked revision]

Revision as of 14:16, 13 June 2024

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

{{Icon|name|style|link|iconsize}}

Field	Accepted Parameters	Example	Notes
`name`	file name	Cooking	No file extension needed (assumes .png).
`style`	1,2,3	1	Defines the (caption) style. Default is a small icon that is unlinkable with no caption. `1` = outputs the icon name as plain text next to the icon `2` = outputs the icon name as a small caption below the icon `3` = outputs no caption, but links the icon itself to its page of the same name. Recommended to use with `size` parameter
`link`	Page Name	Skills	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 `link=`
`size`	any px size	50	If you are using this, you must write out `size=` and assumes `px`.

Example	Syntax	Result
No Style, Size 100px	{{Icon\|ChefSkill\|size=100}}	Module:IconUtils 'name' must be specified.
Style 1	{{Icon\|ChefSkill\|1}}	Module:IconUtils 'name' must be specified.
Style 1 with link to its page	{{Icon\|ChefSkill\|1\|1}}	Module:IconUtils 'name' must be specified.
Style 2	{{Icon\|ChefSkill\|2}}	Module:IconUtils 'name' must be specified.
Style 2 with link to Skills page	{{Icon\|ChefSkill\|2\|Skills}}	Module:IconUtils 'name' must be specified.
Style 2, Size 100px	{{Icon\|ChefSkill\|2\|size=100}}	Module:IconUtils 'name' must be specified.
Style 3, different link, Size 80px	{{Icon\|ChefSkill\|3\|Skills\|size=80}}	Module:IconUtils 'name' must be specified.

@@ Line 22: / Line 22: @@
 * <code>1</code> = outputs the icon name as plain text next to the icon
 * <code>2</code> = outputs the icon name as a small caption below the icon
-* <code>3</code> = outputs no caption, but links the icon itself to its page of the same name. Recommended to use with <tvar name=1><code>size</code></tvar> parameter
+* <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>link</code>
@@ Line 28: / Line 28: @@
   | Skills
   | 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 <tvar name=1><code>link=</code></tvar>
+*  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>
 |-
   | <code>size</code>
   | any px size
   | {{formatnum: 50}}
-  | If you are using this, you must write out <tvar name=1><code>size=</code></tvar> and assumes <tvar name=2><code>px</code></tvar>.
+  | If you are using this, you must write out <code>size=</code> and assumes <code>px</code>.
 |}