Wikia

WoWWiki

Tooltip item/doc

Talk0
101,382pages on
this wiki

Template page | < Template:Tooltip item

{{Tooltip}} -- updated for use with SMW.

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

Current test vector: Template:Tooltip item/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:


Tooltip item is used to recreate in-game item tooltips on the item's article. Tooltip item 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.

Tooltip item also defines a very large number of WoWWiki:Semantic MediaWiki semantic properties for the item that is useful in locations like like loot table compilations. The 'Tooltip item' uses 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 Tooltip item 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 syntaxEdit

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:

<onlyinclude>{{{{{tpl|tooltip}}}
|mode={{{mode|}}}
|arg={{{arg|}}}
}}</onlyinclude>

{{Item}} and {{loot}}Edit

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

<onlyinclude>{{{{{tpl|tooltip}}}
|mode={{{mode|}}}
|arg={{{arg|}}}
|name=<item_name>
|quality=<quality_value>
|bind=<bind_value>
}}</onlyinclude>

{{DE}}Edit

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

<onlyinclude>{{{{{tpl|tooltip}}}
|mode={{mode|}}}
|arg={{{arg|}}}
|name=<item_name>
|quality=<quality_value>
|slot=<slot_value>
|ilvl=<item_ilvl>
}}</onlyinclude>

Parameter listEdit

Tooltip item 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 dataEdit

These five parameters should be in every call to Tooltip item.

|name=
item name as it appears in-game.
|name=Atiesh, Greatstaff of the Guardian
|quality=
item quality, passed to {{quality}} to generate formatted item name.
|quality=Legendary
|icon=
icon to display. omit "File:" and ".png". Uses {{icon}}.
|icon=inv ingot titansteel red
|bind=
soul binding type. Options are 'BoE', 'BoU', 'BoP' or 'BtA'.
|bind=BoP
|ilvl=
item level.
|ilvl=258

WeaponsEdit

These parameters are useful for defining weapon values.

|slot=
equipment slot. ("Ranged", "Two-Hand", "Hands"...). See full list
|type=
armor/weapon type ("Axe", "Wand", "Cloth"...). See full list
|dmglow= and |dmghigh=
basic weapon damage. Use both parameters to define the range.
|dmglow=4
|dmghigh=17
|dmgtype=
basic weapon damage school. Omit if physical, which is most common.
|dmgtype=Nature
|speed=
weapon speed. Provide two decimal figures.
|speed=4.56
|dps=
weapon dps. Provide one decimal. (FAP will be displayed automatically)
|dps=186.4
|strength=, |agility=, |stamina=, |intellect=, |spirit=
the five basic attributes
|stamina=42
|durability=
item's durability. Provide the maximum, not the fraction.
|durability=75
|effect=
any random Equip: lines not covered by the below parameters
|defense=, |dodge=, |parry=, |blockrating=, |haste=, |hit=, |crit=
|resilience=, |expertise=, |mastery=, |attackpower=, |mp5=
|arpen=, |spellpower=, |spellpen=, |hp5=
any of the above equip bonuses. see examples
|mastery=40
|use=
what happens when this item gets used
|use=Restores 4450 to 4895 health

ArmorEdit

These parameters are useful for defining armor values.

|slot=
equipment slot. ("Ranged", "Two-Hand", "Hands"...). See full list
|type=
armor/weapon type ("Axe", "Wand", "Cloth"...). See full list
|armor=
armor provided by the item.
|armor=1337
|bonusarmor=
the bonus armor above and beyond normal for its item level
|bonusarmor=245
|block=
block value on a shield.
|strength=, |agility=, |stamina=, |intellect=, |spirit=
the five basic attributes
|stamina=42
|fire=, |nature=, |frost=, |arcane=, |shadow=
the five school resistances
|nature=50
|durability=
item's durability. Provide the maximum, not the fraction.
|durability=75
|effect=
any random Equip: lines not covered by the below parameters
|defense=, |dodge=, |parry=, |blockrating=, |haste=, |hit=, |crit=
|resilience=, |expertise=, |mastery=, |attackpower=, |mp5=
|arpen=, |spellpower=, |spellpen=, |hp5=
any of the above equip bonuses. see examples
|mastery=40
|use=
what happens when this item gets used
|use=Restores 4450 to 4895 health

RequirementsEdit

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

|instancebind=
the zone that the item cannot be removed from while alive.
|instancebind=Tempest Keep
|holiday=
the holiday that this item is limited to.
|holiday=Brewfest
|classes=
classes the item is usable by. Split with commas.
|classes=Rogue, Mage, Priest
|races=
races the item is usable by. Split with commas. Can also use "Alliance" or "Horde"
|races=Gnome, Dwarf
|level=
character level required to use this item.
|level=80
|profession= and |profrating=
profession skill required to use item.
|profession=Leatherworking
|profrating=250
|prof=
profession specialization required to use the item
|prof=Tribal Leatherworking
|rfaction= and |rep=
faction name and reputation level required to use this item.
|rfaction=Honor Hold
|rep=Exalted
|rating=
personal and team arena rating required to buy the item.
|rating=2250

GemsEdit

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

|meta=
the bonus provided for fulfilling the meta gem requirements
|meta=+21 Critical Strike Rating and 3% Increased Critical Damage
|req=
basic requirements, say for meta gems.
|req=at least 2 Blue gems
|gems=
item's gem sockets. Split with commas. Uses {{socket2}}.
|gems=Meta, Blue, Yellow
|sockbonus=
socket bonus for matching gem colors to socket colors.
|sockbonus=+9 Spell Power
|gem=
the sockets this gem fits into. red/yellow/blue/green/orange/purple/meta/prismatic
|gem=purple

Other useful parametersEdit

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

|conjured=
conjured item.
|conjured=1
|qitem=
quest item.
|qitem=1
|glyph=
glyph type: Prime, Major or Minor.
|glyph=Prime
|qbegin=
starts a quest. Name of WoWWiki's quest page, minus "Quest:". Uses {{quest}}
|qbegin=Ancient History
|locked=
lockpicking skill required to open or blank if item is just locked
|locked=300
|bag=
if a bag, number of slots.
|bag=16
|create= and |createq
in-game name and quality of the item this item creates, or teaches the user to create.
|create=Heavy Frostweave Bandage
|createq=Common
|mats=
materials to make the |create= item. Split with <br /> tags, not line breaks.
|mats={{loot|common|Frostweave Cloth}} x2
|charges=
limited number of charges this item has
|charges=5
|flavor=
item's flavor text, without quotes.
|flavor=Blade of the Highlord
|sellprice=
sell this item to a vendor and get gold. Use {{sell}}
|sell={{sell|1|2|3}}
|read=
display "<Right Click to Read>".
|read=1
|open=
display "<Right Click to Open>".
|open=1
|set=
the armor set this item belongs to.
|set=Awesome Party Ensemble
|setpc=
number of items in the item's armor set.
|setpc=3

Full listEdit

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.

|name=
item name as it appears in-game.
|name=Atiesh, Greatstaff of the Guardian
|disambigpage=
name of the WoWWiki page for this item, if different from |name=.
|disambigpage=Atiesh, Greatstaff of the Guardian (Mage)
|quality=
item quality, passed to {{quality}} to generate formatted item name.
|quality=Legendary
|icon=
icon to display. omit "File:" and ".png". Uses {{icon}}.
|icon=inv ingot titansteel red
|stack=
stack size for stackable items. Uses {{icon}}.
|heroic=
heroic item.
|heroic=1
|conjured=
conjured item.
|conjured=1
|instancebind=
the zone that the item is bound to.
|instancebind=Tempest Keep
|holiday=
the holiday that this item is limited to.
|holiday=Brewfest
|bind=
soul binding type. Options are 'BoE', 'BoU', 'BoP' or 'BtA'.
|bind=BoP
|qitem=
quest item.
|qitem=1
|unique=
unique items. Pass a number greater than 1 if required.
|unique=1
|unique-eq=
unique-equipped items. Same rules as |unique=.
|unique-eq=3
|unique-type=
Type of uniquely equipped item, such as Jeweler's Gems
|unique-type=Jeweler's Gems
|glyph=
glyph type: Prime, Major or Minor.
|glyph=Prime
|duration=
duration this item persists for (time-limited items).
|duration=2 Hours
|qbegin=
starts a quest. Name of WoWWiki's quest page, minus "Quest:". Uses {{quest}}
|qbegin=Ancient History
|slot=
equipment slot. ("Ranged", "Two-Hand", "Hands"...). See full list
|type=
armor/weapon type ("Axe", "Wand", "Cloth"...). See full list
|dmglow= and |dmghigh=
basic weapon damage. Use both parameters to define the range.
|dmglow=4
|dmghigh=17
|dmgtype=
basic weapon damage school. Omit if physical.
|dmgtype=Nature
|speed=
weapon speed. Provide two decimal figures.
|speed=4.56
|dps=
weapon dps. Provide one decimal. (FAP will be displayed automatically)
|dps=186.4
|bonuslow= and |bonushigh=
Rare bonus weapon damage. Use both parameters to define the range.
|bonustype=
Rare bonus weapon damage school. Omit if physical.
|armor=
armor provided by the item.
|armor=1337
|bonusarmor=
the bonus armor above and beyond normal for its item level
|bonusarmor=245
|block=
block value on a shield.
|strength=, |agility=, |stamina=, |intellect=, |spirit=
the five basic attributes
|stamina=42
|fire=, |nature=, |frost=, |arcane=, |shadow=
the five school resistances
|nature=50
|meta=
the bonus provided for fulfilling the meta gem requirements
|meta=+21 Critical Strike Rating and 3% Increased Critical Damage
|attrib=
deprecated any other basic attributes not listed above
|req=
basic requirements, say for meta gems.
|req=at least 2 Blue gems
|gems=
item's gem sockets. Split with commas. Uses {{socket2}}.
|gems=Meta, Blue, Yellow
|sockbonus=
socket bonus for matching gem colors to socket colors.
|sockbonus=+9 Spell Power
|durability=
item's durability. Provide the maximum, not the fraction.
|durability=75
|locked=
lockpicking skill required to open or blank if item is just locked
|locked=300
|bag=
if a bag, number of slots.
|bag=16
|classes=
classes the item is usable by. Split with commas.
|classes=Rogue, Mage, Priest
|races=
races the item is usable by. Split with commas. Can also use "Alliance" or "Horde"
|races=Gnome, Dwarf
|level=
character level required to use this item.
|level=80
|profession= and |profrating=
profession skill required to use item.
|profession=Leatherworking
|profrating=250
|prof=
profession specialization required to use the item
|prof=Tribal Leatherworking
|rfaction= and |rep=
faction name and reputation level required to use this item.
|rfaction=Honor Hold
|rep=Exalted
|ilvl=
item level.
|ilvl=258
|rating=
personal and team arena rating required to buy the item.
|rating=2250
|effect=
any random Equip: lines not covered by the below parameters
|defense=, |dodge=, |parry=, |blockrating=, |haste=, |hit=, |crit=
|resilience=, |expertise=, |mastery=, |attackpower=, |mp5=
|arpen=, |spellpower=, |spellpen=, |hp5=
any of the above equip bonuses. see examples
|mastery=40
|onhit=
rare Item bonus starting with "Chance on hit:", not "Equip:"
|onhit=Does the Thunderfury thing
|use=
what happens when this item gets used
|use=Restores 4450 to 4895 health
|create= and |createq
in-game name and quality of the item this item creates, or teaches the user to create.
|create=Heavy Frostweave Bandage
|createq=Common
|createpage=
WoWWiki's item page for |create= if different
|mats=
materials to make the |create= item. Split with <br /> tags, not line breaks.
|mats={{loot|common|Frostweave Cloth}} x2
|charges=
limited number of charges this item has
|charges=5
|flavor=
item's flavor text, without quotes.
|flavor=Blade of the Highlord
|gem=
the sockets this gem fits into. red/yellow/blue/green/orange/purple/meta/prismatic
|gem=purple
|sellprice=
sell this item to a vendor and get gold. Use {{sell}}
|sell={{sell|1|2|3}}
|read=
display "<Right Click to Read>".
|read=1
|open=
display "<Right Click to Open>".
|open=1
|set=
the armor set this item belongs to.
|set=Awesome Party Ensemble
|setpc=
number of items in the item's armor set.
|setpc=3
|setpage=
set's WoWWiki page name, if different from the displayed set name.
|setpage=Awesome Party Ensemble (set)
|cooldown=
cooldown on the use effect of this item.
|cooldown=30 sec
|cast=
cast time of the use effect of this item.
|cast=3 sec
|vendor=
buy this item from a vendor. Use {{cost}}/{{costitem}}
|vendor={{cost|123|45|67}}

Display modesEdit

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" valuesEdit

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 examplesEdit

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.

Around Wikia's network

Random Wiki