FANDOM


(Updated with new information - new topic, Cooldown format)
Line 110: Line 110:
 
== Cooldown format ==
 
== Cooldown format ==
 
There should be a standard format for the Cooldown= entry, perhaps a template like cost. I've seen Cooldown= nn min and Cooldown= nn minutes. I think both work because they are transposed as text, there is no interpretation, but standardizing would be better. [[User:Madkaugh|Madkaugh]] ([[User talk:Madkaugh|talk]]) 21:20, 8 September 2008 (UTC)
 
There should be a standard format for the Cooldown= entry, perhaps a template like cost. I've seen Cooldown= nn min and Cooldown= nn minutes. I think both work because they are transposed as text, there is no interpretation, but standardizing would be better. [[User:Madkaugh|Madkaugh]] ([[User talk:Madkaugh|talk]]) 21:20, 8 September 2008 (UTC)
  +
  +
== Non PNG File Extensions ==
  +
Seems in past discussions this was brought up, but still appears to be unresolved. For example, if you take an icon from wowhead, you'll have to convert it from JPG to PNG, yet the file uploader will take many non-PNG formats. It seems like such a popular template should be congruent with the upload feature. [[User:Howbizr|Howbizr]] ([[User talk:Howbizr|talk]]) 02:51, 21 September 2008 (UTC)

Revision as of 02:51, September 21, 2008

For testing, see Template:Tooltip/Dev.

Documentation

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.

Required Minimal Syntax

Begin all item-page tooltips with the following three lines:

{{{{{tpl|tooltip}}}
|mode={{{mode|}}}
|arg={{{arg|}}}

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

|icon=
icon to display; omit Image: and file extension (.png); passed to {{icon}}.
|stack=
stack size for stackable items; passed to {{icon}}.
|name=
item name, as it appears in game.
|disambigpage=
name of WoWWiki page for this item, if different from item name (used mainly for disambiguated items).
|quality=
item quality, passed to {{quality}} to generate formatted item name.
|bind=
binding type: BoE, BoU or BoP.
|qitem=
used to denote quest items; "Quest Item" is displayed as long as the parameter is non-blank (use 1, "true", or "Yes").
|unique=
unique items, pass the maximum number of items the character may have (1 for "Unique" items, 2 for "Unique (2)" items and so on).
|unique-eq=
unique-equipped items, see |unique= for syntax.
|qbegin=
used to denote items that start a quest; provide the name of the quest page this should link to, minus "Quest:".
|type=
item type ("Axe", "Sword", "Wand"...)
|slot=
item slot ("Ranged", "Two-Hand", "Hands"...)
|speed=
weapon speed, provide two decimal figures.
|dmg=
basic weapon damage, provide a range ("13 - 17").
|dmgtype=
basic weapon damage type ("Nature", "Fire"...), omit if physical.
|dps=
weapon dps. Provide once decimal.
|bonus=
bonus weapon damage, provide a range if present ("13 - 17").
|bonustype=
bonus weapon damage type (school).
|armor=
armor bonus on the item.
|bonusarmor=
(number) amount of "extra" armor or (blank) armor is higher than default (appears in green in WoW).
|instancebind=
name of the location the item is specific to ("Tempest Keep").
|block=
shields' block value.
|attrib=
item's attributes. List all stat bonuses, delimit individual bonuses with <br /> (+6 Stamina<br />+3 Intellect).
|req=
skill specialization ("Dragonscale Leatherworking") or non-profession (?) required to use the item.
|locked=
(number) lockpicking skill required to open item or (blank) if item is locked (the former is preferred).
|sockets=
item's sockets. Use {{socket}} and delimit with <br /> ({{socket|Blue}}<br />{{socket|Red}})
|sockbonus=
socket bonus.
|durability=
item's maximum durability (numeric).
|bag=
if a bag, number of slots (numeric).
|races=
races the item is usable by, comma-delimited.
|classes=
classes the item is usable by, comma-delimited.
|rfaction=
faction name required to use this item (used together with |rep=).
|rep=
faction reputation required to use this item (used together with |rfaction=).
|skill=
skill required to use item ("Leatherworking (250)")
|rating=
personal and team arena rating required to buy the item.
|level=
numeric value of the level required to use this item.
|duration=
duration this item persists for (time-limited items).
|effect=
all of the green equip, use bonuses on the tooltip. Separate by <br />
|create=
name of the item this item creates, or teaches the user to create.
|createq=
quality of the item this item creates, or teaches the user to create.
|mats=
materials required to create the item this item creates, or teaches the user to create.
|set=
item's set name.
|setpc=
number of items in the item's set.
|setpage=
set's WoWWiki page name, if different from set name.
|charges=
maximum number of times this item can be used, numeric.
|flavor =
item's flavor text, without quotes (which are added by the template). |desc= and |comment= are deprecated aliases of this parameter, of |flavor is present, it'll be displayed instead of either of those two.
|read=
used to denote readable items; "<Right Click to Read>" is displayed as long as the parameter is non-blank (use 1, "true", or "Yes").
|open=
used to denote openable items; "<Right Click to Open>" is displayed as long as the parameter is non-blank (use 1, "true", or "Yes").
|cooldown=
cooldown on the use effect of this item.
|cast=
cast time of the use effect of this item.
|vendor=
price for which this item may be bought (use {{cost}}).
|sell=
price for which this item is purchased by NPCs (use {{cost}}).
|ilvl=
item level.
|conjured=
pass "Yes" if the item is conjured, omit otherwise.
|source=
deprecated: Vendor, Quest, etc.
|float= automatic
left/right, tooltip float location, defaults to right on item's own page, left elsewhere.
|width= automatic
tooltip width, defaults to 18em.

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.
arg (in combination with |arg=)
Returns the value of {{{{{{arg|name}}}|--}}}, evaluated in the tooltip's context.

"type" and "slot" values

List of values that appear in tooltips.

type
Arrow, Axe, Bow, Bullet, Cloth, Crossbow, Dagger, Fishing Pole, Fist Weapon, Gun, Idol, Leather, Libram, Mace, Mail, Plate, Polearm, Shield, 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.

List of Archived Talk discussions

Arena rating

  • Brutal Gladiator's Demonstration
  • Requires level 70
  • Requires personal and team arena rating of 2000
  • Increases your awesomeness by 42.

What's the option for: "Requires personal and team arena rating of XXXX"?

Abuse |req= for now, I think. -- foxlit (talk) 20:53, 11 June 2008 (UTC)
Made it |rating=. Just give it a number value and it'll print the rest. User:Gourra/Sig2 22:01, 12 July 2008 (UTC)

Double-quotes in name messing with float/font

I saw this problem with Inv misc bag 27 ["Gigantique" Bag]. Apparently using &quot; instead of "-mark works. --Gengar orange 22x22 Fandyllic (talk · contr) 9:48 AM PST 23 Jun 2008

Cooldown format

There should be a standard format for the Cooldown= entry, perhaps a template like cost. I've seen Cooldown= nn min and Cooldown= nn minutes. I think both work because they are transposed as text, there is no interpretation, but standardizing would be better. Madkaugh (talk) 21:20, 8 September 2008 (UTC)

Non PNG File Extensions

Seems in past discussions this was brought up, but still appears to be unresolved. For example, if you take an icon from wowhead, you'll have to convert it from JPG to PNG, yet the file uploader will take many non-PNG formats. It seems like such a popular template should be congruent with the upload feature. Howbizr (talk) 02:51, 21 September 2008 (UTC)

Community content is available under CC-BY-SA unless otherwise noted.