Template:Module rating: Difference between revisions

From Black Cat Studios
Jump to navigationJump to search
(Created page with "{{Documentation subpage}} <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> 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: {{pre|{{tlx|module rating|''rating''}}}} Without categories: {{pre|{{tlx|module rating|''rating''|3...")
m (1 revision imported)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
<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
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
| type      = notice
 
| image    = {{#switch: {{{1|}}}
This template is used to rate [[WP:LUA|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.
  | pre-alpha | prealpha | pa = [[File:Ambox warning blue construction.svg|40x40px|link=|alt=Pre-alpha]]
 
  | alpha | a                = [[File:Alpha lowercase.svg|26x26px|link=|alt=Alpha]]
== Usage ==
  | beta | b                  = [[File:Greek lc beta.svg|40x40px|link=|alt=Beta]]
 
  | release | r | general | g = [[File:Green check.svg|40x40px|link=|alt=Ready for use]]
Basic usage:
  | 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]]
{{pre|{{tlx|module rating|''rating''}}}}
  }}
 
| style    =  
Without categories:
| textstyle =  
 
| text      = {{#switch: {{{1|}}}
{{pre|{{tlx|module rating|''rating''|3=nocat=true}}}}
  | 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.<!--
 
  -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
If {{tlx|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]].
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in pre-alpha development|{{PAGENAME}}]] }}
 
      }}
If the documentation subpage is also protected:
  | 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.<!--
 
  -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
{{pre|{{tlx|module rating|''rating''|3=reason for documentation protection|4=action for documentation protection}}}}
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in alpha|{{PAGENAME}}]] }}
The second and third unnamed arguments correspond to reason and action of {{tl|Pp}} which gets included on the documentation subpage if at least the second unnamed argument is present.
      }}
 
  | 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.<!--
== Ratings ==
  -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
 
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in beta|{{PAGENAME}}]] }}
The rating should be placed in the first positional parameter. There are six different ratings: '''pre-alpha''', '''alpha''', '''beta''', '''release''', and '''protected''', and '''semiprotected'''. There are also short alias codes for each of the ratings.
      }}
 
  | 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.<!--
{| class="wikitable"
  -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
!scope="col"| Rating
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules for general use|{{PAGENAME}}]] }}
!scope="col"| Aliases
      }}
!scope="col"| Result
  | 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 -->
!scope="row"| <code>pre-alpha</code>
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules subject to page protection|{{PAGENAME}}]] }}
| <code>prealpha</code><br/><code>pa</code>
      }}
| {{module rating|pre-alpha|nocat=true|demospace=Module}}
  | 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 -->
!scope="row"| <code>alpha</code>
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules subject to page protection|{{PAGENAME}}]] }}
| <code>a</code>
      }}
| {{module rating|alpha|nocat=true|demospace=module}}
  | #default                  = {{error|Module rating is invalid or not specified.}}
|-
  }}
!scope="row"| <code>beta</code>
}}|{{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>
| <code>b</code>
{{module rating|release|nocat=true|demospace=module}}
| {{module rating|beta|nocat=true|demospace=module}}
{{documentation}}
|-
<!-- Categories go on the /doc subpage, and interwikis go in Wikidata. -->
!scope="row"| <code>release</code>
</noinclude>
| <code>r</code><br/><code>general</code><br/><code>g</code>
| {{module rating|release|nocat=true|demospace=module}}
|-
!scope="row"| <code>protected</code>
| <code>protect</code><br/><code>p</code>
| {{module rating|protected|nocat=true|demospace=module}}
|-
!scope="row"| <code>semiprotected</code>
| <code>semiprotect</code><br/><code>semi</code>
| {{module rating|semi|nocat=true|demospace=module}}
|-
!scope="row"| ''Anything else or if missing''
|
| {{module rating|prdaskidkated|nocat=true|demospace=module}}
|}
 
== TemplateData ==
{{Format TemplateData|<templatedata>
{
"description": "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.",
"format": "inline",
"params": {
"1": {
"label": "Rating",
"description": "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.",
"suggestedvalues": [
"pre-alpha",
"alpha",
"beta",
"release",
"protected",
"semiprotected"
],
"required": true,
"type": "string"
},
"nocat": {
"label": "Do not categorize",
"description": "Set to true to disable categorization by rating. Normally leave blank.",
"autovalue": "true",
"type": "boolean"
},
"demospace": {
"label": "Fake namespace",
"description": "Set to module to force template to display outside that namespace. Demonstration purposes only.",
"example": "module",
"type": "string"
}
}
}
</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 {{para|nocat|true}}.
 
== See also ==
 
* {{tl|module-rating categories}}
* [[Wikipedia:Lua]]
* [[Wikipedia:Lua requests]]
* {{tl|Lua}}
* {{tl|Template rating}}
 
<includeonly>{{sandbox other||
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:Template documentation]]
 
}}</includeonly>

Latest revision as of 19:32, 19 June 2023

Retrieved from "https://wiki.blackcatstudiosdev.com/index.php?title=Template:Module_rating&oldid=889"