View source for 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]].

{{TemplateDataHeader}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Rating",
			"description": "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.",
			"example": "release",
			"type": "string",
			"required": true
		},
		"nocat": {
			"label": "Do not categorize",
			"description": "Set to true to disable categorization by rating. Normally leave blank.",
			"type": "boolean",
			"default": "Not set."
		},
		"demospace": {
			"label": "Fake namespace",
			"description": "Set to module to force template to display outside that namespace. Demonstration purposes only.",
			"example": "module",
			"type": "string",
			"default": "Not set."
		}
	},
	"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"
}
</templatedata>


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

{| class="wikitable"
! Rating !! Aliases !! Result
|-
| <code>pre-alpha</code> || <code>prealpha</code><br/><code>pa</code> || {{module rating|pre-alpha|nocat=true|demospace=Module}}
|-
| <code>alpha</code> || <code>a</code> || {{module rating|alpha|nocat=true|demospace=module}}
|-
| <code>beta</code> || <code>b</code> || {{module rating|beta|nocat=true|demospace=module}}
|-
| <code>release</code> || <code>r</code><br/><code>general</code><br/><code>g</code> || {{module rating|release|nocat=true|demospace=module}}
|-
| <code>protected</code> || <code>protect</code><br/><code>p</code> || {{module rating|protected|nocat=true|demospace=module}}
|-
| <code>semiprotected</code> || <code>semiprotect</code><br/><code>semi</code> || {{module rating|semi|nocat=true|demospace=module}}
|-
| ''Anything else or if missing'' ||  || {{module rating|prdaskidkated|nocat=true|demospace=module}}
|-
|}

== 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 {{para|nocat|true}}.

== See also ==

* {{tl|module-rating categories}}
* [[Wikipedia:Lua]]
* [[Wikipedia:Lua requests]]
* {{tl|Lua}}

<includeonly>{{sandbox other||
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:Template documentation]]

}}</includeonly>