Template: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.
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 shown: <translate> Error:</translate> <translate> <tvar name=1>{{Module rating }}</tvar> must be placed in the Module namespace.</translate>
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
|
| ||
Anything else or if missing |
|
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Module rating
<templatedata> { "description": { "en": "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.", "cs": "Tato šablona se používá k hodnocení modulů Lua podle kvality. Je umístěna v horní části podstránky /doc modulu. Vytváří zprávu informující uživatele o systému hodnocení a také zařazuje modul do kategorie sledování." }, "format": "inline", "params": { "1": { "label": { "en": "Rating", "cs": "Hodnocení" }, "description": { "en": "One of pre-alpha, alpha, beta or release for quality, or protected, or an approved (see full docs) abbreviation for one of these.", "cs": "Jedna z pre-alfa, alfa, beta nebo verze pro kvalitu, nebo chráněná, nebo schválená (viz úplné dokumenty) zkratka pro jednu z těchto." }, "suggestedvalues": [ "pre-alpha", "alpha", "beta", "release", "protected" ], "required": true, "type": "string" }, "nocat": { "label": { "en": "Do not categorize", "cs": "Nezařazovat do kategorií" }, "description": { "en": "Set to true to disable categorization by rating. Normally leave blank.", "cs": "Pokud chcete zakázat kategorizaci podle hodnocení, nastavte na hodnotu true. Normálně ponechejte prázdné." }, "autovalue": "true", "type": "boolean" }, "demospace": { "label": { "en": "Fake namespace", "cs": "Falešný jmenný prostor" }, "description": { "en": "Set to module to force template to display outside that namespace. Demonstration purposes only.", "cs": "Nastavte na modul, abyste vynutili zobrazení šablony mimo tento jmenný prostor. Pouze pro účely demonstrace." }, "example": "Module", "type": "string" } } } </templatedata>
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 |nocat=true
.
See also
- {{Module-rating categories }}
- Lua
- {{Lua }}