Module:CalibrationCycle/doc: Difference between revisions
No edit summary |
No edit summary |
||
| Line 17: | Line 17: | ||
==== Usage ==== | ==== Usage ==== | ||
< | <pre><nowiki> | ||
{{#invoke:CalibrationCycle|cycleStatus|review_date|threshold_in_days}} | {{#invoke:CalibrationCycle|cycleStatus|review_date|threshold_in_days}} | ||
</ | </nowiki></pre> | ||
==== Parameters ==== | ==== Parameters ==== | ||
| Line 61: | Line 61: | ||
==== 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 === | ||
| Line 75: | Line 75: | ||
==== Usage ==== | ==== Usage ==== | ||
< | <pre><nowiki> | ||
{{#invoke:CalibrationCycle|daysSince|review_date}} | {{#invoke:CalibrationCycle|daysSince|review_date}} | ||
</ | </nowiki></pre> | ||
==== Parameters ==== | ==== Parameters ==== | ||
| Line 100: | Line 100: | ||
==== Example ==== | ==== Example ==== | ||
< | <pre><nowiki> | ||
{{#invoke:CalibrationCycle|daysSince|2026-07-08}} | {{#invoke:CalibrationCycle|daysSince|2026-07-08}} | ||
</ | </nowiki></pre> | ||
== Usage in Templates == | == Usage in Templates == | ||
Revision as of 06:27, 9 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).
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}}}}}