Template:Module rating/doc

Safer nicotine wiki Tobacco Harm Reduction
Jump to navigation Jump 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.

If the documentation subpage is also protected: 

{{module rating|rating|reason for documentation protection|action for documentation protection}}

The second and third unnamed arguments correspond to reason and action of {{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, and protected, and semiprotected. There are also short alias codes for each of the ratings.

Rating Aliases Result
pre-alpha prealpha
pa
alpha a Error: {{Module rating}} must be placed in the Module namespace.
beta b Error: {{Module rating}} must be placed in the Module namespace.
release r
general
g 		Error: {{Module rating}} must be placed in the Module namespace.
protected protect
p 		Error: {{Module rating}} must be placed in the Module namespace.
semiprotected semiprotect
semi 		Error: {{Module rating}} must be placed in the Module namespace.
Anything else or if missing Error: {{Module rating}} must be placed in the Module namespace.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

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.
ParameterDescriptionTypeStatus
Rating1
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.
Suggested values
  • pre-alpha
  • alpha
  • beta
  • release
  • protected
  • semiprotected
Stringrequired
Do not categorizenocat
Set to true to disable categorization by rating. Normally leave blank.
Auto value
true
Booleanoptional
Fake namespacedemospace
Set to module to force template to display outside that namespace. Demonstration purposes only.
Example
module
Stringoptional

Format: inline

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


Retrieved from ‘https://safernicotine.wiki/mediawiki/index.php?title=Template:Module_rating/doc&oldid=38921’