Jump to content

Template:ItemLink/doc

From Community Wiki | Soulbound: Online
This is the documentation subpage for Template:ItemLink. It holds usage notes, parameters and examples, and is transcluded onto the template page itself. Edit the documentation here; edit the template's code on the template page.

An item's icon plus its rarity-coloured link. Use it every time an item is named in a table, an infobox, a list or a catalogue, so items look the same everywhere on the wiki.

{{ItemLink|Cursed Tritanium Sword|rarity=3}}Cursed Tritanium Sword Cursed Tritanium Sword

  • rarity is the item's base rarity — the rarity of a crafted copy — for rollable gear. A value outside 0–5, or none at all, falls back to plain text with no error.
  • The icon is found for you. It looks for <name> icon.png; if that file does not exist the link renders on its own, with no broken image. Override with image=, or suppress the icon entirely with noicon=yes in a dense table.
  • The first parameter is a page title, so it must match the article exactly — including a (Tier N) suffix. Use the second parameter for different display text.
  • Icons are pixel art scaled crisply by the wiki's CSS; do not substitute a hand-enlarged file.

Unlike {{Stat}}

and {{Rarity}}

, this template is plain wikitext with no Lua behind it. Its colours are the sb-q classes in Template:ItemStyles/styles.css.

Icon + rarity-coloured link to an item page.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Item page name1

no description

Page namerequired
Display text2

Defaults to the page name

Stringoptional
Rarity numberrarity

0–5; colours the link. For rollable gear use the base rarity.

Numbersuggested
Icon fileimage

Defaults to "<name> icon.png"

Fileoptional
Hide iconnoicon

Set to yes to render the link only

Booleanoptional