Template:Module rating: Difference between revisions

Latest revision as of 14:11, 6 July 2026

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

Template documentation[ view · edit · history · purge ]

This documentation is transcluded from Template:Module rating/doc.

This template is used to rate Lua modules by quality. It is placed at the top of the module's /doc subpage and the layout fits to {{Heavily used module}}. It produces a message informing users about the rating system, and it also places the module into a tracking category. There are seven different ratings: pre-alpha, sandbox, alpha, beta, release, semiprotected and protected. There are also short alias codes for each of the ratings.

Usage

Template parameters

Parameter	Description		Default	Status
`1`	rating	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.	empty	required
`nocat`	Do not categorize	Set to true to disable categorization by rating. Normally leave blank.	empty	optional
`demospace`	Fake namespace	Set to module to force template to display outside that namespace. Demonstration purposes only.	empty	optional

Template data

Parameter text is empty

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

This template is used to rate [[:w:WP:LUA|Lua modules]] by quality. <span style="font-weight:normal">It is placed at the top of the module's /doc subpage and the layout fits to [[:Template:Heavily used module|{{Heavily used module}}]]. It produces a message informing users about the rating system, and it also places the module into a tracking category. There are seven different ratings: '''pre-alpha''', '''sandbox''', '''alpha''', '''beta''', '''release''', '''semiprotected''' and '''protected'''. There are also short alias codes for each of the ratings.</span>

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
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. Suggested values `pre-alpha` `alpha` `beta` `release` `protected` `semiprotected` `sandbox`	String	required
Fake namespace	`demospace`	Set to module to force template to display outside that namespace. Demonstration purposes only.	Unknown	optional
Do not categorize	`nocat`	Set to true to disable categorization by rating. Normally leave blank. Auto value `true`	Boolean	optional

Additional information

The template is intended to be used in the following namespaces: unknown

The template is intended to be used by the following user groups: all users

Placement: At the top of the page

Relies on:
{{Protection banner}}

Localization

Deutsch ∙ English ∙ 日本語 ∙ русский ∙ العربية ∙ 中文 ∙ français ∙ magyar ∙ +/−

This template makes use of {{Autotranslate}} and the translate extension.

Translate this template now!

Administrate translations.

Ratings

Rating Aliases Result

pre-alpha

prealpha
pa

This module is rated as pre-alpha. It is unfinished, and may or may not be in active development. It should not be used other than for testing. 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.

sandbox

s

Sandbox: This module is rated as pre-alpha. It is unfinished, and may or may not be in active development. It should not be used other than for testing. 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 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 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 ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

semiprotected

semiprotect
semi

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is semi-protected from editing.

protected

protect
p

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

Anything else or if missing

Module rating is invalid or not specified.

@@ Line 1: / Line 1: @@
-<includeonly>{{#ifeq:{{{demospace|{{NAMESPACE}} }}}|module|{{ombox
+<includeonly>{{#ifeq:{{{demospace|{{NAMESPACE}} }}}|{{ns:Module}}|{{ombox
-  | type      = notice
+ | lang      = {{Fallback|Module rating/i18n}}
+  | type      = {{#switch: {{{1|}}}
+   | pre-alpha | prealpha | pa
+   | sandbox | s
+   | alpha | a
+   | beta | b
+   | release | r | general | g
+   | semiprotected | semiprotect | semi
+   | protected | protect | p = notice
+   | #default = serious
+ }}
   | 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=]]
-    | alpha | a                 = [[File:Alpha lowercase.svg|26x26px|link=]]
+   | sandbox | s                        = [[File:Sandbox.svg|40x40px|link=]]
-    | beta | b                  = [[File:Greek lc beta.svg|40x40px|link=]]
+    | alpha | a                          = [[File:Greek lc alpha icon.svg|26x26px|link=|class=skin-invert]]
-    | release | r | general | g = [[File:Green check.svg|40x40px|link=]]
+    | beta | b                           = [[File:Greek lc beta icon.svg|40x40px|link=|class=skin-invert]]
-    | protected | protect | p   = [[File:Padlock{{#switch:{{#invoke:Effective protection level|edit|{{#switch:{{SUBPAGENAME}}|doc|sandbox={{FULLBASEPAGENAME}}|{{FULLPAGENAME}}}}}}|autoconfirmed=-silver|accountcreator|templateeditor=-pink|}}.svg|40x40px|link=]]
+    | release | r | general | g          = [[File:Green check.svg|40x40px|link=]]
-    | semiprotected | semiprotect | semi =[[File:Padlock-silver.svg|40x40px|link=]]
+    | protected | protect | p            = [[File:{{#switch:{{#invoke:Effective protection level|edit|{{#switch:{{SUBPAGENAME}}|doc|sandbox={{FULLBASEPAGENAME}}|{{FULLPAGENAME}}}}}}|autoconfirmed=Semi-protection-shackle|accountcreator|templateeditor=Template-protection-shackle-brackets 2|autopatroller=Extended-protection-shackle-account-pro-plus|sysop|#default=Full-protection-shackle-block}}.svg|40x40px|link=|alt=Protected]]
+    | semiprotected | semiprotect | semi = [[File:Semi-protection-shackle.svg|40x40px|link=]]
+   | #default                           = [[File:Ambox warning.svg|40x40px|link=]]
    }}
- | 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.<!--
+     | pre-alpha | prealpha | pa          = {{#invoke:Autotranslate|autotranslate|base=Module rating/i18n|pre-alpha}}
-   -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
+     | sandbox | s                        = Sandbox: {{#invoke:Autotranslate|autotranslate|base=Module rating/i18n|pre-alpha}}
-       | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in pre-alpha development|{{PAGENAME}}]] }}
+     | alpha | a                          = {{#invoke:Autotranslate|autotranslate|base=Module rating/i18n|alpha }}
-      }}
+     | beta | b                           = {{#invoke:Autotranslate|autotranslate|base=Module rating/i18n|beta}}
-   | 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          = {{#invoke:Autotranslate|autotranslate|base=Module rating/i18n|release }}
-   -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
+     | semiprotected | semiprotect | semi = {{#invoke:Autotranslate|autotranslate|base=Module rating/i18n|semiprotected }}
-       | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in alpha|{{PAGENAME}}]] }}
+     | protected | protect | p            = {{#invoke:Autotranslate|autotranslate|base=Module rating/i18n|protected }}
-      }}
+     | #default = {{error|message={{#invoke:Autotranslate|autotranslate|base=Module rating/i18n|invalid-rating}}}}
-   | 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 -->
+ | style     = background:var(--background-color-interactive-subtle,#f8f9fa);color:var(--color-base,#202122);
-       | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules in beta|{{PAGENAME}}]] }}
+}} <!-- End of ombox -->
-      }}
+{{#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 [[WP:TESTCASES|sandbox testing]] rather than repeated trial-and-error editing.<!--
+  | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | {{#switch: {{{1|}}}
-   -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
+     | pre-alpha | prealpha | pa = [[Category:Modules in pre-alpha development]]
-       | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules for general use|{{PAGENAME}}]] }}
+     | sandbox | s               = [[Category:Scribunto module sandboxes]]
-      }}
+     | alpha | a                 = [[Category:Modules in alpha]]
-   | 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 [[WP:SUBST|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:PROTECT|protected]] from editing.<!--
+     | beta | b                  = [[Category:Modules in beta]]
-   -->{{#switch: {{SUBPAGENAME}}|doc|sandbox=<!-- No category for /doc or /sandbox subpages -->
+     | release | r | general | g = [[Category:Modules for general use]]
-       | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules subject to page protection|{{PAGENAME}}]] }}
+     | semiprotected | semiprotect | semi
-      }}
+     | protected | protect | p   = [[Category:Modules subject to page protection]]
-   | 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 [[WP:SUBST|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 -->
+}}|{{error|message={{#invoke:Autotranslate|autotranslate|base=Module rating/i18n|error}} }} |demospace={{{demospace|}}}}}</includeonly><noinclude>
-       | {{#ifeq: {{{nocat|}}} | true | <!-- No category if user sets nocat=true --> | [[Category:Modules subject to page protection|{{PAGENAME}}]] }}
+{{module rating|release|nocat=true|demospace=Module}}
-      }}
-    | #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>