Template:Icon: Difference between revisions

1,457 bytes added ,  2 December 2021
Add more complete documentation for options
(Use Module:Icons, ensuring consistent logic for icons in both Lua generated & user-written content)
(Add more complete documentation for options)
Line 51: Line 51:
|}
|}


Other options:  
Other options:
 
{| class="wikitable sortable stickyHeader"
The 'notext' option sends only the image (with link), so {{T|Icon|Mastery|notext=true}} becomes {{Icon|Mastery|notext=true}}
|- class="headerRow-0"
 
! rowspan="2" | Option !! rowspan="2" | Description !! colspan="2" | Example
The 'menu' option formats the icon in a handy table (useful for menuboxes) so {{T|Icon|Combat|menu=true}} becomes {{Icon|Combat|menu=true}}
|- class="headerRow-1"
 
! Input !! style="min-width:200px" | Output
The 'qty' option allows you to specify a number of items to go between the icon and the text, so {{T|Icon|type=item|Elder Dragonhide|qty=5000}} becomes {{Icon|type=item|Elder Dragonhide|qty=5000}}
|-
 
| <code>type</code> || Specifies the icon type || {{T|Icon|Normal Log|type=item}} || {{Icon|Normal Logs|type=item}}
The 'size' option allows you to specify larger icons, so {{T|Icon|Combat|size=50|notext=true}} becomes {{Icon|Combat|size=50|notext=true}}
|-
| <code>ext</code> || Specifies the image's extension. This should almost always be automatically determined, therefore if this option is required for the correct image to display then there is likely an issue with extension overrides within [[Module:Icons]] || {{T|Icon|Golbin|type=monster|ext=svg}} || {{Icon|Golbin|type=monster|ext=svg}}
|-
| <code>size</code> || Determines the height (in pixels) of the image. If not specified the default is 25px (or 23px if the <code>menu</code> option is used) || {{T|Icon|Combat|size=50}} || {{Icon|Combat|size=50}}
|-
| <code>qty</code> || Specifies the number of item to go alongside the icon and text || {{T|Icon|type=item|Elder Dragonhide|qty=5000}} || {{Icon|type=item|Elder Dragonhide|qty=5000}}
|-
| <code>img</code> || If specified, this determines which image is used, in which case the first parameter only determines the link rather than the link and image || {{T|Icon|Mining|img=Cool Rock|type=pet}} || {{Icon|Mining|img=Cool Rock|type=pet}}
|-
| <code>notext</code> || If specified, only the image (with link) is generated || {{T|Icon|Mastery|notext=true}} || {{Icon|Mastery|notext=true}}
|-
| <code>nolink</code> || If specified, the text is generated without a link || {{T|Icon|Mastery|nolink=true}} || {{Icon|Mastery|nolink=true}}
|-
| <code>noicon</code> || If specified, only the text (with link) is generated. This has limited use here, and was originally intended for use in Lua modules to allow for ease of disambiguating links || {{T|Icon|Cyclops|type=thieving|noicon=true}} || {{Icon|Cyclops|type=thieving|noicon=true}}
|-
| <code>menu</code> || Formats the icon in a handy table (useful for menuboxes) || {{T|Icon|Combat|menu=true}} || {{Icon|Combat|menu=true}}
|}


<!-- Testing: Ambiguous pages
<!-- Testing: Ambiguous pages