Template:Module rating/doc

From 'City of Adelaide' History and Genealogy Site
Jump to navigation Jump to search

{{#invoke:Message box|mbox}}

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:

Template:Pre

Without categories:

Template:Pre

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
Template:Error
alpha a Template:Error
beta b Template:Error
release r
general
g
Template:Error
protected protect
p
Template:Error

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