Module:CalibrationCycle/doc: Difference between revisions
No edit summary |
No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
This module calculates the status of review cycles based on a given date. It is primarily used to determine whether a page's last review is still current, approaching its deadline, or overdue. | This module calculates the status of review cycles based on a given date. It is primarily used to determine whether a page's last review is still current, approaching its deadline, or overdue. | ||
It is designed to work together with Semantic MediaWiki properties (especially <code>Has cycle status</code> and <code>Last reviewed</code>). | It is designed to work together with Semantic MediaWiki properties (especially <code>Has cycle status</code> and <code>Last reviewed</code>). | ||
'''Note on this page's own SMW data:''' This is a Module: namespace page. The same SMW namespace-exclusion issue found on [[Template:Admin Page Status/doc]] and [[Template:GameModule/doc]] (Template: namespace pages silently not storing `#set` data) likely also applies to Module: namespace pages by default. Until `$smwgNamespacesWithSemanticLinks` is confirmed to include `NS_MODULE`, the Admin Page Status data below may not appear in Special:Browse even though it is correctly stored via Cargo — this is expected, not a new bug. | |||
== Available Functions == | == Available Functions == | ||
=== cycleStatus === | === cycleStatus === | ||
Returns the current review status of a page. | Returns the current review status of a page. | ||
==== Usage ==== | ==== Usage ==== | ||
<pre><nowiki> | |||
< | |||
{{#invoke:CalibrationCycle|cycleStatus|review_date|threshold_in_days}} | {{#invoke:CalibrationCycle|cycleStatus|review_date|threshold_in_days}} | ||
</ | </nowiki></pre> | ||
==== Parameters ==== | ==== Parameters ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
! Parameter | ! Parameter | ||
| Line 39: | Line 30: | ||
| Number of days before a review is considered overdue. Defaults to <code>90</code> if not provided. | | Number of days before a review is considered overdue. Defaults to <code>90</code> if not provided. | ||
|} | |} | ||
==== Return Values ==== | ==== Return Values ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
! Value | ! Value | ||
| Line 58: | Line 47: | ||
| No valid date was provided. | | No valid date was provided. | ||
|} | |} | ||
==== Examples ==== | ==== Examples ==== | ||
<pre><nowiki> | |||
< | |||
{{#invoke:CalibrationCycle|cycleStatus|2026-07-08|90}} | {{#invoke:CalibrationCycle|cycleStatus|2026-07-08|90}} | ||
</ | </nowiki></pre> | ||
<pre><nowiki> | |||
< | |||
{{#invoke:CalibrationCycle|cycleStatus|2025-01-01}} | {{#invoke:CalibrationCycle|cycleStatus|2025-01-01}} | ||
</ | </nowiki></pre> | ||
=== daysSince === | === daysSince === | ||
Returns the number of whole days since the given date. | Returns the number of whole days since the given date. | ||
==== Usage ==== | ==== Usage ==== | ||
<pre><nowiki> | |||
< | |||
{{#invoke:CalibrationCycle|daysSince|review_date}} | {{#invoke:CalibrationCycle|daysSince|review_date}} | ||
</ | </nowiki></pre> | ||
==== Parameters ==== | ==== Parameters ==== | ||
{| class="wikitable" | {| class="wikitable" | ||
! Parameter | ! Parameter | ||
| Line 92: | Line 72: | ||
| Date in <code>YYYY-MM-DD</code> format. | | Date in <code>YYYY-MM-DD</code> format. | ||
|} | |} | ||
==== Return Values ==== | ==== Return Values ==== | ||
* Returns the number of days as a string. | * Returns the number of days as a string. | ||
* Returns an empty string if the date is invalid or missing. | * Returns an empty string if the date is invalid or missing. | ||
==== Example ==== | ==== Example ==== | ||
<pre><nowiki> | |||
< | |||
{{#invoke:CalibrationCycle|daysSince|2026-07-08}} | {{#invoke:CalibrationCycle|daysSince|2026-07-08}} | ||
</ | </nowiki></pre> | ||
== Usage in Templates == | == Usage in Templates == | ||
This module is typically called from within another template (such as <code>Template:Admin Page Status</code>) rather than directly on pages. | This module is typically called from within another template (such as <code>Template:Admin Page Status</code>) rather than directly on pages. | ||
Example from inside a template: | Example from inside a template: | ||
<pre><nowiki> | <pre><nowiki> | ||
| Has cycle status = {{#invoke:CalibrationCycle|cycleStatus|{{{review_date|}}}|{{{review_threshold|90}}}}} | | Has cycle status = {{#invoke:CalibrationCycle|cycleStatus|{{{review_date|}}}|{{{review_threshold|90}}}}} | ||
</nowiki></pre> | </nowiki></pre> | ||
== Calibration Dependencies == | |||
* [[Template:Admin Page Status/doc]] | |||
'''Note:''' This module was exercised extensively during today's SMW namespace bug investigation, and its own hardening pass (validation and error-handling fixes) was itself a Calibration Report finding — see [[Talk:Module:CalibrationCycle]]. | |||
{{RelatedPages}} | |||
{{Standalone Transparency}} | |||
{{Calibration Maintenance}} | |||
{{Calibration Dependent}} | |||
{{Calibration Dependencies Display}} | |||
[[Category:Meta & Framework]] | |||
[[Category:Site Maintenance]] | |||
<div style="display:none;"> | |||
{{Resource | |||
| Title = Module:CalibrationCycle/doc | |||
| URL = https://www.thesovereigngames.com/wiki/Module:CalibrationCycle/doc | |||
| Description = Documentation for the CalibrationCycle Lua module. Calculates review cycle status (Current, Due Soon, Overdue) based on last review date and threshold. | |||
| Category = Meta & Framework | |||
}} | |||
</div> | |||
{{Admin Page Status | |||
| categorization = Done | |||
| calibration_review = Self-Assessment | |||
| instrument_grade = Confirmed | |||
| validation = Moderate | |||
| calibration_rationale = Documentation matches the module's actual current behavior (both functions, all parameters, correct defaults). Flagged this page's own likely SMW namespace exclusion (Module: namespace, same class of issue found on Template: pages today) proactively rather than waiting to discover it separately. | |||
| review_confidence = High | |||
| review_date = 2026-07-13 | |||
| reviewed_by = Sovereign | |||
| priority = Core | |||
| review_threshold = 60 | |||
| has_backlinks = Yes | |||
| outbound_links_valid = Not checked | |||
| in_outline = No | |||
| in_category_outline = No | |||
| templates_complete = Needs review | |||
| formatting_standard = Meets standard | |||
| symmetry_check = Not applicable | |||
| self_report_flagged = No | |||
| terminology_consistent = Yes | |||
| standing_check = Self-assessed only | |||
| drift_report_status = None open | |||
| depends_on = Template:Admin Page Status/doc | |||
}} | |||
Latest revision as of 01:17, 19 July 2026
Description
This module calculates the status of review cycles based on a given date. It is primarily used to determine whether a page's last review is still current, approaching its deadline, or overdue.
It is designed to work together with Semantic MediaWiki properties (especially Has cycle status and Last reviewed).
Note on this page's own SMW data: This is a Module: namespace page. The same SMW namespace-exclusion issue found on Template:Admin Page Status/doc and Template:GameModule/doc (Template: namespace pages silently not storing `#set` data) likely also applies to Module: namespace pages by default. Until `$smwgNamespacesWithSemanticLinks` is confirmed to include `NS_MODULE`, the Admin Page Status data below may not appear in Special:Browse even though it is correctly stored via Cargo — this is expected, not a new bug.
Available Functions
cycleStatus
Returns the current review status of a page.
Usage
{{#invoke:CalibrationCycle|cycleStatus|review_date|threshold_in_days}}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
review_date
|
string | Yes | The date of the last review in YYYY-MM-DD format.
|
threshold_in_days
|
number | No | Number of days before a review is considered overdue. Defaults to 90 if not provided.
|
Return Values
| Value | Meaning |
|---|---|
Current
|
Review is still within the acceptable window. |
Due Soon
|
Review is approaching the deadline (within the last 25% of the cycle). |
Overdue
|
Review date has passed the threshold. |
Unknown
|
No valid date was provided. |
Examples
{{#invoke:CalibrationCycle|cycleStatus|2026-07-08|90}}
{{#invoke:CalibrationCycle|cycleStatus|2025-01-01}}
daysSince
Returns the number of whole days since the given date.
Usage
{{#invoke:CalibrationCycle|daysSince|review_date}}
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
review_date
|
string | Yes | Date in YYYY-MM-DD format.
|
Return Values
- Returns the number of days as a string.
- Returns an empty string if the date is invalid or missing.
Example
{{#invoke:CalibrationCycle|daysSince|2026-07-08}}
Usage in Templates
This module is typically called from within another template (such as Template:Admin Page Status) rather than directly on pages.
Example from inside a template:
| Has cycle status = {{#invoke:CalibrationCycle|cycleStatus|{{{review_date|}}}|{{{review_threshold|90}}}}}
Calibration Dependencies
Note: This module was exercised extensively during today's SMW namespace bug investigation, and its own hardening pass (validation and error-handling fixes) was itself a Calibration Report finding — see [[Talk:Module:CalibrationCycle]].
Structural Connections
Page Transparency & Calibration
- Calibration Log & Decision Records (via Talk Page) — This page uses Talk-only calibration tracking. Full history of reviews, version changes, calibration decisions, and any governance reasoning behind structural decisions all live on the same Talk page, per Calibration Log: When to Create One and Decision Records: Governance Memory. Not every Calibration Log entry is a Decision Record — scan the Talk page's headings for entries specifically marked as decisions; the link itself being active only confirms this page has calibration history, not that a formal decision was ever recorded.
- View Current Page History — Complete edit history.
This page is under continuous calibration in line with the Permanent Beta principle.
Public Discussion Welcome
Questions, suggestions, feedback, disagreement, and proposed improvements are welcome on the Talk page.
Light rules:
- Prefer evidence and concrete examples over slogans.
- Apply Diagnostic Inversion Test when criticizing — the same standard to this page that you would apply elsewhere.
- Distinguish observation from conclusion.
- Calibration entries and Decision Records are maintenance records; public discussion belongs in ordinary Talk threads.
- This framework remains in Permanent Beta. Better calibration is always in scope.
Calibration References
This page is calibrated against the following core standards and reference materials:
- The Sovereign Games Framework — Overall framework philosophy and operating principles
- Permanent Beta — Core maintenance and continuous improvement standard
- Reference Standards — Principles for traceable, confirmed standards
- Calibrating Conceptual Instruments — Methodology for evaluating and refining pages
- Civilizational Traceability Hierarchy — How standards should connect to reality across levels
- Diagnostic Inversion Test — Mandatory self-application standard
- Reality Game — Foundational reality-alignment tool
- Reality Override Game — Standing discipline against protecting an existing model rather than updating it
- Observable Behavior Rule — Standing principle that diagnostics evaluate observable actions, mechanisms, and consequences, not internal motive, belief, or intent
- One-Way Nature of the Sovereign Games — Anti-capture design principles
- The Royal Cubit Civilization (Strategy) — Long-term civilizational vision and metrology metaphor
- Conceptual Instruments — Overall direction and metrology metaphor
- Breadcrumb Philosophy — Standing discipline for making unresolved questions and provisional decisions explicit
- Calibration Dependencies: Standards and Process — Rule that visible and hidden dependency lists must match, and that dependencies describe genuine reliance
Calibration Dependent
Pages that list this page as a load-bearing dependency: None found. Either nothing currently depends on this page, or no dependent page has yet listed it in their `depends_on` field.
If this page is edited substantively, review the list above per the Ripple Review rule — see Calibration Dependencies: Standards and Process#Rule: Core-Priority Changes Trigger Mandatory Ripple Review.
Calibration Dependencies
Pages this page relies on as load-bearing dependencies: Template:Admin Page Status/doc If incorrect, edit the `depends_on` field in Admin Page Status — do not edit this section directly, it is auto-generated.