Module rating/doc

This is a documentation subpage for Template:Module rating.
It contains usage information, categories and other content that is not part of the original template page.

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

40x40px

This module is rated as pre-alpha. It is unfinished, and may or may not be in active development. It should not be used from article namespace pages. 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

26x26px

This module is rated as alpha. It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome.

beta

b

40x40px

This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.

release

r
general
g

40x40px

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

protected

protect
p

40x40px

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

Anything else or if missing

Module rating is invalid or not specified.

Module rating/doc

Contents

Usage

Ratings

Categories

See also