Template:Module rating/doc

From Zoophilia Wiki
Revision as of 04:46, 3 September 2020 by Ookami (talk | contribs) (21 revisions imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

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 for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Module rating

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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Rating1

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
Stringrequired
Do not categorizenocat

Set to true to disable categorization by rating. Normally leave blank.

Default
Not set.
Booleanoptional
Fake namespacedemospace

Set to module to force template to display outside that namespace. Demonstration purposes only.

Default
Not set.
Example
module
Stringoptional



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