Template:Module rating/doc
This is a documentation subpage for Template:Module rating. 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.
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.
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 |
| ||
alpha |
a |
| ||
beta |
b |
| ||
release |
r general g |
| ||
protected |
protect p |
| ||
semiprotected |
semiprotect semi |
| ||
Anything else or if missing |
|
Template data
See the monthly error report for this template.
TemplateData for Module rating
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.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Rating | 1 | One of pre-alpha, alpha, beta or release for quality, or one of protected or semiprotected, or an approved (see full docs) abbreviation for one of these.
| String | required |
Do not categorize | nocat | Set to true to disable categorization by rating. Normally leave blank.
| Boolean | optional |
Fake namespace | demospace | Set to module to force template to display outside that namespace. Demonstration purposes only.
| String | optional |
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