Template:Template rating

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 currently protected from editing.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.

The above template is a demo.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 2,200 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 is currently protected from editing.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.

Redirect

{{Module ratingTemplate:Module rating}}

This template uses Lua:

Usage

Basic usage:

{{Template rating|rating}}

Without categories:

{{Template rating|rating|nocat=true}}

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 |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 |doc-reason= the same value as you would enter in |1= in {{Protection padlock}}, and |doc-action= the same as the parameter of the name which is the protection action—must be one of edit (default; for normal protection), move (for move-protection) or autoreview (for pending changes): {{Template rating|rating|reason for documentation protection|action=the restricted action on documentation like move or edit}}

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 (52).

For templates, the rating |1= can be:

{{Template rating|pre-alpha}}
{{Template rating|alpha}}
{{Template rating|beta}}
{{Template rating|release}}
{{Template rating|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 |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 |nocat= set to true.

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.

{{Template rating|release|reason=template|action=edit}}

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.

This template is currently protected from editing.
See the protection policy and protection log for more details. Please discuss any changes on the talk page; you may submit an edit request to ask an administrator to make an edit if it is uncontroversial or supported by consensus. You may also request that this page be unprotected.

TemplateData

Used to mark the status of a template as one of pre-alpha, alpha, beta, release, or protected

Template parameters[Edit template data]
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Rating	`1`	The rating level of the template or module. Suggested values `pre-alpha` `alpha` `beta` `release` `broken` `deprecated`	String	required
Nocat	`nocat`	Suppress categories. Default false Example true	Boolean	optional
Replacement (if deprecated)	`replaced`	If module is set to deprecated, then give wikilink of module that replace it if one exists. Example [[Module:Example]]	Page name	optional
Message (if deprecated)	`message`	If module is set to deprecated, then give optional message to append.	Content	optional
Suppress protection template	`suppress-pp`	Suppress the protection template with any value. Example true	String	optional
Reason for protection (if protected)	`reason`	Reason for protection; may be one of: blp, dispute, dmca, mainpage, office, reset, sock, template, usertalk, vandalism Suggested values `vandalism` `template` `dispute` `dmca` `mainpage` `reset`	String	optional
Reason for protection of /doc subpage (if protected)	`doc-reason` `2`	Reason for protection of doc subpage; may be one of: blp, dispute, dmca, mainpage, office, reset, sock, template, usertalk, vandalism Suggested values `vandalism` `template` `dispute` `dmca` `mainpage` `reset`	String	optional
Action restricted (if protected)	`action`	Action which is restricted. Must be one of "edit" (for normal protection), "move" (for move-protection) or "autoreview" (for pending changes). Suggested values `edit` `move` `autoreview`	String	optional
Action restricted of /doc subpage (if protected)	`doc-action` `3`	Action which is restricted. Must be one of "edit" (for normal protection), "move" (for move-protection) or "autoreview" (for pending changes). Suggested values `edit` `move` `autoreview`	Unknown	optional
demospace	`demospace`	no description	Unknown	optional
demopage	`demopage`	no description	Unknown	optional
demolevel	`demolevel`	no description	Unknown	optional

Tracking categories

It autocategorizes into (unless |nocat= set to true):

Category:Templates in pre-alpha development (16)
Category:Templates in alpha (27)
Category:Templates in beta (42)
Category:Modules in pre-alpha development (47)
Category:Modules in alpha (60)
Category:Modules in beta (205)
Category:Modules for general use (402)

These categories are suppressed on pages ending with /doc and /sandbox. To suppress categories on all pages, you can use |nocat=true.

Error tracking:

The above documentation is transcluded from Template:Template rating/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.