| This page uses Creative Commons Licensed content from Wikipedia (view authors). |
 | This is a documentation subpage for Template:Module rating 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:
Without categories:
If {{Module rating}} is used outside the Module namespace, an error message is displayed instead and will be categorized under Category:Pages with templates in the wrong namespace.
If the documentation subpage is also protected:
The second and third unnamed arguments correspond to reason and action of which gets included on the documentation subpage if at least the second unnamed argument is present.
Ratings
The rating should be placed in the first positional parameter. There are six different ratings: pre-alpha, alpha, beta, release, protected, and broken. There are also short alias codes for each of the ratings.
| Rating | Aliases | Result |
|---|---|---|
pre-alpha
|
prealphapa
|
|
alpha
|
a
|
|
beta
|
b
|
|
release
|
rgeneralgstable
|
|
broken
|
brunstable
|
|
protected
|
protectp
|
|
semiprotected
|
semiprotectsemi
|
|
| 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 (0)
- Category:Modules in alpha (0)
- Category:Modules in beta (7)
- Category:Modules for general use (8)
- Category:Modules subject to page protection (70)
These categories are suppressed on pages ending with /doc. To suppress categories on all pages, you can use the code |nocat=true.