Template:Template rating

The above template is a demo.

   Template documentation (edit | history)

This is a template documentation subpage for Template:Template rating.
It contains usage information, categories, interlanguage links and other content that is not part of the original template page.

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

This template is used on many 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.

Template:Template redirect

File:Lua logo.svg

This template uses Lua.
Its code can be found under Module:Module:Check for unknown parameters.

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

If Template:Tlc is used outside the Template or Module namespace, an error message is displayed instead and will be categorized under Template:Clc.

For templates, the rating Template:Para can be:

For modules, the rating Template:Para can be:

All parameter values are case-insensitive.

Template will not autocategorize if Template:Para set to Template:Pval.

Examples

{{Template ratingTemplate:\sandbox|pre-alpha|suppress-pp=true|nocat=true}} {{Template ratingTemplate:\sandbox|alpha|suppress-pp=true|nocat=true}} {{Template ratingTemplate:\sandbox|beta|suppress-pp=true|nocat=true}} {{Template ratingTemplate:\sandbox|release|suppress-pp=true|nocat=true}} {{Template ratingTemplate:\sandbox|broken|suppress-pp=true|nocat=true}} {{Template ratingTemplate:\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.

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

{{Template ratingTemplate:\sandbox|release|demospace=module|demopage=Module:String|demolevel=edit|suppress-pp=true|nocat=true}}

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 Template:Para set to Template:Pval):

These categories are suppressed on pages ending with /doc and /sandbox. To suppress categories on all pages, you can use Template:Para.

Error tracking:

Template:Sandbox other