Difference between revisions of "Template:Module rating"
mediawiki>Shirayuki |
m (1 revision imported: Documentation Module) |
| (One intermediate revision by the same user not shown) | |
(No difference)
| |
Latest revision as of 18:43, 9 November 2021
<languages />
Template documentation<translate> This template is used to rate Lua modules by quality.</translate> <translate> It is placed at the top of the module's /doc subpage.</translate> <translate> It produces a message informing users about the rating system, and it also places the module into a tracking category.</translate>
<translate>
Usage
Basic usage: </translate> Template:Pre
<translate> Without categories:</translate> Template:Pre
<translate> If <tvar name=1>{{Module rating}}</tvar> is used outside the Module namespace, an error message is shown: <tvar name=2>Template:Error</tvar></translate>
<translate>
Ratings
</translate> <translate> The rating should be placed in the first positional parameter.</translate> <translate> There are five different ratings: <tvar name=1>pre-alphaTemplate:IntalphaTemplate:IntbetaTemplate:IntreleaseTemplate:IntTemplate:Intprotected</tvar>.</translate> <translate> There are also short alias codes for each of the ratings.</translate>
Template:(! class="wikitable"
! <translate> Rating</translate>
! <translate> Aliases</translate>
! <translate> Result</translate>
|-
| pre-alpha
| prealphapa
 | <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules in pre-alpha development</tvar>|pre-alpha]].</translate> <translate> It is unfinished, and may or may not be in active development.</translate> <translate> It should not be used from article namespace pages.</translate> <translate> Modules remain pre-alpha until the original editor (or someone who takes one over if it is abandoned for some time) is satisfied with the basic structure.</translate> |
|-
| alpha
| a
 | <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules in alpha</tvar>|alpha]].</translate> <translate> It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched.</translate> <translate> Suggestions for new features or changes in their input and output mechanisms are welcome.</translate> |
|-
| beta
| b
 | <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules in beta</tvar>|beta]], and is ready for widespread use.</translate> <translate> It is still new and should be used with some caution to ensure the results are as expected.</translate> |
|-
| release
| rgeneralg
 | <translate> This module is rated as [[<tvar name=1>Special:MyLanguage/Category:Modules for general use</tvar>|ready for general use]].</translate> <translate> It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate.</translate> <translate> It is ready to mention on help pages and other resources as an option for new users to learn.</translate> <translate> To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.</translate> |
|-
| protected
| protectp
 | <translate> This module is [[<tvar name=1>Special:MyLanguage/Category:Modules subject to page protection</tvar>|subject to {{<tvar name=2>#if:</tvar>|cascading|page}} protection]].</translate> <translate> It is a highly visible module in use by a very large number of pages.</translate> <translate> Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is [[<tvar name=1>Special:MyLanguage/Project:Protected page</tvar>|protected]] from editing.</translate> |
|- | <translate> Anything else or if missing</translate> |
| | Template:Error |
|- Template:!)
TemplateData
<translate>
Categories
The template will put modules in one of the following categories, according to the rating specified: </translate>
- 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
<translate> These categories are suppressed on pages ending with /doc.</translate>
<translate> To suppress categories on all pages, you can use the code <tvar name=1>|nocat=true</tvar>.</translate>
<translate>
See also
</translate>
- {{module-rating categories}}
- Lua
- {{Lua}}
[[Category:Template documentation pages{{#translation:}}]]