Anonymous user
Template:Module rating/doc: Difference between revisions
→Usage
Richardpruen (talk | contribs) m (1 revision imported) |
imported>Alexis Jazz (→Usage) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- | <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> | ||
{{ | |||
<templatedata> | This template is used to rate [[WP:LUA|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: | |||
{{pre|{{tlx|module rating|''rating''}}}} | |||
Without categories: | |||
{{pre|{{tlx|module rating|''rating''|3=nocat=true}}}} | |||
If {{tlx|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: | |||
{{pre|{{tlx|module rating|''rating''|3=reason for documentation protection|4=action for documentation protection}}}} | |||
The second and third unnamed arguments correspond to reason and action of {{tl|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''', and '''protected''', and '''semiprotected'''. There are also short alias codes for each of the ratings. | |||
{| class="wikitable" | |||
!scope="col"| Rating | |||
!scope="col"| Aliases | |||
!scope="col"| Result | |||
|- | |||
!scope="row"| <code>pre-alpha</code> | |||
| <code>prealpha</code><br/><code>pa</code> | |||
| {{module rating|pre-alpha|nocat=true|demospace=Module}} | |||
|- | |||
!scope="row"| <code>alpha</code> | |||
| <code>a</code> | |||
| {{module rating|alpha|nocat=true|demospace=module}} | |||
|- | |||
!scope="row"| <code>beta</code> | |||
| <code>b</code> | |||
| {{module rating|beta|nocat=true|demospace=module}} | |||
|- | |||
!scope="row"| <code>release</code> | |||
| <code>r</code><br/><code>general</code><br/><code>g</code> | |||
| {{module rating|release|nocat=true|demospace=module}} | |||
|- | |||
!scope="row"| <code>protected</code> | |||
| <code>protect</code><br/><code>p</code> | |||
| {{module rating|protected|nocat=true|demospace=module}} | |||
|- | |||
!scope="row"| <code>semiprotected</code> | |||
| <code>semiprotect</code><br/><code>semi</code> | |||
| {{module rating|semi|nocat=true|demospace=module}} | |||
|- | |||
!scope="row"| ''Anything else or if missing'' | |||
| | |||
| {{module rating|prdaskidkated|nocat=true|demospace=module}} | |||
|} | |||
== TemplateData == | |||
{{Format TemplateData|<templatedata> | |||
{ | { | ||
"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.", | "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.", | ||
| Line 9: | Line 67: | ||
"1": { | "1": { | ||
"label": "Rating", | "label": "Rating", | ||
"description": "One of pre-alpha, alpha, beta | "description": "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.", | ||
"suggestedvalues": [ | "suggestedvalues": [ | ||
"pre-alpha", | "pre-alpha", | ||
| Line 15: | Line 73: | ||
"beta", | "beta", | ||
"release", | "release", | ||
"protected" | "protected", | ||
"semiprotected" | |||
], | ], | ||
"required": true, | "required": true, | ||
| Line 29: | Line 88: | ||
"label": "Fake namespace", | "label": "Fake namespace", | ||
"description": "Set to module to force template to display outside that namespace. Demonstration purposes only.", | "description": "Set to module to force template to display outside that namespace. Demonstration purposes only.", | ||
"example": " | "example": "module", | ||
"type": "string" | "type": "string" | ||
} | } | ||
} | } | ||
} | } | ||
</templatedata> | </templatedata>}} | ||
<includeonly>{{ | |||
<!-- Categories | == Categories == | ||
[[Category: | |||
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 {{para|nocat|true}}. | |||
== See also == | |||
* {{tl|module-rating categories}} | |||
* [[Wikipedia:Lua]] | |||
* [[Wikipedia:Lua requests]] | |||
* {{tl|Lua}} | |||
* {{tl|Template rating}} | |||
<includeonly>{{sandbox other|| | |||
<!-- Categories go here, and interwikis go in Wikidata --> | |||
[[Category:Template documentation]] | |||
}}</includeonly> | }}</includeonly> | ||