User:Foxlit/itemtip/doc

Itemtip is used to recreate in-game tooltips for items on that item's page here on the wiki. Itemtip is also used by other templates (such as itembox) to display that item's tooltip elsewhere, such as on boss drop lists. Additionally, using itemtip on a page will cause links to that page to be automatically formatted in a manner similar to using item, which is no longer necessary.

Tooltips for other purposes can be created using the templates abilitytip, effecttip, settip, achievementbox, and proftip.

Required minimum syntax
The following parameters are required for every itemtip call, and the entire block should always be the first thing on an article page:

Parameter list
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.

"type" and "slot" values
Items have two basic characteristics that they are categorized under: equipment slot and item type.

The equipment slot of an item indicates where it is equipped on a character:
 * Armor slots
 * Head, Shoulders, Back, Chest, Wrists, Hand, Waist, Legs, Feet


 * Accessory slots
 * Neck, Finger, Trinket


 * Decorative slots
 * Shirt, Tabard


 * Weapon slots
 * Main Hand, Two-Hand, Off Hand, Held in off-hand, Ranged, Relic, Thrown

The type of an item indicates what it is good for. Not all items have types, as the item's slot may be enough to define it, such as for accessories, decorative items and relics:
 * Armor types
 * Cloth, Leather, Mail, Plate


 * Weapon types
 * Axe, Bow, Crossbow, Dagger, Fishing Pole, Fist Weapon, Gun, Mace, Polearm, Shield, Staff, Sword, Thrown, Wand

Additionally, specialty bags are sorted on their type:
 * Bag types
 * Bag, Enchanting Bag, Engineering Bag, Gem Bag, Herb Bag, Inscription Bag, Leatherworking Bag, Mining Bag, Tackle Box

Equip bonus examples
The examples here are listed in the order they appear in the tooltip:
 * attackpower: Equip: Increases attack power by X.
 * dodge: Equip: Increases your dodge rating by X.
 * parry: Equip: Increases your parry rating by X.
 * haste: Equip: Increases your haste rating by X.
 * hit: Equip: Increases your hit rating by X.
 * crit: Equip: Increases your critical strike rating by X.
 * resilience: Equip: Increases your resilience rating by X.
 * expertise: Equip: Increases your expertise rating by X.
 * mastery: Equip: Increases your mastery rating by X.
 * spellpower: Equip: Increases spell power by X.
 * spellpen: Equip: Increases spell penetration rating by X.
 * hp5: Equip: Restores X health per 5 sec.
 * xp: Equip: Experience gained is increased by X%.

Differences from tooltip syntax
A few things have changed that editors should be aware of coming from tooltip:
 * We are not transcluding item pages to get data off of them, so don't use tags around the template!
 * disambigpage= is now |data-source=
 * instancebind= is now |location=
 * qitem= is gone. Use |bind=quest
 * dmg= is split to |dmglow= and |dmghigh= (same for bonus damage)
 * attrib= is gone. Use the individual attribute/resist parameters
 * skill= is gone. Use |prof= and |profskill=
 * req= is for meta gems. Use |profspec= for a required profession specialization
 * sockets= is split into |red-sockets=, |blue-sockets=, etc.
 * gem= added. use "|gem=purple" instead of "|flavor=Fits into red or blue sockets"
 * effect= is gone. use the equip bonus parameters, or "|use=", "|pickup=", "|equip=" for the odd-ball cases
 * sell= is gone. use |sellprice= instead