Template:Module rating: Difference between revisions
Jump to navigation
Jump to search
en>Pppery Simplify |
m 1 revision imported |
||
| (15 intermediate revisions by 9 users not shown) | |||
| Line 1: | Line 1: | ||
<includeonly>{{ | <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 | | type = notice | ||
| image = {{#switch: {{{1|}}} | | image = {{#switch: {{{1|}}} | ||
| pre-alpha | prealpha | pa = [[File:Ambox warning blue construction.svg|40x40px|link=]] | | pre-alpha | prealpha | pa = [[File:Ambox warning blue construction.svg|40x40px|link=|alt=Pre-alpha]] | ||
| alpha | a = [[File: | | alpha | a = [[File:Greek lc alpha icon.svg|26x26px|link=|alt=Alpha]] | ||
| beta | b = [[File:Greek lc beta.svg|40x40px|link=]] | | beta | b = [[File:Greek lc beta icon.svg|40x40px|link=|alt=Beta]] | ||
| release | r | general | g = [[File:Green check.svg|40x40px|link=]] | | release | r | general | g = [[File:Green check.svg|40x40px|link=|alt=Ready for use]] | ||
| protected | protect | p = [[File: | | protected | protect | p = [[File:{{#switch:{{#invoke:Effective protection level|edit|{{#switch:{{SUBPAGENAME}}|doc|sandbox={{FULLBASEPAGENAME}}|{{FULLPAGENAME}}}}}}|autoconfirmed=Semi|extendedconfirmed=Extended|accountcreator|templateeditor=Template|#default=Full}}-protection-shackle.svg|40x40px|link=|alt=Protected]] | ||
| semiprotected | semiprotect | semi =[[File: | | semiprotected | semiprotect | semi =[[File:Semi-protection-shackle.svg|40x40px|link=|alt=Semi-protected]] | ||
}} | }} | ||
| style = | | style = | ||
| textstyle = | | textstyle = | ||
| text = {{#switch: {{{1| | | text = {{#switch: {{{1|}}} | ||
| pre-alpha | prealpha | pa = 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. | | pre-alpha | prealpha | pa = 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 = 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. | |||
| 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. | | protected | protect | p = This module is [[:Category:Modules subject to page protection|subject to page protection]]. It is a [[Wikipedia:High-risk templates|highly visible module]] in use by a very large number of pages, or is [[Wikipedia:Substitution|substituted]] very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is [[Wikipedia:Protection policy|protected]] from editing. | ||
| semiprotected | semiprotect | semi = This module is [[:Category:Modules subject to page protection|subject to page protection]]. It is a [[Wikipedia:High-risk templates|highly visible module]] in use by a very large number of pages, or is [[Wikipedia:Substitution|substituted]] very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is [[WP:SEMI|semi-protected]] from editing. | |||
| 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 = 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 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 [[ | |||
| protected | protect | p = This module is [[:Category:Modules subject to page protection|subject to page protection]]. It is a [[Wikipedia:High-risk templates|highly visible module]] in use by a very large number of pages, or is [[ | |||
| semiprotected | semiprotect | semi = This module is [[:Category:Modules subject to page protection|subject to page protection]]. It is a [[Wikipedia:High-risk templates|highly visible module]] in use by a very large number of pages, or is [[ | |||
| #default = {{error|Module rating is invalid or not specified.}} | | #default = {{error|Module rating is invalid or not specified.}} | ||
}} | }} | ||
}}|demospace={{{demospace|<noinclude>module</noinclude>}}}}}<noinclude> | }}<!-- | ||
-->{{#ifeq: {{ROOTPAGENAME}} | 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 = [[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 = [[Category:Modules for general use|{{PAGENAME}}]] | |||
| protected | protect | p = [[Category:Modules subject to page protection|{{PAGENAME}}]] | |||
| semiprotected | semiprotect | semi = [[Category:Modules subject to page protection|{{PAGENAME}}]] | |||
}} | |||
}} | |||
}} | |||
}}<!-- | |||
-->|{{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}} | |||
{{documentation}} | {{documentation}} | ||
<!-- Categories go on the /doc subpage, and interwikis go in Wikidata. --> | <!-- Categories go on the /doc subpage, and interwikis go in Wikidata. --> | ||
</noinclude> | </noinclude> | ||
Latest revision as of 11:06, 17 April 2024
 | 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.
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Module rating in articles based on its 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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Rating | 1 | 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.
| 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 |
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 |
prealphapa |
| ||
alpha |
a |
| ||
beta |
b |
| ||
release |
rgeneralg |
| ||
protected |
protectp |
| ||
semiprotected |
semiprotectsemi |
| ||
| Anything else or if missing |
|
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.