Template:Module rating/en
<languages />
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: Template:Pre
Without categories: Template:Pre
If {{#if:{{safesubst:#switch:
|no |n |false |0 = | = |¬ = |yes |y |true |1 = yes |#default = yes
}}|}}{{[[{{#if:|{{{SISTER}}}Template|Template}}:Module rating|Module rating]]{{#if:||{{{2}}}}}{{#if:||{{{3}}}}}{{#if:||{{{4}}}}}{{#if:||{{{5}}}}}{{#if:||{{{6}}}}}{{#if:||{{{7}}}}}{{#if:||...}}}} is used outside the Module namespace, an error message is shown: {{#switch:
{{#if:
|
| {{#ifeq:Template|Module
| module
| other
}}
}}
| module = {{#switch:
| pre-alpha | prealpha | pa = File:OOjs UI icon text-style.svg | alpha | a = File:OOjs UI icon bold-a.svg | beta | b = File:OOjs UI icon bold-b.svg | release | r | general | g = File:OOjs UI icon check-constructive.svg | protected | protect | p = [[File:{{#if:|Cascade-protection-shackle.svg|{{#ifeq:|sysop|Full-protection-shackle-red.svg|Semi-protection-shackle-no-text.svg}}}}|40x40px|link=]] | semiprotected | semiprotect | semi = File:Semi-protection-shackle.svg | #default = File:OOjs UI icon alert-destructive.svg}} | {{#switch:
| pre-alpha | prealpha | pa = <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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| 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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| 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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| release | r | general | g = <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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| protected | protect | p = <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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| #default = Template:Error
}} |
| other | #default = Template:Error }}
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
|
{{#switch:
{{#if:Module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
alpha
|
a
|
{{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
beta
|
b
|
{{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
release
|
rgeneralg
|
{{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
protected
|
protectp
|
{{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
| Anything else or if missing | {{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} |
TemplateData
Categories
The template will put modules in one of the following categories, according to the rating specified:
- {{#ifeq:Category:Modules in pre-alpha development|
|
}}[[Special:MyLanguage/Category:Modules in pre-alpha development|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules in pre-alpha development/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules in pre-alpha development
|Modules in pre-alpha development
|Category:Modules in pre-alpha development
}}
|Category:Modules in pre-alpha development
}}
}}}}]]{{#ifeq:Category:Modules in pre-alpha development|
|
}}
- {{#ifeq:Category:Modules in alpha|
|
}}[[Special:MyLanguage/Category:Modules in alpha|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules in alpha/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules in alpha
|Modules in alpha
|Category:Modules in alpha
}}
|Category:Modules in alpha
}}
}}}}]]{{#ifeq:Category:Modules in alpha|
|
}}
- {{#ifeq:Category:Modules in beta|
|
}}[[Special:MyLanguage/Category:Modules in beta|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules in beta/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules in beta
|Modules in beta
|Category:Modules in beta
}}
|Category:Modules in beta
}}
}}}}]]{{#ifeq:Category:Modules in beta|
|
}}
- {{#ifeq:Category:Modules for general use|
|
}}[[Special:MyLanguage/Category:Modules for general use|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules for general use/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules for general use
|Modules for general use
|Category:Modules for general use
}}
|Category:Modules for general use
}}
}}}}]]{{#ifeq:Category:Modules for general use|
|
}}
- {{#ifeq:Category:Modules subject to page protection|
|
}}[[Special:MyLanguage/Category:Modules subject to page protection|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules subject to page protection/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules subject to page protection
|Modules subject to page protection
|Category:Modules subject to page protection
}}
|Category:Modules subject to page protection
}}
}}}}]]{{#ifeq: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 Template:Para.
See also
{{#if: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: Template:Pre
Without categories: Template:Pre
If {{#if:{{safesubst:#switch:
|no |n |false |0 = | = |¬ = |yes |y |true |1 = yes |#default = yes
}}|}}{{[[{{#if:|{{{SISTER}}}Template|Template}}:Module rating|Module rating]]{{#if:||{{{2}}}}}{{#if:||{{{3}}}}}{{#if:||{{{4}}}}}{{#if:||{{{5}}}}}{{#if:||{{{6}}}}}{{#if:||{{{7}}}}}{{#if:||...}}}} is used outside the Module namespace, an error message is shown: {{#switch:
{{#if:
|
| {{#ifeq:Template|Module
| module
| other
}}
}}
| module =
{{#switch:
| pre-alpha | prealpha | pa = File:OOjs UI icon text-style.svg | alpha | a = File:OOjs UI icon bold-a.svg | beta | b = File:OOjs UI icon bold-b.svg | release | r | general | g = File:OOjs UI icon check-constructive.svg | protected | protect | p = [[File:{{#if:|Cascade-protection-shackle.svg|{{#ifeq:|sysop|Full-protection-shackle-red.svg|Semi-protection-shackle-no-text.svg}}}}|40x40px|link=]] | semiprotected | semiprotect | semi = File:Semi-protection-shackle.svg | #default = File:OOjs UI icon alert-destructive.svg}} | {{#switch:
| pre-alpha | prealpha | pa = <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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| 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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| 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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| release | r | general | g = <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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| protected | protect | p = <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>{{#ifexpr:
{{#ifexpr: (
{{#ifeq:en|doc|1|0}} or ( {{#ifeq:{{#titleparts:template:module rating/en|-1|-2}}|doc|1|0}} and {{#if:{{#translation:}}|1|0}} ) )|1|0}} or {{#ifeq:en|sandbox|1|0}} || {{#ifeq: | true | | }}
}}
| #default = Template:Error
}} |
| other | #default = Template:Error }}
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
|
{{#switch:
{{#if:Module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
alpha
|
a
|
{{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
beta
|
b
|
{{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
release
|
rgeneralg
|
{{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
protected
|
protectp
|
{{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} | ||||||||||||||||||||
| Anything else or if missing | {{#switch:
{{#if:module
|
module | Module | module | other
}} }} |
module =
|
other | #default = Template:Error
}} |
TemplateData
Categories
The template will put modules in one of the following categories, according to the rating specified:
- {{#ifeq:Category:Modules in pre-alpha development|
|
}}[[Special:MyLanguage/Category:Modules in pre-alpha development|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules in pre-alpha development/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules in pre-alpha development
|Modules in pre-alpha development
|Category:Modules in pre-alpha development
}}
|Category:Modules in pre-alpha development
}}
}}}}]]{{#ifeq:Category:Modules in pre-alpha development|
|
}}
- {{#ifeq:Category:Modules in alpha|
|
}}[[Special:MyLanguage/Category:Modules in alpha|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules in alpha/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules in alpha
|Modules in alpha
|Category:Modules in alpha
}}
|Category:Modules in alpha
}}
}}}}]]{{#ifeq:Category:Modules in alpha|
|
}}
- {{#ifeq:Category:Modules in beta|
|
}}[[Special:MyLanguage/Category:Modules in beta|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules in beta/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules in beta
|Modules in beta
|Category:Modules in beta
}}
|Category:Modules in beta
}}
}}}}]]{{#ifeq:Category:Modules in beta|
|
}}
- {{#ifeq:Category:Modules for general use|
|
}}[[Special:MyLanguage/Category:Modules for general use|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules for general use/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules for general use
|Modules for general use
|Category:Modules for general use
}}
|Category:Modules for general use
}}
}}}}]]{{#ifeq:Category:Modules for general use|
|
}}
- {{#ifeq:Category:Modules subject to page protection|
|
}}[[Special:MyLanguage/Category:Modules subject to page protection|{{#if: |{{{2}}} |{{#ifexist:Translations:{{#if:Category|Category:}}Modules subject to page protection/Page display title/en
|{{#if:
|{{#if:
|
|{{ Template:TNTN | nsp = 0 }}
}}
|{{ Template:TNTN }}
}}
|{{#if:
|{{#if:Modules subject to page protection
|Modules subject to page protection
|Category:Modules subject to page protection
}}
|Category:Modules subject to page protection
}}
}}}}]]{{#ifeq: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 Template:Para.
See also
[[Category:Template documentation pages{{#translation:}}]] }}