Template:Infobox Item/doc

From Sarim Wiki
Revision as of 21:12, 1 October 2026 by Maintenance script (talk | contribs) (Add documented Sarim infobox library; optional verified fields)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This template displays Item identity, properties, equipment and acquisition summary; use Infobox Bonuses for equipment values.

Usage

Supply only verified fields. Empty rows and empty sections are hidden; zero and No are displayed. Do not enter zero or No as a substitute for unknown data. Leave unverified parameters empty. Use one box per variant when values differ; label variant and context explicitly.

{{Infobox Item
|name = 
|image = 
|image_alt = 
|variant = 
|context = 
|item_type = 
|examine = 
|tradeable = 
|stackable = 
|notable = 
|placeholder = 
|options = 
|inventory_weight = 
|equipped_weight = 
|value = 
|high_alchemy = 
|low_alchemy = 
|protect_value = 
|death_behavior = 
|slot = 
|two_handed = 
|requirements = 
|attack_styles = 
|attack_ticks = 
|attack_range = 
|special_attack = 
|charges = 
|effects = 
|sources = 
|availability = 
|item_id = 
|noted_id = 
|placeholder_id = 
|notes = 
}}

Parameters

Parameter Meaning
name Display name. Defaults to the current page title when omitted.
image Existing local File name, without brackets; do not use an external image URL.
image_alt Plain description of the illustration for screen readers.
caption Optional caption explaining the illustration.
variant Phase, charge state, difficulty or other variant represented by this box.
context Scope such as solo, world mode or season; supply only verified conditions.
notes Short qualifying note; longer mechanics belong in the article body.
alignment right (default), left or none; none keeps the box in normal document flow.
item_type Verified item category.
examine Verified Sarim examine text.
tradeable Tradeability and any account, state or mode restrictions.
stackable Stackability for the relevant form.
notable Availability of a noted form; do not infer from another variant.
placeholder Availability of a bank placeholder form.
options Available inventory or ground interactions and conditions.
inventory_weight Verified weight in inventory, with unit supplied by the author.
equipped_weight Verified weight when equipped, with unit supplied by the author.
value Definition value; distinguish it from shop or market prices.
high_alchemy Verified high alchemy return, including relevant restrictions.
low_alchemy Verified low alchemy return, including relevant restrictions.
protect_value Verified value used for item protection ordering.
death_behavior Death, wilderness, reclaim and degradation conditions.
slot Verified equipment slot.
two_handed Whether equipping occupies both weapon and shield slots.
requirements Verified equip and use requirements with distinctions where needed.
attack_styles Implemented equipment styles and any restrictions.
attack_ticks Verified ticks between attacks, including context-dependent changes. Unit: ticks; do not add that unit to a numeric value.
attack_range Verified attack reach and applicable styles or modes.
special_attack Short verified special effect and energy cost summary.
charges Charge capacity, consumption and recharge behavior summary.
effects Short verified passive or active effect summary.
sources Reviewed acquisition routes or links to full tables.
availability World, mode, season or other restrictions.
item_id Verified numeric item ID for the described form.
noted_id Verified numeric ID of the noted counterpart.
placeholder_id Verified numeric ID of the placeholder counterpart.

Editing notes

Images must already exist on this wiki. Set image to the File name without brackets or an external URL. Boolean fields accept explicit Yes or No. Tick, XP, weight and percentage units are stated in row labels where applicable. No values, drop probabilities, alchemy prices or eligibility conditions are calculated by this display template. Links and short formatted text may be used in values. Keep long lists, drop tables and detailed mechanics in the article body. See Help:Infoboxes for the template directory and machine-generation workflow.

Item identity, properties, equipment and acquisition summary; use Infobox Bonuses for equipment values.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

Display name. Defaults to the current page title when omitted.

Stringsuggested
Imageimage

Existing local File name, without brackets; do not use an external image URL.

Fileoptional
Image alternative textimage_alt

Plain description of the illustration for screen readers.

Stringoptional
Image captioncaption

Optional caption explaining the illustration.

Stringoptional
Variantvariant

Phase, charge state, difficulty or other variant represented by this box.

Stringoptional
Contextcontext

Scope such as solo, world mode or season; supply only verified conditions.

Stringoptional
Notesnotes

Short qualifying note; longer mechanics belong in the article body.

Stringoptional
Alignmentalignment

right (default), left or none; none keeps the box in normal document flow.

Suggested values
right left none
Stringoptional
Item typeitem_type

Verified item category.

Stringoptional
Examineexamine

Verified Sarim examine text.

Stringoptional
Tradeabletradeable

Tradeability and any account, state or mode restrictions.

Stringoptional
Stackablestackable

Stackability for the relevant form.

Stringoptional
Notablenotable

Availability of a noted form; do not infer from another variant.

Stringoptional
Placeholderplaceholder

Availability of a bank placeholder form.

Stringoptional
Optionsoptions

Available inventory or ground interactions and conditions.

Stringoptional
Inventory weightinventory_weight

Verified weight in inventory, with unit supplied by the author.

Stringoptional
Equipped weightequipped_weight

Verified weight when equipped, with unit supplied by the author.

Stringoptional
Base valuevalue

Definition value; distinguish it from shop or market prices.

Stringoptional
High alchemyhigh_alchemy

Verified high alchemy return, including relevant restrictions.

Stringoptional
Low alchemylow_alchemy

Verified low alchemy return, including relevant restrictions.

Stringoptional
Protection valueprotect_value

Verified value used for item protection ordering.

Stringoptional
On deathdeath_behavior

Death, wilderness, reclaim and degradation conditions.

Stringoptional
Equipment slotslot

Verified equipment slot.

Stringoptional
Two-handedtwo_handed

Whether equipping occupies both weapon and shield slots.

Stringoptional
Requirementsrequirements

Verified equip and use requirements with distinctions where needed.

Stringoptional
Attack stylesattack_styles

Implemented equipment styles and any restrictions.

Stringoptional
Attack intervalattack_ticks

Verified ticks between attacks, including context-dependent changes. Unit: ticks; do not add that unit to a numeric value.

Stringoptional
Attack rangeattack_range

Verified attack reach and applicable styles or modes.

Stringoptional
Special attackspecial_attack

Short verified special effect and energy cost summary.

Stringoptional
Chargescharges

Charge capacity, consumption and recharge behavior summary.

Stringoptional
Effectseffects

Short verified passive or active effect summary.

Stringoptional
Sourcessources

Reviewed acquisition routes or links to full tables.

Stringoptional
Availabilityavailability

World, mode, season or other restrictions.

Stringoptional
Item IDitem_id

Verified numeric item ID for the described form.

Stringoptional
Noted IDnoted_id

Verified numeric ID of the noted counterpart.

Stringoptional
Placeholder IDplaceholder_id

Verified numeric ID of the placeholder counterpart.

Stringoptional