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...")
No edit summary
Line 1: Line 1:
{{Documentation subpage}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->


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.
Main menu


== Usage ==
WikipediaThe Free Encyclopedia
Search
Create account
Log in


Basic usage:
Personal tools
View source for Template:Module rating


{{pre|{{tlx|module rating|''rating''}}}}
Template
Talk
Read
View source
View history


Without categories:
Tools
← Template:Module rating
You do not have permission to edit this page, for the following reason:


{{pre|{{tlx|module rating|''rating''|3=nocat=true}}}}
This page is currently semi-protected so that only established, registered users can edit it.
Why is the page protected?
While most articles can be edited by anyone, semi-protection is sometimes necessary to prevent vandalism to popular pages.
The reason for protection can be found in the protection log. If there are no relevant entries in the protection log, the page may have been moved after being protected.
What can I do?
If you have a user account, log in first. If you do not yet have an account, you may create one; after 4 days and 10 edits, you will be able to edit semi-protected pages.
Discuss this page with others.
For move-protected pages, see requested moves.
Request that the page's protection level be reduced.
Find out more about how to get started editing Wikipedia.
If you have noticed an error or have a suggestion for a simple, non-controversial change, you can submit an edit request by clicking the button below and following the instructions. An established user may then make the change on your behalf. Please check the talk page first in case the issue is already being discussed.
Submit an edit request


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]].
If you wrote any text, please save it temporarily to your device until you can edit this page.
You can view and copy the source of this page:
<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 = [[File:Ambox warning blue construction.svg|40x40px|link=|alt=Pre-alpha]]
  | alpha | a                = [[File:Alpha lowercase.svg|26x26px|link=|alt=Alpha]]
  | 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]]
  | 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    =
| textstyle =
| 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.<!--
  -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in pre-alpha development|{{PAGENAME}}]] }}
      }}
  | 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 -->
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in alpha|{{PAGENAME}}]] }}
      }}
  | 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.<!--
  -->{{#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}}]] }}
      }}
  | 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.<!--
  -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules for general use|{{PAGENAME}}]] }}
      }}
  | 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 -->
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules subject to page protection|{{PAGENAME}}]] }}
      }}
  | 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 -->
      | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules subject to page protection|{{PAGENAME}}]] }}
      }}
  | #default                  = {{error|Module rating is invalid or not specified.}}
  }}
}}|{{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}}
<!-- Categories go on the /doc subpage, and interwikis go in Wikidata. -->
</noinclude>


If the documentation subpage is also protected:
Pages transcluded onto the current version of this page (help):


{{pre|{{tlx|module rating|''rating''|3=reason for documentation protection|4=action for documentation protection}}}}
Template:Documentation (view source) (template editor protected)
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.
Template:Documentation subpage (view source) (template editor protected)
Template:Error (view source) (template editor protected)
Template:Format TemplateData (view source) (semi-protected)
Template:Module other (view source) (extended confirmed protected)
Template:Module rating (view source) (semi-protected)
Template:Module rating/doc (edit)
Template:Ombox (view source) (protected)
Template:Para (view source) (template editor protected)
Template:Pre (view source) (semi-protected)
Template:Pre/styles.css (view source) (semi-protected)
Template:Sandbox other (view source) (template editor protected)
Template:TemplateData header (view source) (template editor protected)
Template:Template link (view source) (protected)
Template:Template link expanded (view source) (protected)
Template:Template other (view source) (protected)
Template:Template parameter usage (view source) (template editor protected)
Template:Tl (view source) (protected)
Template:Tlx (view source) (protected)
Template:Yesno (view source) (protected)
Template:Yesno-no (view source) (template editor protected)
Template:Yesno-yes (view source) (template editor protected)
Module:Arguments (view source) (protected)
Module:Check for unknown parameters (view source) (protected)
Module:Documentation (view source) (template editor protected)
Module:Documentation/config (view source) (template editor protected)
Module:Documentation/styles.css (view source) (template editor protected)
Module:Effective protection expiry (view source) (protected)
Module:Effective protection level (view source) (protected)
Module:Error (view source) (template editor protected)
Module:File link (view source) (template editor protected)
Module:Format TemplateData (view source) (semi-protected)
Module:Format TemplateData/config (view source) (semi-protected)
Module:JSONutil (view source)
Module:Message box (view source) (protected)
Module:Message box/configuration (view source) (protected)
Module:Message box/ombox.css (view source) (protected)
Module:Multilingual (view source) (semi-protected)
Module:Protection banner (view source) (template editor protected)
Module:Protection banner/config (view source) (template editor protected)
Module:String (view source) (protected)
Module:Template link general (view source) (protected)
Module:Yesno (view source) (protected)
Return to Template:Module rating.


== Ratings ==
Privacy policyAbout WikipediaDisclaimersContact WikipediaCode of ConductMobile viewDevelopersStatisticsCookie statementWikimedia FoundationPowered by MediaWiki
 
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.
 
{| class="wikitable"
!scope="col"| Rating
!scope="col"| Aliases
!scope="col"| Result
|-
!scope="row"| <code>pre-alpha</code>
| <code>prealpha</code><br/><code>pa</code>
| {{module rating|pre-alpha|nocat=true|demospace=Module}}
|-
!scope="row"| <code>alpha</code>
| <code>a</code>
| {{module rating|alpha|nocat=true|demospace=module}}
|-
!scope="row"| <code>beta</code>
| <code>b</code>
| {{module rating|beta|nocat=true|demospace=module}}
|-
!scope="row"| <code>release</code>
| <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>

Revision as of 19:26, 19 June 2023

Main menu

WikipediaThe Free Encyclopedia Search Create account Log in

Personal tools View source for Template:Module rating

Template Talk Read View source View history

Tools ← Template:Module rating You do not have permission to edit this page, for the following reason:


This page is currently semi-protected so that only established, registered users can edit it. Why is the page protected? While most articles can be edited by anyone, semi-protection is sometimes necessary to prevent vandalism to popular pages. The reason for protection can be found in the protection log. If there are no relevant entries in the protection log, the page may have been moved after being protected. What can I do? If you have a user account, log in first. If you do not yet have an account, you may create one; after 4 days and 10 edits, you will be able to edit semi-protected pages. Discuss this page with others. For move-protected pages, see requested moves. Request that the page's protection level be reduced. Find out more about how to get started editing Wikipedia. If you have noticed an error or have a suggestion for a simple, non-controversial change, you can submit an edit request by clicking the button below and following the instructions. An established user may then make the change on your behalf. Please check the talk page first in case the issue is already being discussed. Submit an edit request

If you wrote any text, please save it temporarily to your device until you can edit this page. You can view and copy the source of this page:


Main menu

WikipediaThe Free Encyclopedia Search Create account Log in

Personal tools View source for Template:Module rating

Template Talk Read View source View history

Tools ← Template:Module rating You do not have permission to edit this page, for the following reason:


This page is currently semi-protected so that only established, registered users can edit it. Why is the page protected? While most articles can be edited by anyone, semi-protection is sometimes necessary to prevent vandalism to popular pages. The reason for protection can be found in the protection log. If there are no relevant entries in the protection log, the page may have been moved after being protected. What can I do? If you have a user account, log in first. If you do not yet have an account, you may create one; after 4 days and 10 edits, you will be able to edit semi-protected pages. Discuss this page with others. For move-protected pages, see requested moves. Request that the page's protection level be reduced. Find out more about how to get started editing Wikipedia. If you have noticed an error or have a suggestion for a simple, non-controversial change, you can submit an edit request by clicking the button below and following the instructions. An established user may then make the change on your behalf. Please check the talk page first in case the issue is already being discussed. Submit an edit request

If you wrote any text, please save it temporarily to your device until you can edit this page. You can view and copy the source of this page:

Pages transcluded onto the current version of this page (help):

Template:Documentation (view source) (template editor protected) Template:Documentation subpage (view source) (template editor protected) Template:Error (view source) (template editor protected) Template:Format TemplateData (view source) (semi-protected) Template:Module other (view source) (extended confirmed protected) Template:Module rating (view source) (semi-protected) Template:Module rating/doc (edit) Template:Ombox (view source) (protected) Template:Para (view source) (template editor protected) Template:Pre (view source) (semi-protected) Template:Pre/styles.css (view source) (semi-protected) Template:Sandbox other (view source) (template editor protected) Template:TemplateData header (view source) (template editor protected) Template:Template link (view source) (protected) Template:Template link expanded (view source) (protected) Template:Template other (view source) (protected) Template:Template parameter usage (view source) (template editor protected) Template:Tl (view source) (protected) Template:Tlx (view source) (protected) Template:Yesno (view source) (protected) Template:Yesno-no (view source) (template editor protected) Template:Yesno-yes (view source) (template editor protected) Module:Arguments (view source) (protected) Module:Check for unknown parameters (view source) (protected) Module:Documentation (view source) (template editor protected) Module:Documentation/config (view source) (template editor protected) Module:Documentation/styles.css (view source) (template editor protected) Module:Effective protection expiry (view source) (protected) Module:Effective protection level (view source) (protected) Module:Error (view source) (template editor protected) Module:File link (view source) (template editor protected) Module:Format TemplateData (view source) (semi-protected) Module:Format TemplateData/config (view source) (semi-protected) Module:JSONutil (view source) Module:Message box (view source) (protected) Module:Message box/configuration (view source) (protected) Module:Message box/ombox.css (view source) (protected) Module:Multilingual (view source) (semi-protected) Module:Protection banner (view source) (template editor protected) Module:Protection banner/config (view source) (template editor protected) Module:String (view source) (protected) Module:Template link general (view source) (protected) Module:Yesno (view source) (protected) Return to Template:Module rating.

Privacy policyAbout WikipediaDisclaimersContact WikipediaCode of ConductMobile viewDevelopersStatisticsCookie statementWikimedia FoundationPowered by MediaWiki


Pages transcluded onto the current version of this page (help):

Template:Documentation (view source) (template editor protected) Template:Documentation subpage (view source) (template editor protected) Template:Error (view source) (template editor protected) Template:Format TemplateData (view source) (semi-protected) Template:Module other (view source) (extended confirmed protected) Template:Module rating (view source) (semi-protected) Template:Module rating/doc (edit) Template:Ombox (view source) (protected) Template:Para (view source) (template editor protected) Template:Pre (view source) (semi-protected) Template:Pre/styles.css (view source) (semi-protected) Template:Sandbox other (view source) (template editor protected) Template:TemplateData header (view source) (template editor protected) Template:Template link (view source) (protected) Template:Template link expanded (view source) (protected) Template:Template other (view source) (protected) Template:Template parameter usage (view source) (template editor protected) Template:Tl (view source) (protected) Template:Tlx (view source) (protected) Template:Yesno (view source) (protected) Template:Yesno-no (view source) (template editor protected) Template:Yesno-yes (view source) (template editor protected) Module:Arguments (view source) (protected) Module:Check for unknown parameters (view source) (protected) Module:Documentation (view source) (template editor protected) Module:Documentation/config (view source) (template editor protected) Module:Documentation/styles.css (view source) (template editor protected) Module:Effective protection expiry (view source) (protected) Module:Effective protection level (view source) (protected) Module:Error (view source) (template editor protected) Module:File link (view source) (template editor protected) Module:Format TemplateData (view source) (semi-protected) Module:Format TemplateData/config (view source) (semi-protected) Module:JSONutil (view source) Module:Message box (view source) (protected) Module:Message box/configuration (view source) (protected) Module:Message box/ombox.css (view source) (protected) Module:Multilingual (view source) (semi-protected) Module:Protection banner (view source) (template editor protected) Module:Protection banner/config (view source) (template editor protected) Module:String (view source) (protected) Module:Template link general (view source) (protected) Module:Yesno (view source) (protected) Return to Template:Module rating.

Privacy policyAbout WikipediaDisclaimersContact WikipediaCode of ConductMobile viewDevelopersStatisticsCookie statementWikimedia FoundationPowered by MediaWiki

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