Template:Module rating

From mediawiki.org
Jump to navigation Jump to search
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
alpha a
beta b
release r
general
g
protected protect
p
Anything else or if missing

TemplateData

[view · talk · edit]

This is the TemplateData documentation for this template used by VisualEditor and other tools.

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

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Rating1

One of pre-alpha, alpha, beta or release for quality, or protected, or an approved (see full docs) abbreviation for one of these.

Suggested values
pre-alpha alpha beta release protected
Stringrequired
Do not categorizenocat

Set to true to disable categorization by rating. Normally leave blank.

Auto value
true
Booleanoptional
Fake namespacedemospace

Set to module to force template to display outside that namespace. Demonstration purposes only.

Example
Module
Stringoptional

Categories

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

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

See also