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 239:		Line 239:
	}		}
	</templatedata>		</templatedata>
			<noinclude>[[Category:Template documentation]]</noinclude>

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

2026-10-01T21:13:05Z

Add documented Sarim infobox library; optional verified fields

New page

This template displays Shop access, currency and purchase/sale rules; stock belongs in a separate verified table.

== 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 Shop
|name =
|image =
|image_alt =
|variant =
|context =
|shop_type =
|owner =
|location =
|access =
|currency =
|requirements =
|buys_items =
|pricing =
|stock =
|restock =
|stock_scope =
|availability =
|shop_id =
|npc_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>shop_type</code> || Verified shop classification.
|-
| <code>owner</code> || Verified shopkeeper or access NPC.
|-
| <code>location</code> || Verified shop access locations.
|-
| <code>access</code> || NPC action, interface or command used to open the shop.
|-
| <code>currency</code> || Accepted purchase currencies, including mixed-currency restrictions.
|-
| <code>requirements</code> || Verified access and purchase requirements.
|-
| <code>buys_items</code> || Whether the shop buys items and restrictions on eligible items.
|-
| <code>pricing</code> || Verified pricing rule summary; distinguish buying and selling.
|-
| <code>stock</code> || Stock pool summary or link to the verified stock table.
|-
| <code>restock</code> || Verified restock timing and stock limits.
|-
| <code>stock_scope</code> || Verified shared, personal or other stock ownership behavior.
|-
| <code>availability</code> || World, mode, account or event restrictions.
|-
| <code>shop_id</code> || Verified shop identifier; label the relevant shop system.
|-
| <code>npc_id</code> || Verified NPC identifier associated with shop access.
|-
|}

== 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": "Shop access, currency and purchase/sale rules; stock belongs in a separate verified table.",
"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"
]
},
"shop_type": {
"label": "Shop type",
"description": "Verified shop classification.",
"type": "string"
},
"owner": {
"label": "Owner",
"description": "Verified shopkeeper or access NPC.",
"type": "string"
},
"location": {
"label": "Location",
"description": "Verified shop access locations.",
"type": "string"
},
"access": {
"label": "Access",
"description": "NPC action, interface or command used to open the shop.",
"type": "string"
},
"currency": {
"label": "Currency",
"description": "Accepted purchase currencies, including mixed-currency restrictions.",
"type": "string"
},
"requirements": {
"label": "Requirements",
"description": "Verified access and purchase requirements.",
"type": "string"
},
"buys_items": {
"label": "Buys items",
"description": "Whether the shop buys items and restrictions on eligible items.",
"type": "string"
},
"pricing": {
"label": "Pricing",
"description": "Verified pricing rule summary; distinguish buying and selling.",
"type": "string"
},
"stock": {
"label": "Stock",
"description": "Stock pool summary or link to the verified stock table.",
"type": "string"
},
"restock": {
"label": "Restock",
"description": "Verified restock timing and stock limits.",
"type": "string"
},
"stock_scope": {
"label": "Stock scope",
"description": "Verified shared, personal or other stock ownership behavior.",
"type": "string"
},
"availability": {
"label": "Availability",
"description": "World, mode, account or event restrictions.",
"type": "string"
},
"shop_id": {
"label": "Shop ID",
"description": "Verified shop identifier; label the relevant shop system.",
"type": "string"
},
"npc_id": {
"label": "Shopkeeper NPC ID",
"description": "Verified NPC identifier associated with shop access.",
"type": "string"
}
},
"paramOrder": [
"name",
"image",
"image_alt",
"caption",
"variant",
"context",
"notes",
"alignment",
"shop_type",
"owner",
"location",
"access",
"currency",
"requirements",
"buys_items",
"pricing",
"stock",
"restock",
"stock_scope",
"availability",
"shop_id",
"npc_id"
],
"format": "block"
}
</templatedata>

Template:Infobox Shop/doc - Revision history

Maintenance script: Organize infobox templates and documentation for editors

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