Template:Aoitem

From Albion Online Wiki
Jump to: navigation, search
Documentation

This template displays an item's icon and name formatted as a link to the relevant page. It has various options for icon size, displaying text next to or underneath the icon, and customizing text displayed and/or the page it links to.

All icons are pulled directly from the Albion game engine via its API; if you notice any icons missing or incorrect, please let us know on the Trello tracking page (requires a Trello account to comment) or in the #wiki-discussion channel of the Albion Discord server. For any other questions or comments, contact User:Tilden.

See Also

The resource name template (usage: {{resource name|RESOURCE_TYPE|TIER|ENCHANTMENT_LEVEL}}) is very useful when referring to resource items (both raw and refined), as it helps with referencing resources of various tiers by their exact names. It can be used for the name parameter in this template.


Usage

Basic Usage

{{aoitem|name=ITEM_NAME}}

or simply:

{{aoitem|ITEM_NAME}}


This will display the icon for ITEM_NAME at standard size with ITEM_NAME next to it, and link to the ITEM_NAME page.

Important:

  • All names are case sensitive. Always put names in Title Caps (every word capitalized).
  • If using the shortened version (omitting name=) with any optional parameters, make sure to put ITEM_NAME first.


Examples:
{{aoitem|name=Siphoned Energy}}
  Siphoned Energy

{{aoitem|Trout}}
  Trout



Optional Parameters - Overview

General Options
size= small / inline
medium / standard
large / standalone
extra large / full
text below= yes or no
Item Options
enchantment= 1/2/3 (see Item Options below)
quality= 1/2/3/4/5 (see Item Options below)
tier= 2/3/4/5/6/7/8 (see Item Options below)
Customization Options
text= CUSTOM_TEXT or none
page link= PAGE_NAME



General Options

| size = ICON_SIZE
| text below = "yes"/"no"

These options let you pick the size of the icon, and whether the text is shown next to or below the icon. By default, icons are set to "medium" size and text is inline with the icon.

Examples:

Size
{{aoitem|name=Adept's Holy Staff | size=small}}
{{aoitem|name=Adept's Holy Staff | size=medium}}
{{aoitem|name=Adept's Holy Staff | size=large}}
{{aoitem|name=Adept's Holy Staff | size=extra large}}
  Adept's Holy Staff
  Adept's Holy Staff
  Adept's Holy Staff
  Adept's Holy Staff
Text Below
{{aoitem|name=Adept's Holy Staff | text below=no}}   Adept's Holy Staff
{{aoitem|name=Adept's Holy Staff | text below=yes}}
Adept's Holy Staff



Item Options

| enchantment = ENCHANT_LEVEL
| quality = QUALITY_LEVEL
| tier = TIER_NUMBER

These options mainly apply to equipment items. Adding the enchantment and quality options will display the appropriate enchantment and/or quality for the specified item, while the tier option lets you easily use the generalized name for an item for both the text and page link. See the examples below.

Note: When using tier, make sure not to accidentally duplicate tier prefixes (eg. "Adept's Adept's ITEM_NAME").

Enchantment Level
1 Uncommon (x.1)
2 Rare (x.2)
3 Exceptional (x.3)
Quality Level
1 Normal
2 Good
3 Outstanding
4 Excellent
5 Masterpiece
Tier Prefix
2 Novice's
3 Journeyman's
4 Adept's
5 Expert's
6 Master's
7 Grandmaster's
8 Elder's

Examples:

Enchantment
{{aoitem|name=Adept's Holy Staff | enchantment=1}}   Adept's Holy Staff
Quality
{{aoitem|name=Adept's Holy Staff | quality=2}}   Adept's Holy Staff
Tier
{{aoitem|name=Holy Staff | tier=6}}   Holy Staff
Combined
{{aoitem|name=Holy Staff | enchantment = 3 | quality=5 | tier=8}}   Holy Staff



Customization Options

| text = CUSTOM_TEXT
| page link = PAGE_TITLE

These options let you customize the text that accompanies the icon and the page the whole thing links to. If text is set to none (case sensitive), then no text will be displayed at all. Note that, because the icon is also a link, you can still use text=none (icon only) with custom page links if desired.

Examples:

No Text
{{aoitem|name=Adept's Holy Staff | text=none}}
Custom Text
{{aoitem|name=Adept's Holy Staff | text=One-Handed Holy}}   One-Handed Holy
Custom Page Link
{{aoitem|name=Adept's Holy Staff | page link=Mage}}   Adept's Holy Staff
Combined
{{aoitem|name=Adept's Holy Staff | text=Priest weapons | page link=Holy Staffs}}   Priest weapons