Template:Icon: Difference between revisions

From Melvor Idle
(Use Module:Icons, ensuring consistent logic for icons in both Lua generated & user-written content)
(Move documentation to subpage)
Tag: Replaced
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
A generic version of the template used in things like [[Template:ItemIcon]] or [[Template:UpgradeIcon]].
<includeonly>{{#invoke:Icons|Icon|{{{1|}}}|{{{2|}}}|type={{{type|}}}|ext={{{ext|}}}|size={{#if:{{{size|}}}|{{{size}}}|{{#if:{{{menu|}}}|25|23}}}}|qty={{{qty|}}}|img={{{img|}}}|notext={{{notext|}}}|nolink={{{nolink|}}}|noicon={{{noicon|}}}|menu={{{menu|}}}}}</includeonly><noinclude>
 
{{/doc}}
You probably want to use one of the following instead for most things:
</noinclude>
 
* [[Template:ItemIcon]] for items
* [[Template:MonsterIcon]] for monsters
* [[Template:Skill]] for skill
* [[Template:UpgradeIcon]] for upgrades (like the {{UpgradeIcon|Dragon Pickaxe}})
* [[Template:PetIcon]] for pets
* [[Template:PrayerIcon]] for prayers
* [[Template:ZoneIcon]] for combat zones
 
For example: {{T|ItemIcon|Raw Trout}} becomes {{ItemIcon|Raw Trout}}.
 
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
* <code>constellation</code> for Astrology constellations
 
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:
{| class="wikitable sortable"
! Input !! Output
|-
|{{T|Icon|Melee}} || {{Icon|Melee}}
|-
|{{T|Icon|Item Alchemy}} || {{Icon|Item Alchemy}}
|-
|{{T|Icon|Superheat}} || {{Icon|Superheat}}
|-
|{{T|Icon|Basic Resupply}} || {{Icon|Basic Resupply}}
|-
|{{T|Icon|Standard Resupply}} || {{Icon|Standard Resupply}}
|-
|{{T|Icon|Generous Resupply}} || {{Icon|Generous Resupply}}
|-
|{{T|Icon|type=monster|Golbin}}||{{Icon|type=monster|Golbin}}
|-
|{{T|Icon|type=monster|Spider (lv. 51)}}||{{MonsterIcon|Spider (lv. 51)}}
|-
|{{T|Icon|type=monster|Spider2}}||{{MonsterIcon|Spider2}}
|-
|{{T|Icon|type=skill|Alt. Magic}}||{{Icon|type=skill|Alt. Magic}}
|}
 
Other options:
 
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 {{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 {{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}}
 
<!-- Testing: Ambiguous pages
{{Icon|Golbin|type=monster}}
{{Icon|Golbin|type=thieving}}
{{Icon|Chick|type=pet}}
{{Icon|Chick|type=monster}}
{{Icon|Chicken|type=item}}
{{Icon|Chicken|type=monster}}
{{Icon|Cyclops|type=thieving}}
{{Icon|Cyclops|type=item}}
{{Icon|Cyclops|type=mark}}
{{Icon|Wizard|type=monster}}
{{Icon|Wizard|type=thieving}}
-->
<includeonly><onlyinclude>{{#invoke:Icons|Icon|{{{1|}}}|{{{2|}}}|type={{{type|}}}|ext={{{ext|}}}|size={{#if:{{{size|}}}|{{{size}}}|{{#if:{{{menu|}}}|25|23}}}}|qty={{{qty|}}}|img={{{img|}}}|notext={{{notext|}}}|nolink={{{nolink|}}}|noicon={{{noicon|}}}|menu={{{menu|}}}}}</onlyinclude></includeonly>

Revision as of 23:01, 17 April 2022

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.

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
  • thieving for Thieving NPCs

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.

For Herblore potions, the generic potion page can be linked to by specifying the potion name without a tier, for example: {{Icon|Diamond Luck Potion}} becomes Diamond Luck Potion.

Some special overrides exist:

Input Output
{{Icon|Melee}} Melee
{{Icon|Item Alchemy}} Item Alchemy
{{Icon|Superheat}} Superheat
{{Icon|Basic Resupply}} Basic Resupply
{{Icon|Standard Resupply}} Standard Resupply
{{Icon|Generous Resupply}} Generous Resupply
{{Icon|Golbin|type=monster}} Golbin
{{Icon|Alt. Magic|type=skill}} Alt. Magic
{{Icon|Earth Golem (AoD)|type=monster}} Earth Golem

Other options: