Template:Item link/doc

This subpage provides documentation for Template:Item link.

This template uses the following modules:

• Module:Item link

Shortcut

• {{il}}

Query based item link. Use this to link items from Template:Item

Overview

Creates a link to an item page that has the item information entered by Template:Item and includes the item info box on hover on the link.

Pages with broken item links with be added to the maintenance category Category:Pages with broken item links.

Parameters

Page selection

Page search

One of these is required. Do not specify more than one.

Parameter	Value	Description
page	str	Name of the wiki page to link against
item_name	str	Name of the item to search for. This will search for alias of the same item (i.e. legacy names) and is case insenitive This can pose a problem if there are multiple items with the same name (such as Two Stone Rings) - in that case use page instead.
item_name_exact	str	Exact name of the item to search for. Unlike item_name this is case sensitive and will only search for the current name of the item. This can pose a problem if there are multiple items with the same name (such as Two Stone Rings) - in that case use page instead.

Filters

Parameter	Value	Description
link_type	nil or skill	nil - no restriction skill - restricts the search to skill gems (i.e. for Template:Sl)

Output overrides

All of these are optional and can be used to customize the item link.

Parameter	Value	Description
name	str	This parameter can be used to specify different link text than the item name. This should be used mainly for grammatical purposes. If the link text is significantly different than the item name, consider using a normal wikilink instead of this template.
large	boolean	If set to true, instead of the small icon in front of the name, a large inventory icon will be shown below the item (suitable for tables).
image	str or int	This can be used to link against an alternate art version of an item. Depending on which type is supplied: int: choose the alternate art based on the index (i.e. 1 for the first alternate art, 2 for the second, etc) str: choose the alternate based on the string given (i.e. "race season 1" would search for File:<itemname> race season 1 inventory icon.png and use it as image)
html	str	HTML to use for the itembox. May also be used to hide the item box entirely.
inventory_icon	str	File to use for the inline icon link.
skip_query	boolean	Skip querying for the item.
link	str	Which pages to link to, by default the item page.

Errors

No pages found

When the search parameters can't find any items for the given parameter, a red error box will be shown. It can be caused by updates to the game that change the name of items, so links to the old name can no longer find the item with the new name.

The solution is to either use a different search parameter or making sure the parameter is correct.

Example:

Broken: {{Item link|item_name_exact=Pierce}}

Fixed: {{Item link|item_name_exact=Pierce Support}}

Too many results found

When the search parameters find to many items, a red error box will be shown because the script doesn't know which one is the desired result. It is generally caused by items that share the same name, but have their own page such as variants of an unique item for example.

The solution is to use the page parameter to point to the page of the desired item.

Example:

Broken: {{Item link|item_name_exact=Two-Stone Ring}}

Fixed: {{Item link|page=Two-Stone Ring (ruby and topaz)}}

Examples

Basic Usage

{{Item link
|page=Two-Stone Ring (ruby and topaz)
}}

Yields:

{{Item link
|item_name=Pierce Support
}}

Yields:

Large icons

{{Item link
|item_name=Pierce Support
|large=yes
}}

Yields: