Template:Module rating: Difference between revisions
en>Eyesnore No edit summary |
en>Eyesnore No edit summary |
||
| Line 38: | Line 38: | ||
| #default = {{error|Module rating is invalid or not specified.}} | | #default = {{error|Module rating is invalid or not specified.}} | ||
}} | }} | ||
}}|{{error|Error: {{tl|Module rating}} must be placed in the Module namespace.}} [[Category:Pages with templates in the wrong namespace]]|demospace={{{demospace|<noinclude>module</noinclude>}}}}}</includeonly><noinclude> | }}|{{error|Error: {{tl|Module rating}} must be placed in the Module namespace.}}{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages --> | ||
| {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Pages with templates in the wrong namespace|{{PAGENAME}}]] }} | |||
}}|demospace={{{demospace|<noinclude>module</noinclude>}}}}}</includeonly><noinclude> | |||
{{module rating|release|nocat=true|demospace=module}} | {{module rating|release|nocat=true|demospace=module}} | ||
{{documentation}} | {{documentation}} | ||
<!-- Categories go on the /doc subpage, and interwikis go in Wikidata. --> | <!-- Categories go on the /doc subpage, and interwikis go in Wikidata. --> | ||
</noinclude> | </noinclude> | ||
Revision as of 14:11, 24 July 2017
 | This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
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 displayed instead and will be categorized under Category:Pages with templates in the wrong 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.