Template:Module rating/doc
| File:Edit-copy green.svg | This is a documentation subpage for Template:Terminate sentence It may contain 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:
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 |
prealphapa |
|
alpha |
a |
|
beta |
b |
|
release |
rgeneralg |
|
protected |
protectp |
|
| Anything else or if missing |
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