Editing Template:Module rating/doc

{{Documentation subpage}}
<!-- 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.

== 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''', '''protected''', and '''broken'''. 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|demopage=Module:This module is not protected}}
|-
!scope="row"| <code>alpha</code>
| <code>a</code>
| {{module rating|alpha|nocat=true|demospace=module|demopage=Module:This module is not protected}}
|-
!scope="row"| <code>beta</code>
| <code>b</code>
| {{module rating|beta|nocat=true|demospace=module|demopage=Module:This module is not protected}}
|-
!scope="row"| <code>release</code>
| <code>r</code><br/><code>general</code><br/><code>g</code><br/><code>stable</code>
| {{module rating|release|nocat=true|demospace=module|demopage=Module:This module is not protected}}
|-
!scope="row"| <code>broken</code>
| <code>br</code><br/><code>unstable</code>
| {{module rating|broken|nocat=true|demospace=module|demopage=Module:This module is not protected}}
|-
!scope="row"| ''Anything else or if missing''
|
| {{module rating|prdaskidkated|nocat=true|demospace=module|demopage=Module:This module is not protected}}
|}

== 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 ==

The template will put modules in one of the following categories, according to the rating specified:
* {{clc|Category:Modules in pre-alpha development}}
* {{clc|Category:Modules in alpha}}
* {{clc|Category:Modules in beta}}
* {{clc|Category:Modules for general use}}
* {{clc|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:Documentation templates]]
[[Category:Wikipedia Lua-related templates]]
}}</includeonly>