Open main menu

Project: Gorgon Wiki β

Changes

Template:Item/doc

1,635 bytes added, 13:52, 20 April 2022
m
Added a link to new template.
== Description ==
:Use this template whenever you want the item icon and link (to the item's Wiki page) to display.:If the Item is to be displayed in a loot table for a monster, use [[Template:Loot]] instead.:If you only want to display an item's icon, or use a larger image of the icon, use the [[Template:Item_icon|Item icon]] template.:If you need the icon for an ability, use the template for [[Template:Ability_icon|Ability icon]].
== Syntax ==
:Type <kbd>{{t|Item|Item name}} </kbd> or <kbd>{{|Item|Icon|Item name}}</kbd> where you want the item icon and link to display.
== Parameters ==
; Icon
: OPTIONAL name of icon to use if different than item name.
; Item name
: The correct capitalized name of the item.
== Sample output ==
;Basic usage:{| class="wikitable"
| Code
| {{=}}
| Output
|-
| <nowiki>{{tlc|Item|Saltpeter}}</nowiki>
| &rArr;
| {{Item|Saltpeter}}
|}
;Complex example
:Use alternate icon and link with alternate text. Note usage of <kbd><nowiki>{{pipe}}</nowiki></kbd> to distinguish from normal template arguments:
:{| class="wikitable"
| Code
| {{=}}
| Output
|-
| <nowiki>{{Item|Icon=Beginner's Arrow|Archery{{pipe}}Learn Archery}}</nowiki>
| &rArr;
| {{Item|Icon=Beginner's Arrow|Archery{{pipe}}Learn Archery}}
|}
;Items with a # character in the name should be handled slightly differently, as the # character has special meanings in URLs, so items with a # character in the name are located at a page with that character removed (e.g. the page for Fisherman's Arrangement #1 is at [[Fisherman's Arrangement 1]]).
:{| class="wikitable"
| Code
| {{=}}
| Output
|-
| <nowiki>{{|Item|Icon=Fisherman's Arrangement #1|Fisherman's Arrangement 1}}</nowiki>
| &rArr;
| {{Item|Icon=Fisherman's Arrangement #1|Fisherman's Arrangement 1}}
|}
== Note Notes ==: * Uses the new [[Template:Item icon]] template.* WHY? To support enhancements in <nowiki>{{Vendor item row}}</nowiki> template.* This will break slightly when used on many flower arrangements and flower arrangement-related items, due to the # sign in the URL. See the example above for the workaround.
<includeonly>
<!-- Categories/interwikis for the template itself -->
[[Category:Formatting templates|ItemTItem]]
</includeonly><noinclude>
<!-- Categories/interwikis for this documentation itself -->
[[Category:Template documentation|{{PAGENAME}}]]
</noinclude>