Template:Module rating: Difference between revisions
imported>Primefac m (Protected "Template:Module rating": semi-protecting highly-visible templates in response to recent template-space vandalism ([Edit=Require autoconfirmed or confirmed access] (indefinite) [Move=Require autoconfirmed or confirmed access]...) |
imported>HughLilly m (c/e) |
||
| Line 16: | Line 16: | ||
| {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in pre-alpha development|{{PAGENAME}}]] }} |
| {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in pre-alpha development|{{PAGENAME}}]] }} |
||
}} |
}} |
||
| alpha | a = This module is rated as [[:Category:Modules in alpha|alpha]]. It is ready for third |
| alpha | a = This module is rated as [[:Category:Modules in alpha|alpha]]. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome.<!-- |
||
-->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages --> |
-->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages --> |
||
| {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in alpha|{{PAGENAME}}]] }} |
| {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in alpha|{{PAGENAME}}]] }} |
||
Revision as of 02:02, 23 February 2018
 | 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. |
Template documentationThis 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:
Template:Pre 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
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 |
|
TemplateData
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.
