Template:Tooltip item/doc

Tooltip -- updated for use with SMW.

DO NOT PUSH THIS TEMPLATE LIVE UNTIL THE SMW DATABASES ARE UP!

Current test vector: Test

Current deltas from live:
 * holiday= has been added, finally
 * attrib= deprecated, split to |strength=, |agility=, |stamina=, |intellect=, |spirit=, |fire=, |nature=, |frost=, |arcane=, |shadow=, |meta= (for meta gem bonuses)
 * dmg= deprecated, split to |dmglow= and |dmghigh=
 * bonus= deprecated, split to |bonuslow= and |bonushigh= (rare)
 * skill= deprecated. split to |profession= and |profrating=
 * sell= deprecated. use |sellprice=sell instead of cost
 * effect= deprecated, split: most stats have been implemented. so has |use= and |onhit= (rare!)
 * sockets= deprecated. Use |gems=. Just list the colors with commas and spaces in between: "|gems=Meta, Red, Blue"
 * gem= instead of |flavor= for what kind of slots it fits in

End user documentation follows:

 is used to recreate in-game item tooltips on the item's article. is also called by item, loot and several other templates to display the information it defines elsewhere. You can supply any number of the optional parameters to display specific text in the tooltip.

also defines a very large number of semantic properties for the item that is useful in locations like like loot table compilations. Previously, only cared about what the data looked like. It now cares what that data actually means, so use the appropriate parameters to define values. At the very bottom of the page (either after previews or once the article is finally saved) is a summary of the semantic data that has defined. Check it for errors to make sure the wiki understands what was handed to it.

Tooltips for purposes other than items can be created using the templates abilitytip, effecttip, settip, achievementbox, and proftip. The development version of this template can be found at Tooltip/Dev

Required minimum syntax
The following parameters are required for every tooltip template, and the entire block should always be the first thing on an article page. However, without any further parameters, only an empty box will display:

Item and loot
For item and loot to work, the following minimum parameters are required:

DE
To automatically show a tooltip of disenchanting results when mousing over the Item Level number on the article page, the following are required:

Parameter list
has an enormous amount of possible values it can take. The more common options are listed here, organized by where they are likely to be needed (such as defining weapons, or armor, or any requirements the item has). There is also a full list of every possible parameter at the end.

Core data
These five parameters should be in every call to.

Weapons
These parameters are useful for defining weapon values.

Armor
These parameters are useful for defining armor values.

Requirements
Does an item require level 80? High-level Jewelcrafting? A good PvP rating?

Gems
Jewelcrafted gems and socketed items have a set of parameters that don't get much use elsewhere.

Other useful parameters
Other fairly common parameters that don't fit into the above categories can be found here.

Full 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.

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:
 * mode=home / mode=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.


 * mode=link / mode=imlink
 * Return an item link (link) or an item link with an image (imlink) instead of the tooltip.


 * mode=arg (in combination with |arg=)
 * Returns the value of the arg parameter defined in the tooltip of that page, or "--" if it is not defined.

"type" and "slot" values
List of values that appear in tooltips.
 * type
 * Arrow, Axe, Bag, Bow, Bullet, Cloth, Crossbow, Dagger, Enchanting Bag, Engineering Bag, Fishing Pole, Fist Weapon, Gem Bag, Gun, Herb Bag, Idol, Leather, Leatherworking Bag, Libram, Mace, Mail, Mining Bag, Plate, Polearm, Shield, Sigil, Soul Bag, Staff, Sword, Thrown, Totem, Wand.


 * slot
 * Back, Chest, Feet, Finger, Hands, Head, Held in off-hand, Legs, Main Hand, Neck, Off Hand, One-Hand, Projectile, Ranged, Relic, Shirt, Shoulder, Tabard, Thrown, Trinket, Two-Hand, Waist, Wrist.

Equip bonus examples

 * defense: Equip: Increases defense rating by X.
 * dodge: Equip: Increases your dodge rating by X.
 * parry: Equip: Increases your parry rating by X.
 * blockrating: Equip: Increases shield block rating by X.
 * haste: Equip: Improves haste rating by X.
 * hit: Equip: Improves hit rating by X.
 * crit: Equip: Improves critical strike rating by X.
 * resilience: Equip: Improves resilience rating by X.
 * expertise: Equip: Increases your expertise rating by X.
 * mastery: Equip: Increases your mastery rating by X.
 * attackpower: Equip: Increases attack power by X.
 * mp5: Equip: Restores X mana per 5 sec.
 * arpen: Equip: Increases your armor penetration 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.

ru:Шаблон:ВП