Template:Icon: Difference between revisions
From Melvor Idle
(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" | |||
|- class="headerRow-0" | |||
! rowspan="2" | Option !! rowspan="2" | Description !! colspan="2" | Example | |||
|- class="headerRow-1" | |||
! Input !! style="min-width:200px" | Output | |||
|- | |||
| <code>type</code> || Specifies the icon type || {{T|Icon|Normal Log|type=item}} || {{Icon|Normal Logs|type=item}} | |||
|- | |||
| <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 |
Revision as of 00:12, 2 December 2021
A generic version of the template used in things like Template:ItemIcon or Template:UpgradeIcon.
You probably want to use one of the following instead for most things:
- Template:ItemIcon for items
- Template:MonsterIcon for monsters
- Template:Skill for skill
- Template:UpgradeIcon for upgrades (like the
Dragon Pickaxe)
- Template:PetIcon for pets
- Template:PrayerIcon for prayers
- Template:ZoneIcon for combat zones
For example: {{ItemIcon|Raw Trout}}
becomes Raw Trout.
Some icon categories/types do not have these shorthand templates, so instead the type
parameter should be used: {{Icon|<IconName>|type=<IconType>}}
. The types this applies to are as follows:
mark
for Summoning marksspell
for standard and ancient magick spellscurse
for curse spellsaurora
for aurora spellsthieving
for Thieving NPCsconstellation
for Astrology constellations
Format is like so: {{Icon|Castle of Kings|Knight Time|type=combatArea}}
becomes Knight Time.
You can also just do {{Icon|Combat}}
Combat if you need an icon for an image that doesn't belong to a given category.
Some special overrides exist:
Input | Output |
---|---|
{{Icon|Melee}} |
|
{{Icon|Item Alchemy}} |
|
{{Icon|Superheat}} |
|
{{Icon|Basic Resupply}} |
![]() |
{{Icon|Standard Resupply}} |
![]() |
{{Icon|Generous Resupply}} |
![]() |
{{Icon|Golbin|type=monster}} |
![]() |
{{Icon|Spider (lv. 51)|type=monster}} |
![]() |
{{Icon|Spider2|type=monster}} |
File:Spider2 (monster).png Brown Spider |
{{Icon|Alt. Magic|type=skill}} |
Other options:
Option | Description | Example | ||
---|---|---|---|---|
Input | Output | |||
type |
Specifies the icon type | {{Icon|Normal Log|type=item}} |
![]() | |
ext |
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 | {{Icon|Golbin|ext=svg|type=monster}} |
||
size |
Determines the height (in pixels) of the image. If not specified the default is 25px (or 23px if the menu option is used) |
{{Icon|Combat|size=50}} |
||
qty |
Specifies the number of item to go alongside the icon and text | {{Icon|Elder Dragonhide|qty=5000|type=item}} |
5,000 ![]() | |
img |
If specified, this determines which image is used, in which case the first parameter only determines the link rather than the link and image | {{Icon|Mining|type=pet|img=Cool Rock}} |
||
notext |
If specified, only the image (with link) is generated | {{Icon|Mastery|notext=true}} |
||
nolink |
If specified, the text is generated without a link | {{Icon|Mastery|nolink=true}} |
||
noicon |
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 | {{Icon|Cyclops|noicon=true|type=thieving}} |
Cyclops | |
menu |
Formats the icon in a handy table (useful for menuboxes) | {{Icon|Combat|menu=true}} |
|