Template:Module rating

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

{{Module rating |1= }}

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

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

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

Categories

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

• Category:Modules in pre-alpha development
• Category:Scribunto module sandboxes
• 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 |nocat=true.