Template:Module rating/doc: Difference between revisions

From Saintapedia
Jump to navigation Jump to search
VisualWikitext
>Tomoneill
(copy from https://en.wikipedia.org/w/index.php?title=Template:Module_rating/doc&oldid=815992589)
 
(Created page with "{{Documentation subpage}} <!-- Categories go at the bottom of this page and interwikis go in Wikidata. --> 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: {{pre|{{tlx|module rating|''rating''}}}} Without categories: {{pre|{{tlx|module rating|''rating''|3...")
Line 16: Line 16:
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]].
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]].


{{TemplateDataHeader}}
If the documentation subpage is also protected:
<templatedata>
 
{{pre|{{tlx|module rating|''rating''|3=reason for documentation protection|4=action for documentation protection}}}}
The second and third unnamed arguments correspond to reason and action of {{tl|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.
 
{| class="wikitable"
!scope="col"| Rating
!scope="col"| Aliases
!scope="col"| Result
|-
!scope="row"| <code>pre-alpha</code>
| <code>prealpha</code><br/><code>pa</code>
| {{module rating|pre-alpha|nocat=true|demospace=Module}}
|-
!scope="row"| <code>alpha</code>
| <code>a</code>
| {{module rating|alpha|nocat=true|demospace=module}}
|-
!scope="row"| <code>beta</code>
| <code>b</code>
| {{module rating|beta|nocat=true|demospace=module}}
|-
!scope="row"| <code>release</code>
| <code>r</code><br/><code>general</code><br/><code>g</code>
| {{module rating|release|nocat=true|demospace=module}}
|-
!scope="row"| <code>protected</code>
| <code>protect</code><br/><code>p</code>
| {{module rating|protected|nocat=true|demospace=module}}
|-
!scope="row"| <code>semiprotected</code>
| <code>semiprotect</code><br/><code>semi</code>
| {{module rating|semi|nocat=true|demospace=module}}
|-
!scope="row"| ''Anything else or if missing''
|
| {{module rating|prdaskidkated|nocat=true|demospace=module}}
|}
 
== TemplateData ==
{{Format TemplateData|<templatedata>
{
{
"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",
"params": {
"params": {
"1": {
"1": {
"label": "Rating",
"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.",
"description": "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.",
"example": "release",
"suggestedvalues": [
"type": "string",
"pre-alpha",
"required": true
"alpha",
"beta",
"release",
"protected",
"semiprotected"
],
"required": true,
"type": "string"
},
},
"nocat": {
"nocat": {
"label": "Do not categorize",
"label": "Do not categorize",
"description": "Set to true to disable categorization by rating. Normally leave blank.",
"description": "Set to true to disable categorization by rating. Normally leave blank.",
"type": "boolean",
"autovalue": "true",
"default": "Not set."
"type": "boolean"
},
},
"demospace": {
"demospace": {
Line 37: Line 89:
"description": "Set to module to force template to display outside that namespace. Demonstration purposes only.",
"description": "Set to module to force template to display outside that namespace. Demonstration purposes only.",
"example": "module",
"example": "module",
"type": "string",
"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>
</templatedata>}}
 
 
== 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.
 
{| class="wikitable"
! Rating !! Aliases !! Result
|-
| <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|demospace=module}}
|-
| <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|demospace=module}}
|-
| <code>protected</code> || <code>protect</code><br/><code>p</code> || {{module rating|protected|nocat=true|demospace=module}}
|-
| <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}}
|-
|}


== Categories ==
== Categories ==
Line 87: Line 112:
* [[Wikipedia:Lua requests]]
* [[Wikipedia:Lua requests]]
* {{tl|Lua}}
* {{tl|Lua}}
* {{tl|Template rating}}


<includeonly>{{sandbox other||
<includeonly>{{sandbox other||
<!-- Categories go here, and interwikis go in Wikidata -->
<!-- Categories go here, and interwikis go in Wikidata -->
[[Category:Template documentation]]
[[Category:Documentation templates]]
 
[[Category:Wikipedia Lua-related templates]]
}}</includeonly>
}}</includeonly>

Revision as of 21:05, 6 September 2024

Edit-copy green.svg This is a documentation subpage for Template:Module rating (see that page for the template itself).
It contains 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.

If the documentation subpage is also protected: 

{{module rating|rating|reason for documentation protection|action for documentation protection}}

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
alpha a
beta b
release r
general
g
protected protect
p
semiprotected semiprotect
semi
Anything else or if missing

TemplateData

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.
ParameterDescriptionTypeStatus
Rating1
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
Stringrequired
Do not categorizenocat
Set to true to disable categorization by rating. Normally leave blank.
Auto value
true
Booleanoptional
Fake namespacedemospace
Set to module to force template to display outside that namespace. Demonstration purposes only.
Example
module
Stringoptional

Format: inline

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.

See also


Retrieved from ‘https://saintapedia.org/w/index.php?title=Template:Module_rating/doc&oldid=1844’