Module:Document status/doc
More actions
This is the documentation page for Module:Document status
This Lua module implements Template:Document status. Editors should use the template; it supplies the parent-frame arguments expected by the module and loads its styles. See template parameters and editorial guidance.
Entry point and behavior
main(frame) reads frame:getParent().args: status (or positional 1), canon, note, replacement and nocat. A direct invocation with only the invocation's own arguments does not supply these parent arguments.
Supported states are Canon, Fanon, Approved, Unapproved, Draft, Archived, Deprecated and Unassessed. Keys are trimmed and case-insensitive. An empty status becomes Unassessed; an invalid status also becomes Unassessed and displays a parameter warning.
An independent canon=Canon or canon=Fanon can accompany an editorial state. Conflicting or unsupported combinations produce a warning. A replacement is accepted only as a valid internal, nonnegative-namespace title; the module does not check whether that page exists.
Categories
Automatic categorization is limited to Main, Solomonari and CotRH. nocat=yes, true or 1 disables it. No status or canon decision is inferred from the page's namespace or title. Invalid parameters add the maintenance category only where categorization is enabled.
Example through the template
{{Document status|status=Draft|note=Example only.|nocat=yes}}