Template:Game icon/doc

This is the documentation subpage of Template:Game icon. It contains usage information that is not part of the underlying template page.

{{game icon|name|text|size=|alt=|hq=|qty=|wrap=}}

Links to something in the game and displays its icon alongside the link. This template supports basically anything - items, actions, traits, quests, and anything else that uses Property:Has game icon.

Note that this template queries the given page for its attributes. It is designed for ease of use in text, but it should be avoided in semantically generated lists. If you are creating a table generated by a semantic query, the query should retrieve all the necessary icon data (see "Prerequisites" below), and pass each element's values directly to the formatting templates or modules (such as Module:Icon. That will avoid generating additional queries for every element in the list (a.k.a. "N + 1" queries).

Prerequisites

In order for {{game icon}} to work with a given page, the page needs a Has game icon value and either:

• a Has context value (example: Doman Iron Daggers)

OR

• a Has game icon frame type value (example: Mount Speed)

Has game icon and Has context should be set by the relevant infobox. For pages without an infobox, such as Mount Speed, {{Lead icon}} should be used to specify the relevant icon and icon frame type for the page.

Parameters

Base parameters

name (unnamed parameter 1)

Item name. Defaults to "Item".

text (unnamed parameter 2)

alt

Optional. Link text; defaults to canonical name. Set to x to prevent link text from appearing. Unnamed parameter 2 has precedence over alt named parameter.

size

Optional. Can be small (default), mid, or big.

wrap

Set to anything to force text to wrap. Generally only used in infoboxes. Will not wrap text by default.

Item parameters

hq

Optional. Displays a  high quality item.

Item/currency parameters

qty

Optional. Quantity of currency or items, displayed between icon and text. Mostly used by {{Vendor table row}} to display vendor/exchange costs. Accepts a number or a hyphenated range.

Template Data

Links to something in the game and displays its icon alongside the link.

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Item	1	Page name of the target item	Page name	required
Link text	2	Text displayed in the link. Defaults to the linked item's canonical name. Use "x" to hide the link text and display only the icon.	Line	optional
Size	size	Display size of the icon. Suggested values small mid big Default small	String	optional
HQ	hq	For items only. Shows the high quality version of the item in the icon. Auto value 0	Boolean	optional
Quantity	qty	For items and currencies only. Quantity of currency or items represented. Accepts a number or a hyphenated range.	String	optional
Wrap	wrap	Force link text to wrap. Generally only used in other templates like infoboxes.	Boolean	optional