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[edit]

Basic usage:

<span style="font-family:"Consolas", monospace;">{{[[Template:module rating|module rating]]|''rating''}}</span>

Without categories:

<span style="font-family:"Consolas", monospace;">{{[[Template:module rating|module rating]]|''rating''|nocat=true}}</span>

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[edit]

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

Categories[edit]

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[edit]