Template:Icon: Difference between revisions

From Melvor Idle
(Resolve various issues with ambiguous pages)
(Expand & format documentation)
Line 11: Line 11:
* [[Template:ZoneIcon]] for combat zones
* [[Template:ZoneIcon]] for combat zones


Format is like so: <nowiki>{{Icon|type=combatArea|Castle of Kings|Knight Time}}</nowiki> becomes {{Icon|type=combatArea|Castle of Kings|Knight Time}}.
For example: {{T|ItemIcon|Raw Trout}} becomes {{ItemIcon|Raw Trout}}.


You can also just do <nowiki>{{Icon|Combat}}</nowiki> {{Icon|Combat}} if you need an icon for an image that doesn't belong to a given category.
Some icon categories/types do not have these shorthand templates, so instead the <code>type</code> parameter should be used: {{T|Icon|<IconName>|type=<IconType>}}. The types this applies to are as follows:
 
* <code>mark</code> for Summoning marks
* <code>spell</code> for standard and ancient magick spells
* <code>curse</code> for curse spells
* <code>aurora</code> for aurora spells
* <code>thieving</code> for Thieving NPCs
 
Format is like so: {{T|Icon|type=combatArea|Castle of Kings|Knight Time}} becomes {{Icon|type=combatArea|Castle of Kings|Knight Time}}.
 
You can also just do {{T|Icon|Combat}} {{Icon|Combat}} if you need an icon for an image that doesn't belong to a given category.


Some special overrides exist:
Some special overrides exist:
Line 19: Line 29:
! Input !! Output
! Input !! Output
|-
|-
|<nowiki>{{Icon|Melee}}</nowiki> || {{Icon|Melee}}
|{{T|Icon|Melee}} || {{Icon|Melee}}
|-
|-
|<nowiki>{{Icon|Item Alchemy}}</nowiki> || {{Icon|Item Alchemy}}
|{{T|Icon|Item Alchemy}} || {{Icon|Item Alchemy}}
|-
|-
|<nowiki>{{Icon|Superheat}}</nowiki> || {{Icon|Superheat}}
|{{T|Icon|Superheat}} || {{Icon|Superheat}}
|-
|-
|<nowiki>{{Icon|Basic Resupply}}</nowiki> || {{Icon|Basic Resupply}}
|{{T|Icon|Basic Resupply}} || {{Icon|Basic Resupply}}
|-
|-
|<nowiki>{{Icon|Standard Resupply}}</nowiki> || {{Icon|Standard Resupply}}
|{{T|Icon|Standard Resupply}} || {{Icon|Standard Resupply}}
|-
|-
|<nowiki>{{Icon|Generous Resupply}}</nowiki> || {{Icon|Generous Resupply}}
|{{T|Icon|Generous Resupply}} || {{Icon|Generous Resupply}}
|-
|-
|<nowiki>{{Icon|type=monster|Golbin}}</nowiki>||{{Icon|type=monster|Golbin}}
|{{T|Icon|type=monster|Golbin}}||{{Icon|type=monster|Golbin}}
|-
|-
|<nowiki>{{Icon|type=monster|Spider (lv. 51)}}</nowiki>||{{MonsterIcon|Spider (lv. 51)}}
|{{T|Icon|type=monster|Spider (lv. 51)}}||{{MonsterIcon|Spider (lv. 51)}}
|-
|-
|<nowiki>{{Icon|type=monster|Spider2}}</nowiki>||{{MonsterIcon|Spider2}}
|{{T|Icon|type=monster|Spider2}}||{{MonsterIcon|Spider2}}
|-
|-
|<nowiki>{{Icon|type=skill|Alt. Magic}}</nowiki>||{{Icon|type=skill|Alt. Magic}}
|{{T|Icon|type=skill|Alt. Magic}}||{{Icon|type=skill|Alt. Magic}}
|}
|}


Other options:  
Other options:  


The 'notext' option sends only the image (with link), so <nowiki>{{Icon|Mastery|notext=true}}</nowiki> becomes {{Icon|Mastery|notext=true}}
The 'notext' option sends only the image (with link), so {{T|Icon|Mastery|notext=true}} becomes {{Icon|Mastery|notext=true}}


The 'menu' option formats the icon in a handy table (useful for menuboxes) so <nowiki>{{Icon|Combat|menu=true}}</nowiki> becomes {{Icon|Combat|menu=true}}
The 'menu' option formats the icon in a handy table (useful for menuboxes) so {{T|Icon|Combat|menu=true}} becomes {{Icon|Combat|menu=true}}


The 'qty' option allows you to specify a number of items to go between the icon and the text, so <nowiki>{{Icon|type=item|Elder Dragonhide|qty=5000}}</nowiki> becomes {{Icon|type=item|Elder Dragonhide|qty=5000}}
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}}


The 'size' option allows you to specify larger icons, so {{T|Icon|Combat|size=50|notext=true}} becomes {{Icon|Combat|size=50|notext=true}}
The 'size' option allows you to specify larger icons, so {{T|Icon|Combat|size=50|notext=true}} becomes {{Icon|Combat|size=50|notext=true}}

Revision as of 09:55, 10 October 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:

For example: {{ItemIcon|Raw Trout}} becomes Raw Trout (item).svg 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 marks
  • spell for standard and ancient magick spells
  • curse for curse spells
  • aurora for aurora spells
  • thieving for Thieving NPCs

Format is like so: {{Icon|Castle of Kings|Knight Time|type=combatArea}} becomes Castle of Kings (combatArea).svg Knight Time.

You can also just do {{Icon|Combat}} Combat.svg 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}} Combat.svg Melee
{{Icon|Item Alchemy}} Item Alchemy III (spell).svg Item Alchemy
{{Icon|Superheat}} Superheat IV (spell).svg Superheat
{{Icon|Basic Resupply}} Lobster (item).svg Basic Resupply
{{Icon|Standard Resupply}} Crab (item).svg Standard Resupply
{{Icon|Generous Resupply}} Shark (item).svg Generous Resupply
{{Icon|Golbin|type=monster}} Golbin (monster).svg Golbin
{{Icon|Spider (lv. 51)|type=monster}} Spider (monster).svg Spider (lv. 51)
{{Icon|Spider2|type=monster}} File:Spider2 (monster).svg Spider (lv. 52)
{{Icon|Alt. Magic|type=skill}} Magic (skill).svg Alt. Magic

Other options:

The 'notext' option sends only the image (with link), so {{Icon|Mastery|notext=true}} becomes Mastery.svg

The 'menu' option formats the icon in a handy table (useful for menuboxes) so {{Icon|Combat|menu=true}} becomes

Combat.svg Combat

The 'qty' option allows you to specify a number of items to go between the icon and the text, so {{Icon|Elder Dragonhide|qty=5000|type=item}} becomes 5,000 Elder Dragonhide (item).svg Elder Dragonhide

The 'size' option allows you to specify larger icons, so {{Icon|Combat|notext=true|size=50}} becomes Combat.svg