View source for Template:Tooltip/doc

The template creates a [[WoW]]-styled tooltip for items; you can supply any number of the named parameters to display specific text in the tooltip.

Tooltips for other purposes can be created using the templates {{t|abilitytip}}, {{t|effecttip}}, {{t|settip}}, {{t|achievementbox}}, and {{t|enchant}}/{{t|embroid}}. The development version of this template can be found at {{t|Tooltip/Dev}}

===Required Minimal Syntax===
Begin all item-page tooltips with the following three lines:
 <nowiki>&lt;onlyinclude&gt;{{{{{tpl|</nowiki>tooltip}}}
 |mode=<nowiki>{{{</nowiki>mode|}}}
 |arg=<nowiki>{{{</nowiki>arg|}}}
All item-page tooltips should end with the following line:
 <nowiki>}}&lt;/onlyinclude&gt;</nowiki>
The template parameters displayed here are required to enable item pages interact with other consumers of tooltip data, and do not change from page to page.

===Named parameters===
This is the full list of named parameters listed in order that they appear in the displayed/in-game tooltip. Parameters that apply color to text in the finished tooltip have the same color here.

{| class=darktable
|-
| valign="top"|
;|icon=: icon to display. omit Image:/File: and extension (.png). Uses {{t|icon}}.<br/>Example: |icon=INV Ingot Titansteel red
;|stack=: stack size for stackable items. Uses {{t|icon}}.
;|name=: item name as it appears in-game.
;|disambigpage=: name of WoWWiki page for this item, if different from |name=.<br/>Example: |disambigpage=Atiesh, Greatstaff of the Guardian (Mage)
;|quality=: [[quality|item quality]], passed to {{t|quality}} to generate formatted item name.
;|<span style="color: #0f0;">heroic</span>=: if the item is [[Heroic mode|Heroic]].<br/>Example: |heroic=1
;|instancebind=: the zone that the item is bound to.<br/>Example: |instancebind=Tempest Keep
;|conjured=: [[conjured item]].<br/>Example: |conjured=1
;|bind=: [[Soulbound|soul binding]] type. Options are '[[BoE]]', '[[BoU]]', '[[BoP]]' or '[[BtA]]'.
;|qitem=: [[quest item]].<br/>Example: |qitem=1
;|unique=: [[unique]] items. Pass a number greater than 1 if required.<br/>Example: |unique=1
;|unique-eq=: [[unique-equipped]] items. Same rules as |unique=.<br/>Example: |unique-eq=3
;|<span style="color:#71d5ff;">glyph</span>=: [[glyph]] type: Major or Minor.
;|duration=: duration this item persists for (time-limited items).<br/>Example: |duration=2 Hours
;|qbegin=: [[:Category:Quest starting items|starts a quest]]. Provide WoWWiki's quest name, minus "Quest:".<br/>Example: |qbegin=Ancient History
;|slot=: [[equipment slot]]. ("Ranged", "Two-Hand", "Hands"...). See [[#"type" and "slot" values|full list]]
;|type=: [[equipment slot|armor/weapon type]] ("Axe", "Wand", "Cloth"...). See [[#"type" and "slot" values|full list]]
;|speed=: [[weapon speed]]. Provide two decimal figures.<br/>Example: |speed=4.56
;|dmg=: basic weapon damage. Provide a range.<br/>Example: |dmg=4 - 17
;|dmgtype=: basic weapon damage [[Magic schools (WoW)|school]]. Omit if physical.<br/>Example: |dmgtype=Nature
;|dps=: weapon dps. Provide one decimal. ([[Feral attack power|FAP]] will be displayed automatically)<br/>Example: |dps=186.4
;|bonus=: bonus weapon damage. Provide a range if present ("13 - 17").
;|bonustype=: bonus weapon damage [[Magic schools (WoW)|school]]. Omit if physical.
;|armor=: armor provided by the item.
;|<span style="color:#0f0;">bonusarmor</span>=: the bonus armor above and beyond normal for its item level
;|block=: [[block value]] on a [[shield]].
;|attrib=: basic attributes. Split with <code>&lt;br /&gt;</code> tags, not line breaks.<br/>Example: <nowiki>|attrib=+6 Stamina<br />+3 Intellect</nowiki>
;|<span style="color: #999;">req</span>=: [[profession]] specialization required to use the item.<br/>Example: |req=Gnomish Engineering
;|<span style="color: #999;">sockets</span>=: item's [[socket]]s. Split with <code>&lt;br /&gt;</code> tags, not line breaks.<br/>Example: <nowiki>|sockets={{socket|Blue}}<br />{{socket|Red}}</nowiki>
;|<span style="color: #999;">sockbonus</span>=: [[socket bonus]] for matching gem colors to socket colors.<br/>Example: |sockbonus=+9 Spell Power
| valign="top"|
;|durability=: item's [[durability]]. Provide the maximum, not the fraction.<br/>Example: |durability=75
;|<span style="color:#d22;">locked</span>=: [[lockpicking]] skill required to open or blank if item is just locked<br/>Example: |locked=300
;|bag=: if a bag, number of slots.<br/>Example: |bag=16
;|classes=: classes the item is usable by. Split with commas.<br/>Example: |classes=Rogue, Mage, Priest
;|rep=: faction name required to use this item. See also |rfaction=.<br/>Example: |rep=Honor Hold
;|rfaction=: faction reputation level required to use this item. See also |rep=.<br/>Example: |rfaction=Exalted
;|level=: character [[level]] required to use this item.<br/>Example: |level=80
;|ilvl=: [[item level]].<br/>Example: |ilvl=258
;|skill=: profession skill required to use item.<br/>Example: |skill=Leatherworking (250)
;|races=: races the item is usable by. Split with commas.<br/> Example: Races: Gnome, Dwarf
;|rating=: personal and team [[Arena PvP system#Arena rating system|arena rating]] required to buy the item.<br/>Example: |rating=2250
;|<span style="color:#0f0;">effect</span>=: all of the green "Equip"/"Use" lines. Split with <code>&lt;br /&gt;</code> tags, not line breaks.
;|create=: name of the item this item creates, or teaches the user to create.<br/>Example: |create=Heavy Frostweave Bandage
;|createq=: [[quality|item quality]] of the item in the |create= line.<br/>Example: |createq=Common
;|mats=: materials to make the |create= item. Split with <code>&lt;br /&gt;</code> tags, not line breaks.<br/>Example: <nowiki>|mats={{loot|common|Frostweave Cloth}} x2</nowiki>
;|<span style="color: #ffd100;">set</span>=: the [[armor set]] this item belongs to.
;|<span style="color: #ffd100;">setpc</span>=: number of items in the item's armor set.
;|<span style="color: #ffd100;">setpage</span>=: set's WoWWiki page name, if different from the displayed set name.
;|charges=: maximum number of times this item can be used.<br/>Example: |charges=10
;|<span style="color: #ffd517;">flavor</span>=: item's flavor text, without quotes.<br/>Example: |flavor=Blade of the Highlord
;|<span style="color:#0f0;">read</span>=: display "<Right Click to Read>".<br/>Example: |read=1
;|<span style="color:#0f0;">open</span>=: display "<Right Click to Open>".<br/>Example: |open=1
;|<span style="color: #66c;">cooldown</span>=: cooldown on the use effect of this item.
;|<span style="color: #66c;">cast</span>=: cast time of the use effect of this item.
;|<span style="color: #66c;">vendor</span>=: buy this item from a vendor. Use {{t|cost}}/{{t|costitem}}<br/>Example: <nowiki>|vendor={{cost|123|45|67}}</nowiki>
;|<span style="color: #66c;">sell</span>=: sell this item to a vendor and get gold. Use {{t|cost}}<br/>Example: <nowiki>|sell={{cost|30|86|42}}</nowiki>
|}

===Display modes===
Passing |mode= to the template (and, by extension to the item page syntax, any item page) affects how the template renders the tooltip. There are several valid mode values:
;home / away
:Displays the tooltip as if on its item page (home) or not on its item page (away). If mode is omitted, the appropriate one of those is chosen by default.
;link / imlink
:Return an item link (link) or an item link with an image (imlink) instead of the tooltip.