pub.solar wiki - User contributions [en]

Module:String/doc/en

2025-10-19T02:46:34Z

FuzzyBot: Updating to match new version of source page

<noinclude>{{#ifeq:{{SUBPAGENAME}}|doc||{{Documentation subpage}}}}<languages/></noinclude>{{#switch:
| =
<includeonly>{{Languages|Module:String/doc}}</includeonly>

{{Magic words|general=1}}
{{Module rating|release}}
{{Module rating|protected}}
This module is intended to provide access to basic string functions.

Most of the functions provided here can be invoked with named parameters, unnamed parameters, or a mixture.
If named parameters are used, MediaWiki will automatically remove any leading or trailing whitespace from the parameter.
Depending on the intended use, it may be advantageous to either preserve or remove such whitespace.

== Global options ==

; <code>ignore_errors</code>
: If set to {{phpi|true}} or 1, any error condition will result in an empty string being returned rather than an error message.
; <code>error_category</code>
: If an error occurs, specifies the name of a category to include with the error message. The default category is {{ll|Category:Errors reported by Module String}}.
; <code>no_category</code>
: If set to {{phpi|true}} or 1, no category will be added if an error is generated.

Unit tests for this module are available at [[Module:String/testcases]].

== <code>len</code> ==

This function returns the length of the target string.

Usage:

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}len{{!}}''$1''<nowiki>}}</nowiki></code>
|1=target_string
}}

or

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}len{{!}}s= ''$1'' <nowiki>}}</nowiki></code>
|1=target_string
}}

Parameters:

; <code>s</code>
: The string whose length to report

== <code>sub</code> ==

: This function returns a substring of the target string at specified indices.

Usage:

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}sub{{!}}''$1''{{!}}''$2''{{!}}''$3''<nowiki>}}</nowiki></code>
|1=target_string
|2=start_index
|3=end_index
}}

OR

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}sub{{!}}s= ''$1'' {{!}}i= ''$2'' {{!}}j= ''$3'' <nowiki>}}</nowiki></code>
|1=target_string
|2=start_index
|3=end_index
}}

Parameters:

; <code>s</code>
: The string to return a subset of
; <code>i</code>
: The first index of the substring to return, defaults to 1.
; <code>j</code>
: The last index of the string to return, defaults to the last character.

The first character of the string is assigned an index of 1.
If either i or j is a negative value, it is interpreted the same as selecting a character by counting from the end of the string.
Hence, a value of -1 is the same as selecting the last character of the string.

If the requested indices are out of range for the given string, an error is reported.

== <code>match</code> ==

This function returns a substring from the source string that matches a specified pattern.

Usage:

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}match{{!}}''$1''{{!}}''$2''{{!}}''$3''{{!}}''$4''{{!}}''$5''{{!}}''$6''<nowiki>}}</nowiki></code>
|1=source_string
|2=pattern_string
|3=start_index
|4=match_number
|5=plain_flag
|6=nomatch_output
}}

OR

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}match{{!}}s= ''$1'' {{!}}pattern= ''$2'' {{!}}start= ''$3'' {{!}}match= ''$4'' {{!}}plain= ''$5'' {{!}}nomatch= ''$6'' <nowiki>}}</nowiki></code>
|1=source_string
|2=pattern_string
|3=start_index
|4=match_number
|5=plain_flag
|6=nomatch_output
}}

Parameters:

; <code>s</code>
: The string to search
; <code>pattern</code>
: The pattern or string to find within the string
; <code>start</code>
: The index within the source string to start the search. The first character of the string has index 1. Defaults to 1.
; <code>match</code>
: In some cases it may be possible to make multiple matches on a single string. This specifies which match to return, where the first match is <code>match = 1</code>. If a negative number is specified then a match is returned counting from the last match. Hence <code>match = -1</code> is the same as requesting the last match. Defaults to 1.
; <code>plain</code>
: Boolean flag indicating that pattern should be understood as plain text and not as a [[w:Lua (programming language)|Lua]]-style [[w:Regular expression|regular expression]]. Defaults to {{phpi|false}}.
; <code>nomatch</code>
: If no match is found, output the "nomatch" value rather than an error.

If the <code>match</code> or <code>start</code> are out of range for the string being queried, then this function generates an error.
An error is also generated if no match is found.
If one adds the parameter <code>ignore_errors=true</code>, then the error will be suppressed and an empty string will be returned on any failure.

For information on constructing [[w:Lua (programming language)|Lua]] patterns, a form of [[w:Regular expression|regular expression]], see:

* [https://www.lua.org/manual/5.1/manual.html#5.4.1 Lua reference: Patterns] - as of version 5.1
* {{ll|Extension:Scribunto/Lua reference manual#Patterns|2=Scribunto patterns}}
* {{ll|Extension:Scribunto/Lua reference manual#Ustring patterns|2=Scribunto Unicode string patterns}}

== <code>pos</code> ==

This function returns a single character from the target string at position pos.

Usage:

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}pos{{!}}''$1''{{!}}''$2''<nowiki>}}</nowiki></code>
|1=target_string
|2=index_value
}}

OR

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}pos{{!}}target= ''$1'' {{!}}pos= ''$2'' <nowiki>}}</nowiki></code>
|1=target_string
|2=index_value
}}

Parameters:

; <code>target</code>
: The string to search
; <code>pos</code>
: The index for the character to return

The first character has an index value of 1.

If one requests a negative value, this function will select a character by counting backwards from the end of the string.
In other words <code>pos = -1</code> is the same as asking for the last character.

A requested value of zero, or a value greater than the length of the string returns an error.

== <code>find</code> ==

This function allows one to search for a target string or pattern within another string.

Usage:

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}find{{!}}''$1''{{!}}''$2''{{!}}''$3''{{!}}''$4''<nowiki>}}</nowiki></code>
|1=source_str
|2=target_string
|3=start_index
|4=plain_flag
}}

OR

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}find{{!}}source= ''$1'' {{!}}target= ''$2'' {{!}}start= ''$3'' {{!}}plain= ''$4'' <nowiki>}}</nowiki></code>
|1=source_str
|2=target_str
|3=start_index
|4=plain_flag
}}

Parameters:

; <code>source</code>
: The string to search
; <code>target</code>
: The string or pattern to find within source
; <code>start</code>
: The index within the source string to start the search, defaults to 1
; <code>plain</code>
: Boolean flag indicating that target should be understood as plain text and not as a [[w:Lua (programming language)|Lua]]-style [[w:Regular expression|regular expression]], defaults to {{phpi|true}}

This function returns the first index >= "start" where "target" can be found within "source".
Indices are 1-based.
If "target" is not found, then this function returns 0.
If either "source" or "target" are missing / empty, this function also returns 0.

This function should be safe for UTF-8 strings.

== <code>replace</code> ==

This function allows one to replace a target string or pattern within another string.

Usage:

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}replace{{!}}''$1''{{!}}''$2''{{!}}''$3''{{!}}''$4''{{!}}''$5''<nowiki>}}</nowiki></code>
|1=source_str
|2=pattern_string
|3=replace_string
|4=replacement_count
|5=plain_flag
}}

OR

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}replace{{!}}source= ''$1'' {{!}}pattern= ''$2'' {{!}}replace= ''$3'' {{!}}count= ''$4'' {{!}}plain= ''$5'' <nowiki>}}</nowiki></code>
|1=source_string
|2=pattern_string
|3=replace_string
|4=replacement_count
|5=plain_flag
}}

Parameters:

; <code>source</code>
: The string to search
; <code>pattern</code>
: The string or pattern to find within source
; <code>replace</code>
: The replacement text
; <code>count</code>
: The number of occurrences to replace; defaults to all
; <code>plain</code>
: Boolean flag indicating that pattern should be understood as plain text and not as a [[Special:MyLanguage/Extension:Scribunto/Lua reference manual#Ustring patterns|Scribunto ustring pattern]] (a unicode-friendly [[w:Lua (programming language)|Lua]]-style [[w:Regular expression|regular expression]]); defaults to {{phpi|true}}

== <code>rep</code> ==

Repeats a string ''n'' times.

Usage:

: {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}rep{{!}}''$1''{{!}}''$2''<nowiki>}}</nowiki></code>
|1=source
|2=count
}}

Parameters:

; <code>source</code>
: The string to repeat
; <code>count</code>
: The number of repetitions.

Example {{tmpl|0=<code><nowiki>{{#invoke:</nowiki>String{{!}}rep{{!}}$1{{!}}3<nowiki>}}</nowiki></code>|hello}} gives {{tmpl|0={{#invoke:String|rep|$1|3}}|hello}}
<includeonly>{{Sandbox other||

[[Category:Modules]]
}}</includeonly><noinclude>
[[Category:Module documentation pages{{#translation:}}]]
</noinclude>
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Module:String/doc|noshift=1|uselang={{int:lang}}}}
}}

Template:Mbox templates/en

2025-09-23T21:18:45Z

FuzzyBot: Updating to match new version of source page

<languages/>
<onlyinclude>{{nmbox
| image = [[File:Codex icon puzzle.svg|22px|link=|class=skin-invert]]
| header = {{ll|Template:Mbox|2=Message box templates}}
| text = {{flatlist|1=
* {{tll|ambox}}
* {{tll|cmbox}}
* {{tll|fmbox}}
* {{tll|imbox}}
* {{tll|nmbox}}
* {{tll|ombox}}
* {{tll|tmbox}}
}}
}}</onlyinclude>
[[Category:Navigation templates{{#translation:}}]]

Template:Magic words/en

2025-09-14T10:22:25Z

FuzzyBot: Updating to match new version of source page

<noinclude>
<languages/>
</noinclude>{{nmbox|image=[[File:Codex icon function.svg|20px|link=|class=skin-invert-image]]
|header=Magic words
|headerstyle=background-color=#8d7ebd;|textstyle=background-color=#e6e0f0;
|text={{flatlist|
* {{#if:{{{general|}}}||'''General editors:'''{{nbsp}}}}{{ll|Help:Magic words|nsp=no}}
* {{ll|Help:Extension:ParserFunctions|2=Additional parser functions}} ({{ll|Extension:ParserFunctions|nsp=no}})
* {{ll|Module:String|2=String functions module}} ({{ll|Extension:Scribunto|nsp=no}})
* {{ll|Template:Parser functions nav|2=Navbox of parser functions}}
}}{{#if:{{{general|}}}||
<hr/>
{{flatlist|
* '''Developers and technical contributors:'''
* {{ll|Manual:Expr parser function syntax|2=<code>#expr</code> syntax}}
* {{ll|Help:Parser functions in templates|nsp=no}}
* Parser function extension development: ({{ll|Manual:Extending wiki markup|2=Overview}}
* {{ll|Manual:Magic words|nsp=no}}
* {{ll|Manual:Variables|2=Variables}}
* {{ll|Manual:Parser functions|nsp=no}}
* {{ll|Manual:Tag extensions|2=Parser tags}})
* {{ll|Parser function extensions}}
* {{ll|Parser function extensions#Table of functions|2=List of additional parser functions}}
* {{ll|Parser function hooks|nsp=no}}
* {{ll|Parser extension tags|2=List of parser tags}}
* {{ll|Category:Parser extensions}} ({{ll|Category:Parser function extensions}}
* {{ll|Category:Tag extensions}}
* {{ll|Category:Variable extensions}})
}}
}}}}<noinclude>
{{Documentation}}
[[Category:Navigation templates{{#translation:}}]]
[[Category:Magic words{{#translation:}}]]
</noinclude>

Template:Template shortcut/en

2025-08-27T20:50:15Z

FuzzyBot: Updating to match new version of source page

<languages />
<onlyinclude>{{#tag:indicator|{{Badge|content={{PLURAL:<includeonly>{{#invoke:Loops|numArgs}}</includeonly><noinclude>1</noinclude>|shortcut|shortcuts}}: <noinclude>{{mono|nowrap=1|{{{{No redirect|Template:tsh|tsh}}}}}}</noinclude>{{#invoke:Loops|forNumArgs| {{mono|nowrap=1|{{#if:{{yesno|{{{target|}}}}}|²{tl¦$1}²|{{²{No redirect¦Template:$1¦$1}²}}}}}} }}}}|name=tpl-shortcut}}</onlyinclude>
{{Documentation|content=
{{Lua|Module:Loops}}
== TemplateData ==
{{Template:Template shortcut/doc}}

== See also ==
* {{tlx|Shortcut}}
}}

Template:Translatable template name/en

2025-06-27T22:46:36Z

FuzzyBot: Updating to match new version of source page

<noinclude>
<languages/>
</noinclude><includeonly>{{#invoke:Template translation{{{sandbox|}}}|getTranslatedTemplate|uselang={{{uselang|}}}|tntns={{{tntns|{{{namespace|}}}}}}|template={{#if:{{{noshift|}}}|{{{template}}}|{{{1}}}}}|noshift={{{noshift|}}}}}</includeonly><noinclude>
{{documentation|content=

{{High-use|15000}}
{{tsh|TNTN|tntn}}
{{Lua|Module:Template translation}}

== Purpose ==
This template is used to return the name of translatable templates in the language of the current page.
Templates, like all other MediaWiki pages, can be translated using the {{ll|Extension:Translate|nsp=0}} extension, which creates subpages with the form "pagename/language code".
The template first checks if the name of the page contains a language code.
If it does, it then checks if the template name given as a first parameter has a translation in that language.
If the page name does not contain a language code, or if the navigation template doesn't exist in that language, it will display the English template.

== How to use ==
* <code><nowiki>{{ {{Translatable template name|</nowiki>''name of navigation template''<nowiki>}}|</nowiki>''parameters....''<nowiki>}}</nowiki></code>
* <code><nowiki>{{ {{TNTN|</nowiki>''name of navigation template''<nowiki>}}|</nowiki>''parameters....''<nowiki>}}</nowiki></code>
* <code><nowiki>{{ {{tntn|</nowiki>''name of navigation template''<nowiki>}}|</nowiki>''parameters....''<nowiki>}}</nowiki></code>

Example (from translatable [[meta:Template:Meta]], used in translatable page [[meta:Meta:About]]):

: <code><nowiki>{{Translatable template name|Navbar}}</nowiki></code> or <code><nowiki>{{TNTN|Navbar}}</nowiki></code>

which returns the translated versions of {{tl|Navbar}} if it exists, or the English version if translations don't exist.

== Parameters ==
The current version of the template may now include any kind of named or numbered parameters, whose values will be transferred into the called template (except for parameter 1 containing the basename of the translatable template to transclude).
Numbered parameters will be shifted down by one position, all named parameters will be passed unchanged.

One named parameter is treated specially:

* <code><nowiki>{{Translatable template name|tntns=</nowiki>'':somename:''<nowiki>|</nowiki>''page name''<nowiki>}}</nowiki></code>
* <code><nowiki>{{TNTN|tntns=</nowiki>'':somename:''<nowiki>|</nowiki>''page name''<nowiki>}}</nowiki></code>
* <code><nowiki>{{tntn|tntns=</nowiki>'':somename:''<nowiki>|</nowiki>''page name''<nowiki>}}</nowiki></code>

This <code>tntns</code> will be used to specify another namespace from which the translatable pagename will be transcluded, instead of referencing the page name from the default <code>:Template:</code> namespace. Note that this parameter is also passed (without modification) within the parameters of the transclusion.

Example with one parameters (from [[meta:Meta:About]] which is translatable):

* <code><nowiki>{{ {{TNTN|Navbar}} |Meta:About}}</nowiki></code>

== Dependency ==
* [[Module:Template translation]] (standard version)
* [[meta:Module:Template translation/sandbox]] (used when this template is called with optional parameter <code>sandbox=/sandbox</code>, for testing modifications only)

== See also ==
* {{tl|Translatable template}}, alias {{tl|TNT}} or {{tl|tnt}}

[[Category:Navigation templates{{#translation:}}|* {{PAGENAME}}]]
[[Category:Internationalization templates{{#translation:}}|{{PAGENAME}}]]
[[Category:Lua-based templates]]
}}
</noinclude>

Template:High-risk/en

2023-08-19T01:30:35Z

FuzzyBot: Updating to match new version of source page

<noinclude>
<languages/>
</noinclude>{{#switch:
| =
{{ombox
| type = content
| image = [[File:OOjs UI icon alert-warning.svg|40px|alt=]]
| imageright =
| text = {{#switch:{{NAMESPACE}}
|Module={{#if:{{{1|}}}
|'''This Lua module is used on approximately {{formatnum:{{{1}}}}} pages.'''
|'''This Lua module is used on many pages.'''
}}
|#default={{#if:{{{1|}}}
|'''This template is used on approximately {{formatnum:{{{1}}}}} pages.'''
|'''This template is used on many pages.'''
}}
}} 
{{#switch:{{NAMESPACE}}
|Module=To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its [[{{#switch:{{SUBPAGENAME}}|doc|sandbox={{SUBJECTSPACE}}:{{BASEPAGENAME}}|#default={{SUBJECTPAGENAME}}}}/sandbox|/sandbox]] or [[{{#switch:{{SUBPAGENAME}}|doc|sandbox={{SUBJECTSPACE}}:{{BASEPAGENAME}}|#default={{SUBJECTPAGENAME}}}}/testcases|/testcases]] subpages.
|#default=To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its [[{{#switch:{{SUBPAGENAME}}|doc|sandbox={{SUBJECTSPACE}}:{{BASEPAGENAME}}|#default={{SUBJECTPAGENAME}}}}/sandbox|/sandbox]] or [[{{#switch:{{SUBPAGENAME}}|doc|sandbox={{SUBJECTSPACE}}:{{BASEPAGENAME}}|#default={{SUBJECTPAGENAME}}}}/testcases|/testcases]] subpages or in your own [[Special:MyLanguage/Help:Subpages#Use of subpages|user subpage]].
}}
The tested changes can then be added to this page in one single edit.
{{#if:{{{2|}}}
|Please consider discussing any changes at [[{{trim|{{{2}}}}}]] before implementing them.
|Please consider discussing any changes on the [[{{#switch:{{SUBPAGENAME}}|doc|sandbox={{TALKSPACE}}:{{BASEPAGENAME}}|#default={{TALKPAGENAME}}}}|talk page]] before implementing them.
}}
}}
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:High-risk|noshift=1|uselang={{int:lang}}}}
}}<noinclude>
{{Documentation|content=

This is the {{tl|high-risk}} message box. It is meant to be put at the top of the documentation page on the most high-use (high-risk) templates and Lua modules (the template detects the name space), i.e., for templates used on a large number of pages

{{note|1=It is normal that some of the links in the message box are red.}}

=== Usage ===
The template can be used as is.
But it can also take some parameters:

* First parameter is the number of pages.
* Second parameter is the name of some other talk page if you want discussion to be made there instead. But a better option might be to redirect the talkpage of your template to that other talkpage.

===Examples===
<pre>
{{high-risk| 30,000+ | Project:Village Pump}}
</pre>

{{high-risk| 30,000+ | Project:Village Pump}}

<pre>
{{high-risk| 30,000+ }}
</pre>

{{high-risk| 30,000+ }}

<pre>
{{high-risk| | Project:Village Pump}}
</pre>

{{high-risk| | Project:Village Pump}}

The full code for a /doc page top may look like this:

<pre>
{{documentation subpage}}

{{high-risk| 30,000+ }}
</pre>

=== Technical details ===
The [[{{translatable}}/sandbox|/sandbox]] and [[{{translatable}}/testcases|/testcases]] links are the standard names for such subpages.
If those pages are created then the green /doc box for the template will detect them and link to them in its heading.
For instance see the top of this documentation.

=== See also ===
* {{tl|intricate template}} – For the intricate, i.e., complex templates.
* {{tl|pp-template}} – The protection template that usually is put on high-risk templates.
* {{tl|used in system}} – For templates used in the user interface.

}}
</noinclude>

Template:Module rating/en

2021-08-06T11:11:35Z

FuzzyBot: Updating to match new version of source page

<noinclude>
<languages />
</noinclude><includeonly>{{Module other|{{ombox
| type = notice
| image = {{#switch: {{{1|}}}
| pre-alpha | prealpha | pa = [[File:OOjs UI icon text-style.svg|40x40px|link=]]
| alpha | a = [[File:OOjs UI icon bold-a.svg|40x40px|link=]]
| beta | b = [[File:OOjs UI icon bold-b.svg|40x40px|link=]]
| release | r | general | g = [[File:OOjs UI icon check-constructive.svg|40x40px|link=]]
| protected | protect | p = [[File:{{#if:{{CASCADINGSOURCES:{{FULLPAGENAME}}}}|Cascade-protection-shackle.svg|{{#ifeq:{{PROTECTIONLEVEL:edit}}|sysop|Full-protection-shackle-red.svg|Semi-protection-shackle-no-text.svg}}}}|40x40px|link=]]
| semiprotected | semiprotect | semi = [[File:Semi-protection-shackle.svg|40x40px|link=]]
| #default = [[File:OOjs UI icon alert-destructive.svg|40x40px|link=]]
}}
| style =
| textstyle =
| text = {{#switch: {{{1|}}}
| pre-alpha | prealpha | pa = This module is rated as [[Special:MyLanguage/Category:Modules in pre-alpha development|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.{{#ifexpr:

{{IsDocSubpage|false=0}} or {{#ifeq:{{SUBPAGENAME}}|sandbox|1|0}}
|| {{#ifeq: {{{nocat|}}} | true |  | [[Category:Modules in pre-alpha development|{{PAGENAME}}]] }}
}}
| alpha | a = This module is rated as [[Special:MyLanguage/Category:Modules in alpha|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.{{#ifexpr:

{{IsDocSubpage|false=0}} or {{#ifeq:{{SUBPAGENAME}}|sandbox|1|0}}
|| {{#ifeq: {{{nocat|}}} | true |  | [[Category:Modules in alpha|{{PAGENAME}}]] }}
}}
| beta | b = This module is rated as [[Special:MyLanguage/Category:Modules in beta|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.{{#ifexpr:

{{IsDocSubpage|false=0}} or {{#ifeq:{{SUBPAGENAME}}|sandbox|1|0}}
|| {{#ifeq: {{{nocat|}}} | true |  | [[Category:Modules in beta|{{PAGENAME}}]] }}
}}
| release | r | general | g = This module is rated as [[Special:MyLanguage/Category:Modules for general use|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 resources as an option for new users to learn. To reduce server load and bad output, it should be improved by [[w:WP:TESTCASES|sandbox testing]] rather than repeated trial-and-error editing.{{#ifexpr:

{{IsDocSubpage|false=0}} or {{#ifeq:{{SUBPAGENAME}}|sandbox|1|0}}
|| {{#ifeq: {{{nocat|}}} | true |  | [[Category:Modules for general use|{{PAGENAME}}]] }}
}}
| protected | protect | p = This module is [[Special:MyLanguage/Category:Modules subject to page protection|subject to {{#if:{{CASCADINGSOURCES:{{FULLPAGENAME}}}}|cascading|page}} protection]]. It is a highly visible module in use by a very large number of pages. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is [[Special:MyLanguage/Project:Protected page|protected]] from editing.{{#ifexpr:

{{IsDocSubpage|false=0}} or {{#ifeq:{{SUBPAGENAME}}|sandbox|1|0}}
|| {{#ifeq: {{{nocat|}}} | true |  | [[Category:Modules subject to page protection|{{PAGENAME}}]] }}
}}
| #default = {{error|1=Module rating is invalid or not specified.}}
}}
}}|{{error|1=Error: {{tl|Module rating}} must be placed in the Module namespace.}}|demospace={{{demospace|<noinclude>module</noinclude>}}}}}</includeonly><noinclude>
{{documentation|content=

This template is used to rate [[Lua/Overview|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=nocat=true}}}}

If {{tlx|Module rating}} is used outside the Module namespace, an error message is shown: {{module rating}}

== Ratings ==
The rating should be placed in the first positional parameter.
There are five different ratings: '''pre-alpha'''{{int|comma-separator}}'''alpha'''{{int|comma-separator}}'''beta'''{{int|comma-separator}}'''release'''{{int|and}}{{int|word-separator}}'''protected'''.
There are also short alias codes for each of the ratings.

{{(!}} class="wikitable"
! Rating
! Aliases
! Result
{{!}}-
{{!}} <code>pre-alpha</code>
{{!}} <code>prealpha</code> <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> <code>general</code> <code>g</code>
{{!}} {{module rating|release|nocat=true|demospace=module}}
{{!}}-
{{!}} <code>protected</code>
{{!}} <code>protect</code> <code>p</code>
{{!}} {{module rating|protected|nocat=true|demospace=module}}
{{!}}-
{{!}} ''Anything else or if missing''
{{!}}
{{!}} {{module rating|prdaskidkated|nocat=true|demospace=module}}
{{!}}-
{{!)}}

== TemplateData ==
{{Module rating/doc}}

== Categories ==

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

* {{ll|Category:Modules in pre-alpha development}}
* {{ll|Category:Modules in alpha}}
* {{ll|Category:Modules in beta}}
* {{ll|Category:Modules for general use}}
* {{ll|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 {{para|nocat|true}}.

== See also ==
* {{tl|module-rating categories}}
* [[Lua]]
* {{tl|Lua}}

}}
</noinclude>