| [checked revision] | [checked revision] |
No edit summary Tag: 2017 source edit |
No edit summary Tag: 2017 source edit |
||
| Line 12: | Line 12: | ||
|- | |- | ||
| <code>name</code> | | <code>name</code> | ||
| | | item name | ||
| Cooking | | Cooking | ||
| | | | ||
|- | |- | ||
| <code>style</code> | | <code>style</code> | ||
| Line 20: | Line 20: | ||
| 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 | * <code>1</code> = outputs no caption icon | ||
* <code>2</code> = outputs the icon name as | * <code>2</code> = outputs the icon name as plain text next to the icon | ||
* <code>3</code> = outputs | * <code>3</code> = outputs the icon name as a small caption below the icon | ||
|- | |- | ||
| <code>link</code> | | <code>link</code> | ||
| Page Name | | Page Name or 1 | ||
| | | 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 | * 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 | ||
| | | 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>. | ||
|} | |} | ||
| Line 42: | Line 42: | ||
! Result | ! Result | ||
|- | |- | ||
| | | Style 1, Size 100px, no link | ||
| <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|size=100}}</syntaxhighlight> | | <syntaxhighlight lang="mediawiki">{{Icon|name=Charred Meat|size=100}}</syntaxhighlight> | ||
| {{Icon|name=Charred Meat|size=100}} | | {{Icon|name=Charred Meat|size=100}} | ||
|} | |} | ||
<noinclude>[[Category:Template Docs]]</noinclude> | <noinclude>[[Category:Template Docs]]</noinclude> | ||
Revision as of 10:16, 14 June 2024
Description
Use to create tiny icons (and captions). By default, the icon size is 28px but it can be re-defined.
Syntax
{{Icon|name|style|link|size}}| Field | Accepted Parameters | Example | Notes |
|---|---|---|---|
name
|
item name | Cooking | |
style
|
1,2,3 | 1 | Defines the (caption) style. Default is a small icon that is unlinkable with no caption.
|
link
|
Page Name or 1 | Charred Meat | Optional. Use if you want the icon to also link to a page.
|
size
|
any px size | 50 | If you are using this, you must write out size= and assumes px.
|
Samples
| Example | Syntax | Result |
|---|---|---|
| Style 1, Size 100px, no link | {{Icon|name=Charred Meat|size=100}} |
Module:IconUtils 'name' must be specified. |
