Template:Module rating

From Wikitia
Jump to navigation Jump to search
Template documentation[view] [edit] [history] [purge]

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:

{{module rating|rating}}

Without categories:

{{module rating|rating|nocat=true}}

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.

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.

Rating Aliases Result
pre-alpha prealpha
pa
alpha a
beta b
release r
general
g
protected protect
p
semiprotected semiprotect
semi
Anything else or if missing

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Module rating

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



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.

See also