Template:Module rating: Difference between revisions

Latest revision as of 08:21, 17 October 2026

This module is rated as 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 sandbox testing rather than repeated trial-and-error editing.

Template documentation[view] [edit] [history] [purge]

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:

Template:Pre

Without categories:

Template:Pre

If {{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 the documentation subpage is also protected:

Template:Pre The second and third unnamed arguments correspond to reason and action of {{Pp}} which gets included on the documentation subpage if at least the second unnamed argument is present.

Ratings

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.

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

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 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 sandbox testing rather than repeated trial-and-error 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.

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.

Anything else or if missing

Module rating is invalid or not specified.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Module rating

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.

Parameter		Description	Type	Status
Rating	`1`	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. Suggested values `pre-alpha` `alpha` `beta` `release` `protected` `semiprotected`	String	required
Do not categorize	`nocat`	Set to true to disable categorization by rating. Normally leave blank. Auto value true	Boolean	optional
Fake namespace	`demospace`	Set to module to force template to display outside that namespace. Demonstration purposes only. Example module	String	optional

@@ Line 24: / Line 24: @@
         | {{#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.<!--
+    | 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 [[Bharatpedia: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.<!--
+    | protected | protect | p   = This module is [[:Category:Modules subject to page protection|subject to page protection]]. It is a [[Bharatpedia:High-risk templates|highly visible module]] in use by a very large number of pages, or is [[Bharatpedia: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 [[Bharatpedia: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.<!--
+    | semiprotected | semiprotect | semi   = This module is [[:Category:Modules subject to page protection|subject to page protection]]. It is a [[Bharatpedia:High-risk templates|highly visible module]] in use by a very large number of pages, or is [[Bharatpedia: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 [[BP: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}}]] }}

Template:Module rating: Difference between revisions

Latest revision as of 08:21, 17 October 2026

Contents

Usage

Ratings

TemplateData

Categories

See also