Difference between revisions of "Template:Module rating/doc"
test>GKFX (→Ratings: Add semi) |
test>GKFX (Add TemplateData) |
||
| Line 15: | Line 15: | ||
If {{tlx|Module rating}} is used outside the Module namespace, an error message is shown: {{module rating}} | If {{tlx|Module rating}} is used outside the Module namespace, an error message is shown: {{module rating}} | ||
| + | |||
| + | {{TemplateDataHeader}} | ||
| + | <templatedata> | ||
| + | { | ||
| + | "params": { | ||
| + | "1": { | ||
| + | "label": "Rating", | ||
| + | "description": "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.", | ||
| + | "example": "release", | ||
| + | "type": "string", | ||
| + | "required": true | ||
| + | }, | ||
| + | "nocat": { | ||
| + | "label": "Do not categorize", | ||
| + | "description": "Set to true to disable categorization by rating. Normally leave blank.", | ||
| + | "type": "boolean", | ||
| + | "default": "Not set." | ||
| + | }, | ||
| + | "demospace": { | ||
| + | "label": "Fake namespace", | ||
| + | "description": "Set to module to force template to display outside that namespace. Demonstration purposes only.", | ||
| + | "example": "module", | ||
| + | "type": "string", | ||
| + | "default": "Not set." | ||
| + | } | ||
| + | }, | ||
| + | "description": "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.", | ||
| + | "format": "inline" | ||
| + | } | ||
| + | </templatedata> | ||
| + | |||
== Ratings == | == Ratings == | ||
Revision as of 10:39, 9 June 2017
| 40px | This is a documentation subpage for Template:Module rating. It contains 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.
Contents
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: Error: {{Module rating}} must be placed in the Module namespace.
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 |
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 |
| ||
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
- 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