Module:CalibrationCycle/doc: Difference between revisions
Calibration Report | 2026-07-13 | Self-Assessment | Added Admin Page Status block. Flagged likely SMW namespace exclusion for Module: pages (same bug class as Template: pages found earlier today) proactively. Flagged {{Documentation}} call as unconfirmed pattern needing verification. See Talk for full report. |
No edit summary |
||
| Line 91: | Line 91: | ||
'''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]]. | '''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]]. | ||
[[Category:Meta & Framework]] | |||
[[Category:Site Maintenance]] | |||
<div style="display:none;"> | <div style="display:none;"> | ||
Revision as of 14:06, 14 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]].