Template:Module rating/doc
![]() | 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
[edit]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 displayed instead and will be categorized under Category:Pages with templates in the wrong namespace.
If the documentation subpage is also protected:
{{module rating|rating|reason for documentation protection|action for documentation protection}}
The second and third unnamed arguments correspond to reason and action of {{Pp}} which gets included on the documentation subpage if at least the second unnamed argument is present.
Ratings
[edit]The rating should be placed in the first positional parameter. There are six different ratings: pre-alpha, alpha, beta, release, and protected, and semiprotected. 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 |
TemplateData
[edit]TemplateData for Module rating
Parameter | Description | Type | Status | |
---|---|---|---|---|
Rating | 1 | One of 'pre-alpha', 'alpha', 'beta', 'release', 'protected' or 'semiprotected', or an approved (see full docs) abbreviation for one of these. As quality ratings, 'protected' and 'semiprotected' can be considered equivalent to 'release', with editing restrictions.
| 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
[edit]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
[edit]