Template:Module rating/en
<languages />
Template documentationThis 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
If {{Module rating}} is used outside the Module namespace, an error message is shown: Template:Error
Ratings
The rating should be placed in the first positional parameter. There are five different ratings: pre-alphaTemplate:IntalphaTemplate:IntbetaTemplate:IntreleaseTemplate:IntTemplate:Intprotected. There are also short alias codes for each of the ratings.
Template:(! class="wikitable"
! Rating
! Aliases
! Result
|-
| pre-alpha
| prealphapa
 | 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
 | 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
 | 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
| rgeneralg
 | This module is rated as ready for general use. It has reached a mature form and is thought to be relatively 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
| protectp
 | 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 |
| | Template:Error |
|- Template:!)
TemplateData
Categories
The template will put modules in one of the following categories, according to the rating specified:
- Category:Modules in pre-alpha development
- Category:Modules in alpha
- Category:Modules in beta
- Category:Modules for general use
- Category:Modules subject to page protection
These categories are suppressed on pages ending with /doc.
To suppress categories on all pages, you can use the code |nocat=true.
See also
- {{module-rating categories}}
- Lua
- {{Lua}}