Template:Module rating: Difference between revisions
Abhishek.it (talk | contribs) m 1 revision imported |
Undid revision 1290348417 by MSGJ (talk - does not work |
||
| Line 1: | Line 1: | ||
# | <noinclude>{{Being deleted|2025 March 1|Template:Template rating|merge=Template:Template rating}}</noinclude><includeonly>{{#ifeq:{{SUBPAGENAME}}|doc|<!--do not show protection level of the module on the doc page, use the second and optionally third parameter if the doc page is also protected -->{{#if:{{{2|}}}|{{Pp|{{{2}}}|action={{{3|}}}}}}}|{{Module other|{{ombox | ||
| type = notice | |||
{{ | | image = {{#switch: {{{1|}}} | ||
{{ | | pre-alpha | prealpha | pa | experimental = [[File:Ambox warning blue construction.svg|40x40px|link=|alt=Pre-alpha]] | ||
}} | | alpha | a = [[File:Greek lc alpha icon.svg|26x26px|link=|alt=Alpha|class=skin-invert]] | ||
| beta | b = [[File:Greek lc beta icon.svg|40x40px|link=|alt=Beta|class=skin-invert]] | |||
| release | r | general | g | stable | |||
| protected | protect | p | |||
| semiprotected | semiprotect | semi = [[File:Green check.svg|40x40px|link=|alt=Ready for use]] | |||
| broken | br | unstable = [[File:Red x.svg|40x40px|link=|alt=Unstable]] | |||
}} | |||
| style = | |||
| textstyle = | |||
| text = {{#switch: {{{1|}}} | |||
| pre-alpha | prealpha | pa | experimental = This module is rated as [[:Category:Modules in pre-alpha development|pre-alpha]]. It is unfinished, and may or may not be in active development. It should not be used from article namespace pages. 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. | |||
| alpha | a = This module is rated as [[:Category:Modules in alpha|alpha]]. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. | |||
| beta | b = This module is rated as [[:Category:Modules in beta|beta]], and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected. | |||
| release | r | general | g | stable | |||
| protected | protect | p | |||
| semiprotected | semiprotect | semi = This module is rated as [[:Category:Modules for general use|ready for general use]]. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by [[Wikipedia:Template sandbox and test cases|sandbox testing]] rather than repeated trial-and-error editing. | |||
| broken | br | unstable = This module is rated as [[:Category:Unstable modules|unstable]]. It contains either missing dependencies, compatibility errors, or output errors that make it unusable. Please help [[Special:EditPage/{{FULLPAGENAME}}|improve compatibility of this module]], or [[Wikipedia:Templates for discussion|nominate this module for deletion]] if it is unfixable. | |||
| #default = {{error|Module rating is invalid or not specified.}} | |||
}} | |||
}}<!-- | |||
-->{{#if:{{{demopage|}}}{{{demospace|}}}|| | |||
{{#ifeq: {{FULLPAGENAME}} | Sandbox | |||
| <!-- No category for user sandboxes --> | |||
| {{#switch: {{SUBPAGENAME}} | |||
| doc | sandbox =<!-- No category for /doc or /sandbox subpages --> | |||
| {{#ifeq: {{{nocat|}}} | true | |||
| <!-- No category if user sets nocat=true --> | |||
| {{#switch: {{{1|}}} | |||
| pre-alpha | prealpha | pa | experimental = [[Category:Modules in pre-alpha development|{{PAGENAME}}]] | |||
| alpha | a = [[Category:Modules in alpha|{{PAGENAME}}]] | |||
| beta | b = [[Category:Modules in beta|{{PAGENAME}}]] | |||
| release | r | general | g | stable = [[Category:Modules for general use|{{PAGENAME}}]] | |||
| broken | br | unstable = [[Category:Unstable modules|{{PAGENAME}}]] | |||
}} | |||
}} | |||
}} | |||
}} | |||
}}{{Module rating/protected|nocat={{{nocat|false}}}|demospace={{{demospace|<noinclude>module</noinclude>}}}{{#if:{{{demopage|}}}|{{!}}demopage={{{demopage|}}}}}}}<!-- | |||
-->|{{error|Error: {{tl|Module rating}} must be placed in the Module namespace.}} [[Category:Pages with templates in the wrong namespace]]|demospace={{{demospace|<noinclude>module</noinclude>}}}}}}}<!-- | |||
--></includeonly><noinclude> | |||
{{module rating|release|nocat=true|demospace=module|demopage=Module:This module is not protected}} | |||
{{documentation}} | |||
<!-- Categories go on the /doc subpage, and interwikis go in Wikidata. --> | |||
</noinclude> | |||
Revision as of 02:24, 14 May 2025
| This template is currently being merged with Template:Template rating. This template is being merged with another template, after which it will be redirected or deleted. Please check Wikipedia:Templates for discussion/Holding cell for any additional instructions. The decision to merge this template was made following this discussion initiated on 1 March 2025 at Templates for discussion. Note: Please review this template's instructions at Wikipedia:Templates for discussion/Holding cell before proceeding with any type of merging. |
| This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
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, protected, and broken. There are also short alias codes for each of the ratings.
| Rating | Aliases | Result | ||
|---|---|---|---|---|
pre-alpha
|
prealphapa
|
| ||
alpha
|
a
|
| ||
beta
|
b
|
| ||
release
|
rgeneralgstable
|
| ||
broken
|
brunstable
|
| ||
| Anything else or if missing |
|
TemplateData
- TemplateData|TemplateData]] for this template used by TemplateWizard, [[Chabadpedia
- VisualEditor|VisualEditor]] and other tools. See a monthly parameter usage report for Template:Module rating in articles based on its TemplateData.
TemplateData for Module rating
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Rating | 1 | 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.
| String | required |
| Do not categorize | nocat | Set to true to disable categorization by rating. Normally leave blank.
| Boolean | optional |
| Fake namespace | demospace | Set to module to force template to display outside that namespace. Demonstration purposes only.
| String | optional |
Categories
The template will put modules in one of the following categories, according to the rating specified:
- Category:Modules in pre-alpha development (0)
- Category:Modules in alpha (0)
- Category:Modules in beta (0)
- Category:Modules for general use (2)
- Category:Modules subject to page protection (0)
These categories are suppressed on pages ending with /doc. To suppress categories on all pages, you can use the code |nocat=true.