Template:Module rating: Difference between revisions
imported>Eyesnore mNo edit summary |
(Created page with "<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 = 40x40px|link=|alt=Pre-alpha | alpha | a = Fil...") |
||
(26 intermediate revisions by 17 users not shown) | |||
Line 1: | Line 1: | ||
<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 |
|||
{{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 | experimental = [[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|class=skin-invert]] |
||
| beta | b = [[File:Greek lc beta.svg|40x40px|link=]] |
| beta | b = [[File:Greek lc beta icon.svg|40x40px|link=|alt=Beta|class=skin-invert]] |
||
| release | r | general | g = [[File:Green check.svg|40x40px|link=]] |
| release | r | general | g | stable = [[File:Green check.svg|40x40px|link=|alt=Ready for use]] |
||
| broken | br | unstable = [[File:Red x.svg|40x40px|link=|alt=Unstable]] |
|||
| 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: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 | 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. |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | | release | r | general | g | stable = 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. |
||
⚫ | | 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. |
||
-->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages --> |
|||
| 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. |
|||
⚫ | |||
⚫ | |||
⚫ | |||
-->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages --> |
|||
⚫ | |||
⚫ | |||
⚫ | | 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 [[ |
||
-->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages --> |
|||
⚫ | |||
⚫ | |||
⚫ | | 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 [[ |
||
-->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages --> |
|||
⚫ | |||
}} |
|||
| #default = {{error|Module rating is invalid or not specified.}} |
| #default = {{error|Module rating is invalid or not specified.}} |
||
}} |
}} |
||
}}<!-- |
|||
⚫ | |||
-->{{#ifeq: {{ROOTPAGENAME}} | Sandbox |
|||
| <!-- No category for user sandboxes --> |
|||
| {{#switch: {{SUBPAGENAME}} |
|||
⚫ | |||
| {{#ifeq: {{{nocat|}}} | true |
|||
| <!-- No category if user sets nocat=true --> |
|||
| {{#switch: {{{1|}}} |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
| broken | br | unstable = [[Category:Unstable modules|{{PAGENAME}}]] |
|||
⚫ | |||
| semiprotected | semiprotect | semi = [[Category:Modules subject to page protection|{{PAGENAME}}]] |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
--></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. --> |
Latest revision as of 13:40, 1 February 2025
![]() | 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:
Without categories:
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:
Template:Pre 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
|
prealpha pa
|
| ||
alpha
|
a
|
| ||
beta
|
b
|
| ||
release
|
r general g stable
|
| ||
broken
|
br unstable
|
| ||
protected
|
protect p
|
| ||
semiprotected
|
semiprotect semi
|
| ||
Anything else or if missing |
|
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
.