Template:Template rating/doc - Revision history

Khalid: Created page with "{{Documentation subpage}} {{hatnote|"Template:Module rating" redirects here. It was merged into this template.}} {{high-use}} {{template rating|general|suppress-pp=true}} {{template redirect|Module rating}} {{lua|Module:Check for unknown parameters|Module:Effective protection level}} == Usage == Basic usage:
2026-04-21T17:12:55Z

Created page with "{{Documentation subpage}} {{hatnote|"Template:Module rating" redirects here. It was merged into this template.}} {{high-use}} {{template rating|general<noinclude>|suppress-pp=true</noinclude>}} {{template redirect|Module rating}} {{lua|Module:Check for unknown parameters|Module:Effective protection level}}  == Usage == Basic usage: <syn..."

New page
{{Documentation subpage}}
{{hatnote|"[[Template:Module rating]]" redirects here. It was merged into this template.}}
{{high-use}}
{{template rating|general<noinclude>|suppress-pp=true</noinclude>}}
{{template redirect|Module rating}}
{{lua|Module:Check for unknown parameters|Module:Effective protection level}}

== Usage ==
Basic usage:

<syntaxhighlight lang=wikitext>{{Template rating|rating}}</syntaxhighlight>

Without categories:

<syntaxhighlight lang=wikitext>{{Template rating|rating|nocat=true}}</syntaxhighlight>

Template automatically detects if in module or template namespace, and displays the applicable notice.

Also detects if template or module protected from editing, the template will automatically display a message regarding that too. The reason can optionally be specified, it must be written in full using the {{para|reason}} parameter. This must be a full message and not one word like the reasons on [[Template:Protection padlock#Reasons|Template:Protection padlock § Reasons]].

If the documentation subpage is also protected, {{tl|Protection padlock}} can be manually generated on it when it is transcluded by declaring {{para|doc-reason}} the same value as you would enter in {{para|1}} in {{tlx|Protection padlock}}, and {{para|doc-action}} the same as the parameter of the name which is the protection action—must be one of {{pval|edit}} (default; for normal protection), {{pval|move}} (for move-protection) or {{pval|autoreview}} (for pending changes): <syntaxhighlight lang=wikitext inline>{{Template rating|rating|reason for documentation protection|action=the restricted action on documentation like move or edit}}</syntaxhighlight>

If {{tlc|Template rating}} is used outside the Template or Module namespace, an error message is displayed instead and will be categorized under {{clc|Category:Pages with templates in the wrong namespace}}.

For ''templates'', the rating {{para|1}} can be:
* {{tlc|Template rating|pre-alpha}}
* {{tlc|Template rating|alpha}}
* {{tlc|Template rating|beta}}
* {{tlc|Template rating|release}}
* {{dc|{{tlc|Template rating|{{dc|protected}}}} – deprecated but still accepted and displays equivalent as release; previously showed another protection message that was redundant to the message automatically shown by [[Template:Template rating/protected]].}}

For ''modules'', the rating {{para|1}} can be:
* {{tlc|Template rating|pre-alpha}}
* {{tlc|Template rating|alpha}}
* {{tlc|Template rating|beta}}
* {{tlc|Template rating|release}}
* {{tlc|Template rating|broken}}
* {{tlc|Template rating|deprecated}}

All parameter values are ''case-insensitive''.

Template will not autocategorize if {{para|nocat}} set to {{pval|true}}.

== Examples ==
{{Template rating{{\sandbox}}|pre-alpha|suppress-pp=true|nocat=true}}
{{Template rating{{\sandbox}}|alpha|suppress-pp=true|nocat=true}}
{{Template rating{{\sandbox}}|beta|suppress-pp=true|nocat=true}}
{{Template rating{{\sandbox}}|release|suppress-pp=true|nocat=true}}
{{Template rating{{\sandbox}}|broken|suppress-pp=true|nocat=true}}
{{Template rating{{\sandbox}}|deprecated|suppress-pp=true|nocat=true}}

==== Module with protection ====
The protection is automatically detected, but this is what it would look like on [[Module:String]] for example which is fully-protected.
<syntaxhighlight lang=wikitext>
{{Template rating|release|reason=template|action=edit}}
</syntaxhighlight>
{{Template rating{{\sandbox}}|release|demospace=module|demopage=Module:String|demolevel=edit|suppress-pp=true|nocat=true}}

== TemplateData==
<templatedata>
{
"description": "Used to mark the status of a template as one of pre-alpha, alpha, beta, release, or protected",
"params": {
"1": {
"label": "Rating",
"description": "The rating level of the template or module.",
"type": "string",
"required": true,
"suggestedvalues": [
"pre-alpha",
"alpha",
"beta",
"release",
"broken",
"deprecated"
]
},
"nocat": {
"label": "Nocat",
"description": "Suppress categories.",
"type": "boolean",
"default": "false",
"example": "true"
},
"demospace": {},
"replaced": {
"label": "Replacement (if deprecated)",
"description": "If module is set to deprecated, then give wikilink of module that replace it if one exists.",
"example": "[[Module:Example]]",
"type": "wiki-page-name"
},
"message": {
"label": "Message (if deprecated)",
"description": "If module is set to deprecated, then give optional message to append.",
"type": "content"
},
"demopage": {},
"suppress-pp": {
"label": "Suppress protection template",
"description": "Suppress the protection template with any value.",
"example": "true",
"type": "string"
},
"reason": {
"label": "Reason for protection (if protected)",
"description": "Reason for protection; may be one of: blp, dispute, dmca, mainpage, office, reset, sock, template, usertalk, vandalism",
"type": "string",
"suggestedvalues": [
"vandalism",
"template",
"dispute",
"dmca",
"mainpage",
"reset"
]
},
"doc-reason": {
"aliases": [
"2"
],
"label": "Reason for protection of /doc subpage (if protected)",
"description": "Reason for protection of doc subpage; may be one of: blp, dispute, dmca, mainpage, office, reset, sock, template, usertalk, vandalism",
"type": "string",
"suggestedvalues": [
"vandalism",
"template",
"dispute",
"dmca",
"mainpage",
"reset"
]
},
"action": {
"label": "Action restricted (if protected)",
"description": "Action which is restricted. Must be one of \"edit\" (for normal protection), \"move\" (for move-protection) or \"autoreview\" (for pending changes).",
"type": "string",
"suggestedvalues": [
"edit",
"move",
"autoreview"
]
},
"doc-action": {
"aliases": [
"3"
],
"label": "Action restricted of /doc subpage (if protected)",
"description": "Action which is restricted. Must be one of \"edit\" (for normal protection), \"move\" (for move-protection) or \"autoreview\" (for pending changes).",
"suggestedvalues": [
"edit",
"move",
"autoreview"
]
},
"demolevel": {}
},
"paramOrder": [
"1",
"nocat",
"replaced",
"message",
"suppress-pp",
"reason",
"doc-reason",
"action",
"doc-action",
"demospace",
"demopage",
"demolevel"
],
"format": "block"
}
</templatedata>
== Tracking categories ==
It autocategorizes into (unless {{para|nocat}} set to {{pval|true}}):
* {{clc|Templates in pre-alpha development}}
* {{clc|Templates in alpha}}
* {{clc|Templates in beta}}
* {{clc|Category:Modules in pre-alpha development}}
* {{clc|Category:Modules in alpha}}
* {{clc|Category:Modules in beta}}
* {{clc|Category:Modules for general use}}
These categories are suppressed on pages ending with /doc and /sandbox. To suppress categories on all pages, you can use {{para|nocat|true}}.

Error tracking:
* {{clc|Category:Pages using template rating template with unknown parameters}}
* {{clc|Category:Pages with templates in the wrong namespace}}
<includeonly>{{sandbox other||

[[Category:Template namespace templates|Rating]]
[[Category:Templates that add a tracking category]]
}}</includeonly>