Help:Infoboxes: Difference between revisions

From Sarim Wiki
Jump to navigation Jump to search
Add documented Sarim infobox library; optional verified fields
 
Organize infobox templates and documentation for editors
 
Line 1: Line 1:
This library provides consistent summary boxes for Sarim articles. Fields appear only when supplied;
This library provides consistent summary boxes for Sarim articles. Fields appear only when supplied;
missing data is never replaced by assumed game defaults. See each template for its complete parameter list.
missing data is never replaced by assumed game defaults. See each template for its complete parameter list.
See [[Help:Editing]] for general editing guidance.


{| class="wikitable"
{| class="wikitable"
Line 56: Line 57:
<code>scripts/build-infoboxes call TYPE INPUT.json</code> creates a template invocation from reviewed fields and rejects unknown keys.
<code>scripts/build-infoboxes call TYPE INPUT.json</code> creates a template invocation from reviewed fields and rejects unknown keys.
Generation does not verify claims or publish an article. Research and review must happen before an infobox is populated.
Generation does not verify claims or publish an article. Research and review must happen before an infobox is populated.
[[Category:Editing help]]

Latest revision as of 04:52, 2 October 2026

This library provides consistent summary boxes for Sarim articles. Fields appear only when supplied; missing data is never replaced by assumed game defaults. See each template for its complete parameter list. See Help:Editing for general editing guidance.

Page type Template Purpose
NPC Template:Infobox NPC Identity, combat and access summary for a Sarim NPC or a specific NPC variant.
Item Template:Infobox Item Item identity, properties, equipment and acquisition summary; use Infobox Bonuses for equipment values.
Bonuses Template:Infobox Bonuses Equipment bonuses using the exact sixteen-field Sarim item_info bonusOrder; all values remain optional.
Skill Template:Infobox Skill Skill overview and implemented training/progression conditions.
Activity Template:Infobox Activity Minigame, encounter or repeatable activity access and reward overview.
Shop Template:Infobox Shop Shop access, currency and purchase/sale rules; stock belongs in a separate verified table.
Feature Template:Infobox Feature Custom system or game feature access, behavior and progression summary.
Location Template:Infobox Location Area, dungeon or destination access and local facilities summary.
Task Template:Infobox Task Achievement, daily task or other progression objective with explicit family and completion rules.
Object Template:Infobox Object Interactable game object identity and implemented action summary.

Authoring rules

  • Populate only values supported by the reviewed game source or verified live evidence.
  • Leave unavailable fields empty. Use explicit 0 and No only when those values are verified.
  • Keep different phases, charge states, difficulties and world modes in separately labeled boxes.
  • Use the item infobox for identity and properties, and the bonuses infobox for equipment stat modifiers.
  • Keep full drop tables, recipes, stock lists and detailed mechanics in article sections.
  • Give images useful alternative text. A caption appears only when an image is supplied.
  • For several boxes on one page, alignment=none avoids floats. Boxes become full-width on narrow screens.

Example syntax

This is syntax only; it contains no game data.

{{Infobox NPC
|name = 
|variant = 
|location = 
|hitpoints = 
|attack_ticks = 
}}

Programmatic generation

The management repository's infoboxes/catalog.json defines types, groups, labels and field keys. scripts/build-infoboxes call TYPE INPUT.json creates a template invocation from reviewed fields and rejects unknown keys. Generation does not verify claims or publish an article. Research and review must happen before an infobox is populated.