Template:Template rating/doc: Difference between revisions
add tracking cat |
Deleatur yhe (talk | contribs) m 1 revision imported |
(No difference)
| |
Latest revision as of 16:05, 9 September 2026
 | This is a documentation subpage for Template:Template rating. It may contain usage information, categories and other content that is not part of the original template page. |
__EXPECTED_UNCONNECTED_PAGE__
 | This template is used on approximately 2,600 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
 | This template is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
 | This template uses Lua: |
Usage
Basic usage:
<syntaxhighlight lang=wikitext>
 | Page using Template:Template rating with invalid template or module rating in <syntaxhighlight lang="wikitext" inline style="display: none;" />|1= parameter. |
Lua error in Module:Effective_protection_level at line 64: attempt to index field 'TitleBlacklist' (a nil value).
--></syntaxhighlight>
Without categories:
<syntaxhighlight lang=wikitext>
| Page using Template:Template rating with invalid template or module rating in <syntaxhighlight lang="wikitext" inline style="display: none;" />|1= parameter. |
Lua error in Module:Effective_protection_level at line 64: attempt to index field 'TitleBlacklist' (a nil value).
--></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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|reason= parameter. This must be a full message and not one word like the reasons on Template:Protection padlock § Reasons.
If the documentation subpage is also protected, {{Protection padlock}} can be manually generated on it when it is transcluded by declaring <syntaxhighlight lang="wikitext" inline style="display: none;" />|doc-reason= the same value as you would enter in <syntaxhighlight lang="wikitext" inline style="display: none;" />|1= in {{Protection padlock}}, and <syntaxhighlight lang="wikitext" inline style="display: none;" />|doc-action= the same as the parameter of the name which is the protection action—must be one of
- REDIRECT Template:Parameter value
This page is a redirect. The following categories are used to track and monitor this redirect:
|
__EXPECTSHORTPAGE__ (default; for normal protection),
- REDIRECT Template:Parameter value
This page is a redirect. The following categories are used to track and monitor this redirect:
|
__EXPECTSHORTPAGE__ (for move-protection) or
- REDIRECT Template:Parameter value
This page is a redirect. The following categories are used to track and monitor this redirect:
|
__EXPECTSHORTPAGE__ (for pending changes): <syntaxhighlight lang=wikitext inline>
| Page using Template:Template rating with invalid template or module rating in <syntaxhighlight lang="wikitext" inline style="display: none;" />|1= parameter. |
Lua error in Module:Effective_protection_level at line 64: attempt to index field 'TitleBlacklist' (a nil value).
--></syntaxhighlight>
If {{Template rating}} is used outside the Template or Module namespace, an error message is displayed instead and will be categorized under Category:Pages with templates in the wrong namespace (0).
For templates, the rating <syntaxhighlight lang="wikitext" inline style="display: none;" />|1= can be:
{{Template rating|pre-alpha}}{{Template rating|alpha}}{{Template rating|beta}}{{Template rating|release}}{{Template rating|– 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.protected}}
For modules, the rating <syntaxhighlight lang="wikitext" inline style="display: none;" />|1= can be:
{{Template rating|pre-alpha}}{{Template rating|alpha}}{{Template rating|beta}}{{Template rating|release}}{{Template rating|broken}}{{Template rating|deprecated}}
All parameter values are case-insensitive.
Template will not autocategorize if <syntaxhighlight lang="wikitext" inline style="display: none;" />|nocat= set to
- REDIRECT Template:Parameter value
This page is a redirect. The following categories are used to track and monitor this redirect:
|
__EXPECTSHORTPAGE__.
Examples
 | This template is rated as pre-alpha. It is incomplete and may or may not be in active development. Do not use it in article namespace pages. A template remains in pre-alpha until its developer, or another editor who adopts it if it is abandoned for some time, considers the basic structure complete. |
 | This template is rated as alpha. It is ready for limited use and third-party feedback. It may be used on a small number of pages, but should be monitored closely. Suggestions for new features or adjustments to input and output are welcome. |
 | This template is rated as beta. It is considered ready for widespread use, but as it is still relatively new, it should be applied with some caution to ensure results are as expected. |
| This template is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
 | This template is rated as unstable. It has missing dependencies, compatibility issues, or output errors that make it unusable. Editors are encouraged to improve its compatibility or nominate it for deletion if it cannot be fixed. |
 | This template is rated as deprecated and defunct. |
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>
| This template is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
Lua error in Module:Effective_protection_level at line 64: attempt to index field 'TitleBlacklist' (a nil value).
-->
</syntaxhighlight>
| This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
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 <syntaxhighlight lang="wikitext" inline style="display: none;" />|nocat= set to
- REDIRECT Template:Parameter value
This page is a redirect. The following categories are used to track and monitor this redirect:
|
__EXPECTSHORTPAGE__):
- Category:Templates in pre-alpha development (0)
- Category:Templates in alpha (0)
- Category:Templates in beta (0)
- Category:Modules in pre-alpha development (0)
- Category:Modules in alpha (0)
- Category:Modules in beta (0)
- Category:Modules for general use (10)
These categories are suppressed on pages ending with /doc and /sandbox. To suppress categories on all pages, you can use <syntaxhighlight lang="wikitext" inline style="display: none;" />|nocat=true.
Error tracking: