Template:Module rating/doc

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Module rating.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာ မန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha ∙ Tiếng Việt ∙ 简体中文 ∙ 繁體中文 ∙ +/−

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

{{Module rating |1= }}

Template parameters

ParameterDescriptionDefaultStatus
1ratingOne 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.emptyrequired
nocatDo not categorizeSet to true to disable categorization by rating. Normally leave blank.emptyoptional
demospaceFake namespaceSet to module to force template to display outside that namespace. Demonstration purposes only.emptyoptional
Template data
 Parameter text is empty
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
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.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

Wikipedia's help about TemplateData • Commons-specific information

This template is used to rate [[:en: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|&#123;&#123;Heavily used module&#125;&#125;]]. 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

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
rating1

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
Stringrequired
Fake namespacedemospace

Set to module to force template to display outside that namespace. Demonstration purposes only.

Unknownoptional
Do not categorizenocat

Set to true to disable categorization by rating. Normally leave blank.

Auto value
true
Booleanoptional

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

See also

{{Lua}}

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
ProtectedThis 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.

Categories

The template will put modules in one of the following categories, according to the rating specified:

These categories are suppressed on pages ending with /doc. To suppress categories on all pages, you can use the code |nocat=true.


Retrieved from "https://commons.wikimedia.org/w/index.php?title=Template:Module_rating/doc&oldid=628343020"