Template:Template rating/doc

"Template:Module rating" redirects here. It was merged into this template.

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

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

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}}

                -->

TemplateData

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

Template parameters

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 (26)
• Category:Templates in beta (43)
• Category:Modules in pre-alpha development (47)
• Category:Modules in alpha (61)
• Category:Modules in beta (205)
• Category:Modules for general use (401)

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

Error tracking:

• Category:Pages using template rating template with unknown parameters (202)
• Category:Pages with templates in the wrong namespace (50)