|
|
| Line 1: |
Line 1: |
| = Template:GameModule/doc =
| |
|
| |
|
| This page is the canonical reference for the <nowiki>{{GameModule}}</nowiki> template — it defines what each field means, how the `contents` parameter works differently from every other field, and how to use it correctly. It is intended for anyone creating or restructuring a page.
| |
|
| |
| == Description ==
| |
| This template renders the page header (title, meta table) and a right-side navigation box on every page that uses it. Unlike Admin Page Status, GameModule's output is fully visible by design — it is the primary way a reader orients themselves on any Sovereign Games page.
| |
|
| |
| == A Special Note on `contents` ==
| |
|
| |
| Unlike every other field in this template, `contents` is '''not a stored/saved field''' in the same sense as the others. It exists purely to let each page customize the right-side navigation box with page-specific content (a table of contents, section links, related-page shortcuts). Because this content can be arbitrarily long and highly variable page to page, it is not tracked as structured, queryable metadata the way `Version` or `Maturity` are — it is a functional/display parameter only, not a calibration-relevant data point. Do not expect to query or compare `contents` values across pages the way you would `instrument_grade` or `priority` in Admin Page Status.
| |
|
| |
| == Usage ==
| |
|
| |
| <pre><nowiki>
| |
| {{GameModule
| |
| <!-- Do Not Remove commented out Reference Options -->
| |
| <!-- options: Meta & Framework, Core Diagnostic Game, Builder & Sovereignty Games, Sovereign Strategies, Calibration Log, Reference Standard, etc. -->
| |
| | type =
| |
|
| |
| <!-- Main category this page belongs to, wiki-linked -->
| |
| | category =
| |
|
| |
| <!-- options: Governance, Diagnostic, Builder, Calibration, Reference, Maintenance, Strategy, Navigation -->
| |
| | Functional Layer =
| |
|
| |
| <!-- options: Personal, Institutional, Civilizational, Framework Infrastructure, Multi-Layer -->
| |
| | Application Layer =
| |
|
| |
| <!-- Semantic version number, e.g. 0.1 -->
| |
| | Version =
| |
|
| |
| <!-- options: Experimental, Development, Confirmed, Field Validated, Reference Standard Candidate — same scale as instrument_grade in Admin Page Status -->
| |
| | Maturity =
| |
|
| |
| <!-- Format: YYYY-MM-DD, or {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY}} for auto-dating -->
| |
| | Last Updated =
| |
|
| |
| <!-- One-sentence summary of what this page is/does -->
| |
| | description =
| |
|
| |
| <!-- NOT a saved/queryable field — see "A Special Note on contents" above. Freeform wikitext for the right-side navigation box, customized per page. -->
| |
| | contents =
| |
| }}
| |
| </nowiki></pre>
| |
|
| |
| == Quick-Reference Parameter Table ==
| |
|
| |
| {| class="wikitable"
| |
| ! Field !! Type !! Options / Examples
| |
| |-
| |
| | type || select || Meta & Framework, Core Diagnostic Game, Builder & Sovereignty Games, Sovereign Strategies, Calibration Log, Reference Standard, etc.
| |
| |-
| |
| | category || wikilink || <nowiki>[[:Category:Meta & Framework|Meta & Framework]]</nowiki>, <nowiki>[[:Category:Core Diagnostic|Core Diagnostic]]</nowiki>, <nowiki>[[:Category:Builder & Sovereignty|Builder & Sovereignty]]</nowiki>, <nowiki>[[:Category:Site Maintenance|Site Maintenance]]</nowiki>
| |
| |-
| |
| | Functional Layer || select || Governance, Diagnostic, Builder, Calibration, Reference, Maintenance, Strategy, Navigation
| |
| |-
| |
| | Application Layer || select || Personal, Institutional, Civilizational, Framework Infrastructure, Multi-Layer
| |
| |-
| |
| | Version || text || 0.1, 0.3, 1.0
| |
| |-
| |
| | Maturity || select || Experimental, Development, Confirmed, Field Validated, Reference Standard Candidate
| |
| |-
| |
| | Last Updated || date || YYYY-MM-DD
| |
| |-
| |
| | description || text || One sentence, public-facing summary
| |
| |-
| |
| | contents || freeform, not stored || Freeform wikitext, e.g. <code><nowiki>== Main Sections == * [[Subpage 1]] * [[Subpage 2]]</nowiki></code>
| |
| |}
| |
|
| |
| == Field-by-Field Guide ==
| |
|
| |
| ==== type ====
| |
| '''What it measures:''' What kind of page this is, structurally — a diagnostic game, a calibration procedure, a governance page, etc. This drives reader expectations about what they're about to read.
| |
|
| |
| '''Current working list:''' Meta & Framework, Core Diagnostic Game, Builder & Sovereignty Games, Sovereign Strategies, Calibration Log, Reference Standard. This list may expand as new page types are established — add new values here when they're introduced, rather than letting them go undocumented.
| |
|
| |
| ----
| |
|
| |
| ==== category ====
| |
| '''What it measures:''' The primary wiki category this page belongs to. Should match an actual existing category page, wikilinked in the standard `[[:Category:Name|Name]]` format.
| |
|
| |
| ----
| |
|
| |
| ==== Functional Layer ====
| |
| '''What it measures:''' What primary job this page performs within the overall system — Governance, Diagnostic, Builder, Calibration, Reference, Maintenance, Strategy, or Navigation.
| |
|
| |
| '''Why this exists as separate from `Application Layer`:''' Functional Layer answers "what does this page *do*?" — Application Layer answers "*where* is it used?" For example, this page is Functional Layer: Governance, Application Layer: Framework Infrastructure — it governs how pages are built (function), and it applies to the framework's own infrastructure rather than to an individual or institution (scale/context). Splitting these two questions makes cross-cutting queries possible — e.g. "show all Governance pages," "show all Calibration pages," or "show pages that are both Governance and Framework Infrastructure."
| |
|
| |
| '''Note:''' This field was previously called `Calibration Type` on pages built before this doc existed. Those pages should be updated to `Functional Layer` during their next calibration pass, not left as a permanent second name for the same concept.
| |
|
| |
| ----
| |
|
| |
| ==== Application Layer ====
| |
| '''What it measures:''' Where this page's guidance primarily applies — Personal, Institutional, Civilizational, Framework Infrastructure, or Multi-Layer.
| |
|
| |
| ----
| |
|
| |
| ==== Version ====
| |
| '''What it measures:''' The page's content version, per [[Versioning]]. '''This is distinct from Admin Page Status's calibration tracking''' — Version reflects content changes; it is not the same number as calibration cycle count. See [[Template:Admin Page Status/doc]]'s note on Calibration Cycle vs. Version for the full distinction.
| |
|
| |
| ----
| |
|
| |
| ==== Maturity ====
| |
| '''What it measures:''' Public-facing maturity signal, using '''the same five-value scale as `instrument_grade`''' in Admin Page Status (Experimental, Development, Confirmed, Field Validated, Reference Standard Candidate). Do not use a different or expanded list — an earlier six-value draft (Experimental, Developing, Active Development, Foundational, Confirmed, Mature) was confirmed as draft drift, not an intentional divergence, and should not be reintroduced.
| |
|
| |
| '''Why this and `instrument_grade` are allowed to differ in value, despite sharing a scale:''' `Maturity` here is a public-facing summary intended for general readers; `instrument_grade` in Admin Page Status is the more rigorously-maintained internal calibration record. They should usually track closely but are not required to be updated in perfect lockstep — see [[Template:Admin Page Status/doc]]'s "Relationship to GameModule's Maturity Field" section for the full reasoning.
| |
|
| |
| ----
| |
|
| |
| ==== Last Updated ====
| |
| '''What it measures:''' Date of the most recent substantive content change. Can be set manually or via `{{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY}}` for auto-dating on save (note: auto-dating means this updates on '''every''' save, including trivial ones — use a manual date if you want this to reflect only substantive changes).
| |
|
| |
| ----
| |
|
| |
| ==== description ====
| |
| '''What it measures:''' A single, public-facing sentence summarizing the page's purpose. This also typically feeds the hidden Resource block's own description — check for consistency between the two rather than writing them independently.
| |
|
| |
| ----
| |
|
| |
| ==== contents ====
| |
| '''What it measures:''' Nothing calibration-relevant — see "A Special Note on `contents`" above. This is a display parameter, not a data field. Do not attempt to add it to Admin Page Status queries or dashboards; it will not behave like the other fields.
| |
|
| |
| == Common Mistakes ==
| |
|
| |
| * '''Treating `contents` as a stored, queryable field.''' It isn't. It's page-specific display markup only.
| |
| * '''Confusing `Maturity` (public-facing) with `instrument_grade` (internal calibration).''' Related, not identical — see the Maturity field guide above.
| |
| * '''Using `Calibration Type` on new pages.''' This field was renamed to `Functional Layer` — use the new name going forward, and update old pages during their next review.
| |
| * '''Using the six-value Maturity list from an early draft.''' The correct list is the five values shared with `instrument_grade` — see above.
| |
| * '''Leaving `contents` empty when the page would benefit from page-specific navigation.''' Not required, but a missed opportunity for orienting the reader.
| |
|
| |
| == Calibration Dependencies ==
| |
| * [[Template:Admin Page Status/doc]]
| |
| * [[Versioning]]
| |
|
| |
| '''Note:''' Not calibration-dependent on any diagnostic or reference-standard content — this page defines display/structural mechanics, not a claim about reality.
| |
|
| |
| == See Also ==
| |
| * [[Template:GameModule]]
| |
| * [[Template:Admin Page Status/doc]]
| |
| * [[Versioning]]
| |
|
| |
| ----
| |
|
| |
| '''See the Game. Refuse the Game. Build Better.'''
| |
|
| |
| This page is in '''Permanent Beta'''.
| |
|
| |
| [[Category:Meta & Framework]]
| |
| [[Category:Site Maintenance]]
| |
|
| |
| <div style="display:none;">
| |
| {{Resource
| |
| | Title = Template:GameModule/doc
| |
| | URL = https://www.thesovereigngames.com/wiki/Template:GameModule/doc
| |
| | Description = Canonical reference and field guide for the GameModule template — field definitions, controlled vocabularies, and the special non-stored nature of the contents parameter.
| |
| | Category = Meta & Framework
| |
| }}
| |
| </div>
| |
|
| |
|
| {{Admin Page Status | | {{Admin Page Status |