Jump to content

Template:Module rating/doc

Add links
Gotšwa go Wikipedia
This is a documentation subpage for Template:Module rating (see that page for the template itself).
It contains usage information, categories, interlanguage links 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.

Basic usage:

<tt>{{#parsoid

Without categories:

<tt>{{#parsoid

Ratings

[edit source]

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.

RatingAliasesResult
pre-alphaprealpha
pa
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.
alphaa
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.
betab
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.
releaser
general
g
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.
protectedprotect
p
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.

Categories

[edit source]

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 source]
Le tšwa go "https://nso.wikipedia.org/w/index.php?title=Template:Module_rating/doc&oldid=14951"