Template:Item link/doc: Difference between revisions

From Path of Exile 2 Wiki
Jump to navigation Jump to search
>OmegaK2
mNo edit summary
(Il is a template shortcut)
Line 2: Line 2:


{{lua|Module:Item link}}
{{lua|Module:Item link}}
{{template shortcut|il}}


Semantic Mediawiki based item link. Use this to link items from [[Template:Item]]
Semantic Mediawiki based item link. Use this to link items from [[Template:Item]]

Revision as of 09:24, 9 November 2017

This subpage provides documentation for Template:Item link.

Lua logo

This template uses the following modules:

Shortcut

Semantic Mediawiki 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 Name to display.
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
inventory_icon str File to use for the inline icon link

Examples

Basic Usage

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

Yields:

Module Error: No results found for item using search term "page = Two-Stone Ring (ruby and topaz)"

{{Item link
|item_name=Pierce
}}

Yields:

Module Error: No results found for item using search term "item_name = Pierce"

Large icons

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

Yields:

Module Error: No results found for item using search term "item_name = Pierce"