Maintenance script: Organize infobox templates and documentation for editors

2026-10-02T04:52:05Z

Organize infobox templates and documentation for editors

← Older revision		Revision as of 04:52, 2 October 2026
Line 365:		Line 365:
	}		}
	</templatedata>		</templatedata>
			<noinclude>[[Category:Template documentation]]</noinclude>

Maintenance script: Add documented Sarim infobox library; optional verified fields

2026-10-01T21:12:59Z

Add documented Sarim infobox library; optional verified fields

New page

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 <code>variant</code> and <code>context</code> explicitly.

<pre>
{{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 =
}}
</pre>

== Parameters ==

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

== Editing notes ==

Images must already exist on this wiki. Set <code>image</code> 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.

<templatedata>
{
"description": "Item identity, properties, equipment and acquisition summary; use Infobox Bonuses for equipment values.",
"params": {
"name": {
"label": "Name",
"description": "Display name. Defaults to the current page title when omitted.",
"type": "string",
"suggested": true
},
"image": {
"label": "Image",
"description": "Existing local File name, without brackets; do not use an external image URL.",
"type": "wiki-file-name"
},
"image_alt": {
"label": "Image alternative text",
"description": "Plain description of the illustration for screen readers.",
"type": "string"
},
"caption": {
"label": "Image caption",
"description": "Optional caption explaining the illustration.",
"type": "string"
},
"variant": {
"label": "Variant",
"description": "Phase, charge state, difficulty or other variant represented by this box.",
"type": "string"
},
"context": {
"label": "Context",
"description": "Scope such as solo, world mode or season; supply only verified conditions.",
"type": "string"
},
"notes": {
"label": "Notes",
"description": "Short qualifying note; longer mechanics belong in the article body.",
"type": "string"
},
"alignment": {
"label": "Alignment",
"description": "right (default), left or none; none keeps the box in normal document flow.",
"type": "string",
"suggestedvalues": [
"right",
"left",
"none"
]
},
"item_type": {
"label": "Item type",
"description": "Verified item category.",
"type": "string"
},
"examine": {
"label": "Examine",
"description": "Verified Sarim examine text.",
"type": "string"
},
"tradeable": {
"label": "Tradeable",
"description": "Tradeability and any account, state or mode restrictions.",
"type": "string"
},
"stackable": {
"label": "Stackable",
"description": "Stackability for the relevant form.",
"type": "string"
},
"notable": {
"label": "Notable",
"description": "Availability of a noted form; do not infer from another variant.",
"type": "string"
},
"placeholder": {
"label": "Placeholder",
"description": "Availability of a bank placeholder form.",
"type": "string"
},
"options": {
"label": "Options",
"description": "Available inventory or ground interactions and conditions.",
"type": "string"
},
"inventory_weight": {
"label": "Inventory weight",
"description": "Verified weight in inventory, with unit supplied by the author.",
"type": "string"
},
"equipped_weight": {
"label": "Equipped weight",
"description": "Verified weight when equipped, with unit supplied by the author.",
"type": "string"
},
"value": {
"label": "Base value",
"description": "Definition value; distinguish it from shop or market prices.",
"type": "string"
},
"high_alchemy": {
"label": "High alchemy",
"description": "Verified high alchemy return, including relevant restrictions.",
"type": "string"
},
"low_alchemy": {
"label": "Low alchemy",
"description": "Verified low alchemy return, including relevant restrictions.",
"type": "string"
},
"protect_value": {
"label": "Protection value",
"description": "Verified value used for item protection ordering.",
"type": "string"
},
"death_behavior": {
"label": "On death",
"description": "Death, wilderness, reclaim and degradation conditions.",
"type": "string"
},
"slot": {
"label": "Equipment slot",
"description": "Verified equipment slot.",
"type": "string"
},
"two_handed": {
"label": "Two-handed",
"description": "Whether equipping occupies both weapon and shield slots.",
"type": "string"
},
"requirements": {
"label": "Requirements",
"description": "Verified equip and use requirements with distinctions where needed.",
"type": "string"
},
"attack_styles": {
"label": "Attack styles",
"description": "Implemented equipment styles and any restrictions.",
"type": "string"
},
"attack_ticks": {
"label": "Attack interval",
"description": "Verified ticks between attacks, including context-dependent changes. Unit: ticks; do not add that unit to a numeric value.",
"type": "string"
},
"attack_range": {
"label": "Attack range",
"description": "Verified attack reach and applicable styles or modes.",
"type": "string"
},
"special_attack": {
"label": "Special attack",
"description": "Short verified special effect and energy cost summary.",
"type": "string"
},
"charges": {
"label": "Charges",
"description": "Charge capacity, consumption and recharge behavior summary.",
"type": "string"
},
"effects": {
"label": "Effects",
"description": "Short verified passive or active effect summary.",
"type": "string"
},
"sources": {
"label": "Sources",
"description": "Reviewed acquisition routes or links to full tables.",
"type": "string"
},
"availability": {
"label": "Availability",
"description": "World, mode, season or other restrictions.",
"type": "string"
},
"item_id": {
"label": "Item ID",
"description": "Verified numeric item ID for the described form.",
"type": "string"
},
"noted_id": {
"label": "Noted ID",
"description": "Verified numeric ID of the noted counterpart.",
"type": "string"
},
"placeholder_id": {
"label": "Placeholder ID",
"description": "Verified numeric ID of the placeholder counterpart.",
"type": "string"
}
},
"paramOrder": [
"name",
"image",
"image_alt",
"caption",
"variant",
"context",
"notes",
"alignment",
"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"
],
"format": "block"
}
</templatedata>

Template:Infobox Item/doc - Revision history

Maintenance script: Organize infobox templates and documentation for editors

Maintenance script: Add documented Sarim infobox library; optional verified fields