Template:Module rating/sandbox

File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]

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, protected, and broken. There are also short alias codes for each of the ratings.

Rating	Aliases	Result
pre-alpha	prealpha pa
alpha	a
beta	b
release	r general g stable
broken	br unstable
Anything else or if missing

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

Categories

The template will put modules in one of the following categories, according to the rating specified:

• Category:Modules in pre-alpha development (47)
• Category:Modules in alpha (61)
• Category:Modules in beta (205)
• Category:Modules for general use (401)
• Category:Modules subject to page protection (0)

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

See also

• {{module-rating categories}}
• Wikipedia:Lua
• Wikipedia:Lua requests
• {{Lua}}
• {{Template rating}}

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