Template:Module rating/doc: Difference between revisions

Latest revision as of 04:46, 3 September 2020

This is a documentation subpage for Template:Module rating.
It may contain usage information, categories and other content that is not part of the original template page.

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:

{{module rating|rating}}

Without categories:

{{module rating|rating|nocat=true}}

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.

Ratings

The rating should be placed in the first positional parameter. There are five different ratings: pre-alpha, alpha, beta, release, and protected. 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 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.

Template data

This is the TemplateData for this template, used by TemplateWizard, VisualEditor and other tools.
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.

Template parameters
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. Example release	String	required
Do not categorize	`nocat`	Set to true to disable categorization by rating. Normally leave blank. Default Not set.	Boolean	optional
Fake namespace	`demospace`	Set to module to force template to display outside that namespace. Demonstration purposes only. Default Not set. Example module	String	optional

@@ Line 9: / Line 9: @@
 {{pre|{{tlx|module rating|''rating''}}}}
-With number of transclusions for protected modules:
-{{pre|{{tlx|module rating|protection|3=transclusions=<number>}}}}
 Without categories:
 {{pre|{{tlx|module rating|''rating''|3=nocat=true}}}}
+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]].
 == Ratings ==
@@ Line 25: / Line 23: @@
 ! Rating !! Aliases !! Result
 |-
-| <code>pre-alpha</code> || <code>prealpha</code><br/><code>pa</code> || {{module rating|pre-alpha|nocat=true}}
+| <code>pre-alpha</code> || <code>prealpha</code><br/><code>pa</code> || {{module rating|pre-alpha|nocat=true|demospace=Module}}
 |-
-| <code>alpha</code> || <code>a</code> || {{module rating|alpha|nocat=true}}
+| <code>alpha</code> || <code>a</code> || {{module rating|alpha|nocat=true|demospace=module}}
 |-
-| <code>beta</code> || <code>b</code> || {{module rating|beta|nocat=true}}
+| <code>beta</code> || <code>b</code> || {{module rating|beta|nocat=true|demospace=module}}
 |-
-| <code>release</code> || <code>r</code><br/><code>general</code><br/><code>g</code> || {{module rating|release|nocat=true}}
+| <code>release</code> || <code>r</code><br/><code>general</code><br/><code>g</code> || {{module rating|release|nocat=true|demospace=module}}
 |-
-| <code>protected</code> || <code>protect</code><br/><code>p</code> || {{module rating|protected|nocat=true}}
+| <code>protected</code> || <code>protect</code><br/><code>p</code> || {{module rating|protected|nocat=true|demospace=module}}
 |-
-| <code>transclusions=</code> || || {{module rating|protected|transclusions=1,000,000|nocat=true}}
+| <code>semiprotected</code> || <code>semiprotect</code><br/><code>semi</code> || {{module rating|semi|nocat=true|demospace=module}}
+|-
+| ''Anything else or if missing'' ||  || {{module rating|prdaskidkated|nocat=true|demospace=module}}
 |-
 |}
+==Template data==
+{{TemplateDataHeader}}
+<templatedata>
+{
+	"params": {
+		"1": {
+			"label": "Rating",
+			"description": "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.",
+			"example": "release",
+			"type": "string",
+			"required": true
+		},
+		"nocat": {
+			"label": "Do not categorize",
+			"description": "Set to true to disable categorization by rating. Normally leave blank.",
+			"type": "boolean",
+			"default": "Not set."
+		},
+		"demospace": {
+			"label": "Fake namespace",
+			"description": "Set to module to force template to display outside that namespace. Demonstration purposes only.",
+			"example": "module",
+			"type": "string",
+			"default": "Not set."
+		}
+	},
+	"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"
+}
+</templatedata>
 == Categories ==
@@ Line 55: / Line 90: @@
 * [[Wikipedia:Lua]]
 * [[Wikipedia:Lua requests]]
-* {{tl|Lua talk}}
+* {{tl|Lua}}
-<includeonly>
+<includeonly>{{sandbox other||
 <!-- Categories go here, and interwikis go in Wikidata -->
-[[Category:Template documentation|{{PAGENAME}}]]
+[[Category:Template documentation]]
-</includeonly>
+}}</includeonly>

Template:Module rating/doc: Difference between revisions

Latest revision as of 04:46, 3 September 2020

Contents

Usage

Ratings

Template data

Categories

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Support

Legal

Tools

In other projects

In other languages