Template:Icon: Difference between revisions

From Melvor Idle
(Added Alt. Magic override to Skill icon linking)
(Special handling for Cooking upgrade icons)
(27 intermediate revisions by 3 users not shown)
Line 9: Line 9:
* [[Template:PetIcon]] for pets
* [[Template:PetIcon]] for pets
* [[Template:PrayerIcon]] for prayers
* [[Template:PrayerIcon]] for prayers
* [[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}}
|-
|{{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}}
|-
|-
|<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|Spider (lv. 52)}}</nowiki>||{{MonsterIcon|Spider (lv. 52)}}
|{{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 {{T|Icon|Combat|menu=true}} becomes {{Icon|Combat|menu=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 '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 '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=500}}</nowiki> becomes {{Icon|type=item|Elder Dragonhide|qty=500}}
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><!--
<includeonly><onlyinclude><!--
Defining some variables to make things easier later
Defining some variables to make things easier later
Line 45: Line 80:
-->{{#vardefine:text|{{#if:{{{2|}}}|{{{2|}}}|{{#var:link}}}}}}<!--
-->{{#vardefine:text|{{#if:{{{2|}}}|{{{2|}}}|{{#var:link}}}}}}<!--
-->{{#vardefine:ext|{{#if:{{{ext|}}}|{{{ext|}}}|svg}}}}<!--
-->{{#vardefine:ext|{{#if:{{{ext|}}}|{{{ext|}}}|svg}}}}<!--
-->{{#vardefine:size|{{#if:{{{size|}}}|{{{size}}}|{{#if:{{{menu|}}}|25|23}}}}}}<!--
     Allowing for manual exception overrides for weird cases:
     Allowing for manual exception overrides for weird cases:
         Melee is a link to Attack but uses the Combat icon
         Melee uses the Combat icon
         Done to allow for easily fitting into combat triangle related tables
         Done to allow for easily fitting into combat triangle related tables
-->{{#ifeq:{{#var:link}}|Melee|{{#vardefine:image|Combat}}{{#vardefine:link|Attack}}}}<!--
-->{{#ifeq:{{#var:link}}|Melee|{{#vardefine:image|Combat}}}}<!--
         Golbin + monster icon type links directly to Golbin (monster) to skip disambiguation page
        Superheat goes to a generic Superheat page but pulls the icon for Superheat IV
-->{{#ifeq:{{#var:link}}|Golbin|{{#ifeq:{{#var:type}}|monster|{{#vardefine:link|Golbin (monster)}}}}}}<!--
-->{{#ifeq:{{#var:link}}|Superheat|{{#vardefine:image|Superheat IV}}{{#vardefine:type|spell}}}}<!--
         Item Alchemy goes to a generic Item Alchemy page but pulls the icon for Item Alchemy III
-->{{#ifeq:{{#var:link}}|Item Alchemy|{{#vardefine:image|Item Alchemy III}}{{#vardefine:type|spell}}}}<!--
        Special case to handle Basic/Standard/Generous Resupply shop items, which unusually are neither items nor upgrades
-->{{#switch:{{#var:link}}|Basic Resupply={{#vardefine:image|Lobster}}{{#vardefine:type|item}}|Standard Resupply={{#vardefine:image|Crab}}{{#vardefine:type|item}}|Generous Resupply={{#vardefine:image|Shark}}{{#vardefine:type|item}}}}<!--
        Skip disambiguation page for various ambiguous phrases, e.g. Chicken, Golbin
-->{{#switch:{{#var:link}}|Golbin|Chick|Chicken|Wizard={{#vardefine:link|{{#var:link}} ({{#var:type}})}}|Cyclops={{#vardefine:link|{{#var:link}} ({{#ifeq:{{#var:type}}|mark|item|{{#var:type}}}})}}}}<!--
         Handling for Spiders (since they come in two flavors)
         Handling for Spiders (since they come in two flavors)
-->{{#ifeq:{{#var:link}}|Spider (lv. 51)|{{#vardefine:image|Spider}}}}{{#ifeq:{{#var:link}}|Spider (lv. 52)|{{#vardefine:image|Spider}}}}<!--
-->{{#ifeq:{{#var:link}}|Spider (lv. 51)|{{#vardefine:image|Spider}}}}{{#ifeq:{{#var:link}}|Spider (lv. 52)|{{#vardefine:image|Spider2}}}}{{#ifeq:{{#var:link}}|Spider2|{{#vardefine:link|Spider (lv. 52)}}{{#ifeq:{{#var:image}}|{{#var:text}}|{{#vardefine:text|Spider (lv. 52)}}}}}}<!--
         Forcing the correct extension for Rhaelyx items
         Forcing the correct extension for the following:
-->{{#switch:{{#var:image}}|Crown of Rhaelyx|Circlet of Rhaelyx|Jewel of Rhaelyx|Charge Stone of Rhaelyx|Mysterious Stone={{#vardefine:ext|png}}}}<!--
            png: Rhaelyx items, Infernal Core, Miolite Caves monsters, Perilous Peaks monsters, Pyro pet, all 0.21+ items
            jpg: Lemon, Lemons, Lemonade
-->{{#switch:{{#var:image}}|Crown of Rhaelyx|Circlet of Rhaelyx|Jewel of Rhaelyx|Charge Stone of Rhaelyx|Mysterious Stone|Infernal Core|Wicked Greater Dragon|Hunting Greater Dragon|Chaotic Greater Dragon|Miolite Sprig|Miolite Trio|Miolite Warden|Miolite Monarch|Pyro|Adventure|Summoning Shard (Black)|Summoning Shard (Gold)|Summoning Shard (Silver)|Summoning Shard (Blue)|Summoning Shard (Green)|Summoning Shard (Red)|Cool Glasses|Infernal Core|Bag of Flour|Bread|Raw Beef|Beef|Raw Chicken|Apple|Plain Pizza Slice|Beef Pie|Meat Pizza Slice|Basic Soup|Strawberry Cupcake|Hearty Soup|Cherry Cupcake|Cream Corn Soup|Apple Pie|Chicken Soup|Strawberry Cake|Carrot Cake|Lemon Cake|Shrimp (Perfect)|Sardine (Perfect)|Herring (Perfect)|Seahorse (Perfect)|Trout (Perfect)|Salmon (Perfect)|Lobster (Perfect)|Swordfish (Perfect)|Anglerfish (Perfect)|Fanfish (Perfect)|Crab (Perfect)|Carp (Perfect)|Shark (Perfect)|Cave Fish (Perfect)|Manta Ray (Perfect)|Whale (Perfect)|Bread (Perfect)|Beef (Perfect)|Chicken (Perfect)|Plain Pizza Slice (Perfect)|Beef Pie (Perfect)|Meat Pizza Slice (Perfect)|Basic Soup (Perfect)|Strawberry Cupcake (Perfect)|Hearty Soup (Perfect)|Cherry Cupcake (Perfect)|Cream Corn Soup (Perfect)|Apple Pie (Perfect)|Chicken Soup (Perfect)|Strawberry Cake (Perfect)|Carrot Cake (Perfect)|Lemon Cake (Perfect)|Cherry Seeds|Cherry|Cheese|Cream|Sneak-Ers|Jeweled Necklace|Crate of Basic Supplies|Thiever's Cape|Marksman's Sigil|Crate of Food|Basic Bag|Cooking Apron|Shipwheel|Fishing Hook|Giant Club|Stack of Bones|Pile of Logs|Pile of Ores|Knight's Sigil|Knight's Cape|Whetstone|Wizard's Scroll|Wizard's Sigil|Prayer Scroll|Ring of Wealth|Chest of Gems|Antique Vase|Absorbing Shield|Chef's Spoon|Chef's Hat|Training Shield|Knight's Defender|Cave Giant Boots|Merchant's Permit|Bob's Gloves|Golbin Mask|Fine Coinpurse|Lumberjack's Top|Miner's Helmet|Sailor's Top|Jester's Hat|Jadestone|Gold Crested Shield|Book of Scholars|Amulet of Incantation|Thief's Moneysack|Seed Pouch|Runecrafting Pouch|Alchemist's Bag|Apple Tree Seeds={{#vardefine:ext|png}}|Chicken={{#ifeq:{{#var:type}}|item|{{#vardefine:ext|png}}}}|Lemon|Lemons|Lemonade={{#vardefine:ext|jpg}}}}<!--
        Additional extension overrides for Summoning marks
-->{{#ifeq:{{#var:type}}|mark|{{#vardefine:ext|png}}}}<!--
         Allowing for Alt. Magic to use the Magic image
         Allowing for Alt. Magic to use the Magic image
-->{{#ifeq:{{#var:type}}|skill|{{#switch:{{#var:link}}|Alt. Magic|Alt Magic|Alternative Magic={{#vardefine:image|Magic}}{{#vardefine:link|Alternative Magic}}}}}}<!--
-->{{#ifeq:{{#var:type}}|skill|{{#switch:{{#var:link}}|Alt. Magic|Alt Magic|Alternative Magic={{#vardefine:image|Magic}}{{#vardefine:link|Alternative Magic}}}}}}<!--
        Handling for Cooking Upgrade icons
-->{{#switch:{{#var:image}}|Cooking Upgrade 1|Cooking Upgrade 2={{#vardefine:image|Cooking}}{{#vardefine:type|skill}}}}<!--
Handling for 'menu' option
Handling for 'menu' option
-->{{#if:{{{menu|}}}|{{{!}} class="articletable" style="display:inline-block; vertical-align:bottom;"
-->{{#if:{{{menu|}}}|{{{!}} class="articletable" style="display:inline; vertical-align:middle;"
{{!}}-
{{!}}-
{{!}}|}}<!--
{{!}}| }}<!--
-->[[File:{{#var:image}}{{#if:{{#var:type}}|_({{#var:type}})|}}.{{#var:ext}}|25px|link={{#var:link}}]]{{#if:{{{qty|}}}|&nbsp;{{{qty|}}}|}}{{#if:{{{notext|}}}||&nbsp;[[{{#var:link}}|{{#var:text}}]]}}<!--
--><span style="display:inline-block">{{#if:{{{qty|}}}|{{formatnum:{{{qty|}}}}}&nbsp;|}}[[File:{{#var:image}}{{#if:{{#var:type}}|_({{#var:type}})|}}.{{#var:ext}}|{{#var:size}}x{{#var:size}}px|link={{#var:link}}]]{{#if:{{{notext|}}}||&nbsp;[[{{#var:link}}|{{#var:text}}]]}}</span><!--
-->{{#if:{{{menu|}}}|<br/>
-->{{#if:{{{menu|}}}|<br/>
{{!}}}|}}</onlyinclude></includonly>
{{!}}}|}}</onlyinclude></includonly>

Revision as of 11:18, 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}} 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