Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Template:Module rating/doc: Difference between revisions

Template page
Created page with "{{Documentation subpage}} <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> 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: {{pre|{{tlx|module rating|''rating''}}}} Without categories: {{pre|{{tlx|module rating|''rating''|3..."
 
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{wikipedia|page name}}
{{Documentation subpage}}
{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->


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.
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 ==
== Usage ==
Line 8: Line 9:
Basic usage:
Basic usage:


{{pre|{{tlx|module rating|''rating''}}}}
 


Without categories:
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 {{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]].
Line 18: Line 19:
If the documentation subpage is also protected:
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.
The second and third unnamed arguments correspond to reason and action of which gets included on the documentation subpage if at least the second unnamed argument is present.


== Ratings ==
== Ratings ==
Line 62: Line 63:
| {{module rating|prdaskidkated|nocat=true|demospace=module}}
| {{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.",
"format": "inline",
"params": {
"1": {
"label": "Rating",
"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": [
"pre-alpha",
"alpha",
"beta",
"release",
"protected",
"semiprotected"
],
"required": true,
"type": "string"
},
"nocat": {
"label": "Do not categorize",
"description": "Set to true to disable categorization by rating. Normally leave blank.",
"autovalue": "true",
"type": "boolean"
},
"demospace": {
"label": "Fake namespace",
"description": "Set to module to force template to display outside that namespace. Demonstration purposes only.",
"example": "module",
"type": "string"
}
}
}
</templatedata>}}


== Categories ==
== Categories ==
Line 110: Line 75:
These categories are suppressed on pages ending with /doc. To suppress categories on all pages, you can use the code {{para|nocat|true}}.
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||
<includeonly>{{sandbox other||

Latest revision as of 08:09, 9 April 2025

This page uses Creative Commons Licensed content from Wikipedia (view authors).

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:


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:


The second and third unnamed arguments correspond to reason and action of 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 prealpha
pa
alpha a
beta b
release r
general
g
stable
broken br
unstable
protected protect
p
semiprotected semiprotect
semi
Anything else or if missing

Categories

The template will put modules in one of the following categories, according to the rating specified:

These categories are suppressed on pages ending with /doc. To suppress categories on all pages, you can use the code |nocat=true.