Template:Module rating/en

Template documentation

This template is used to rate Lua modules by quality. It is placed at the top of the module's /doc subpage. It produces a message informing users about the rating system, and it also places the module into a tracking category.

Usage

Basic usage:

{{module rating|rating}}

Without categories:

{{module rating|rating|nocat=true}}

If {{Module rating}} is used outside the Module namespace, an error message is shown: Error: {{Module rating}} must be placed in the Module namespace.

Ratings

The rating should be placed in the first positional parameter. There are five different ratings: pre-alpha, alpha, beta, release and protected. There are also short alias codes for each of the ratings.

Rating Aliases Result

pre-alpha

prealpha
pa

This module is rated as pre-alpha. It is unfinished, and may or may not be in active development. It should not be used other than for testing. Modules remain pre-alpha until the original editor (or someone who takes one over if it is abandoned for some time) is satisfied with the basic structure.

alpha a Error: {{Module rating}} must be placed in the Module namespace.

beta b Error: {{Module rating}} must be placed in the Module namespace.

release r
general
g Error: {{Module rating}} must be placed in the Module namespace.

protected protect
p Error: {{Module rating}} must be placed in the Module namespace.

Anything else or if missing Error: {{Module rating}} must be placed in the Module namespace.

TemplateData

This template is used to rate Lua modules by quality. It is placed at the top of the module's /doc subpage. It produces a message informing users about the rating system, and it also places the module into a tracking category.

Usage

Basic usage:

{{module rating|rating}}

Without categories:

{{module rating|rating|nocat=true}}

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

If the documentation subpage is also protected:

{{module rating|rating|reason for documentation protection|action for documentation protection}}

The second and third unnamed arguments correspond to reason and action of {{Pp}} which gets included on the documentation subpage if at least the second unnamed argument is present.

Ratings

The rating should be placed in the first positional parameter. There are six different ratings: pre-alpha, alpha, beta, release, and protected, and semiprotected. There are also short alias codes for each of the ratings.

Rating Aliases Result

pre-alpha

prealpha
pa

This module is rated as pre-alpha. It is unfinished, and may or may not be in active development. It should not be used other than for testing. Modules remain pre-alpha until the original editor (or someone who takes one over if it is abandoned for some time) is satisfied with the basic structure.

alpha a Error: {{Module rating}} must be placed in the Module namespace.

beta b Error: {{Module rating}} must be placed in the Module namespace.

release r
general
g Error: {{Module rating}} must be placed in the Module namespace.

protected protect
p Error: {{Module rating}} must be placed in the Module namespace.

semiprotected semiprotect
semi Error: {{Module rating}} must be placed in the Module namespace.

Anything else or if missing Error: {{Module rating}} must be placed in the Module namespace.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Module rating in articles based on its TemplateData.

TemplateData for Module rating

This template is used to rate Lua modules by quality. It is placed at the top of the module's /doc subpage. It produces a message informing users about the rating system, and it also places the module into a tracking category.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Rating	`1`	One of 'pre-alpha', 'alpha', 'beta', 'release', 'protected' or 'semiprotected', or an approved (see full docs) abbreviation for one of these. As quality ratings, 'protected' and 'semiprotected' can be considered equivalent to 'release', with editing restrictions. Suggested values `pre-alpha` `alpha` `beta` `release` `protected` `semiprotected`	String	required
Do not categorize	`nocat`	Set to true to disable categorization by rating. Normally leave blank. Auto value `true`	Boolean	optional
Fake namespace	`demospace`	Set to module to force template to display outside that namespace. Demonstration purposes only. Example module	String	optional

Template:Module rating/en

Contents

Usage

Ratings

TemplateData

Usage

Ratings

TemplateData

Categories

See also

Categories

See also