FilipeFonseca: 1 revision imported

2021-07-08T08:31:56Z

1 revision imported

New page

{{Documentation subpage}}
{{Template shortcut|Lua talk}}
{{Lua|Module:Lua banner}}

{{for|template to indicate [[Luba-Kasai language]] words|Template:Lang-lua}}
This template is used to show that templates have been converted to [[Lua (programming language)|Lua]]. It is placed at the top of the template's /doc page. It automatically adds the template to [[:Category:Lua-based templates]], or to one of its subcategories.

== Usage ==

; Basic : {{tlx|Lua|''module name''}}

; All parameters : {{tlx|Lua|''module 1''|''module 2''|''module 3''|...|category{{=}}''custom category''|nocat{{=}}''true''}}

The first module name is required.

== Examples ==

* {{tlx|Lua|Module:Example}}
{{Lua|Module:Example|nocat=true}}
{{clear}}

* {{tlx|Lua|Module:Example|Module:Example}}
{{Lua|Module:Example|Module:Example|nocat=true}}
{{clear}}

* {{tlx|Lua}}
{{Lua|nocat=true}}
{{clear}}

== Categorisation ==

===Template category===
This template adds pages to [[:Category:Lua-based templates]] if the page is in the template namespace, and it is not on any of the subpages /doc, /sandbox, /sandbox2 or /testcases. You can specify a different category with the {{para|category}} parameter, e.g. {{para|category|Lua String-based templates}}.

Some modules have a default category other than [[:Category:Lua-based templates]]:
* [[Module:String]] has the default category [[:Category:Lua String-based templates]].
* [[Module:Math]] has the default category [[:Category:Templates based on the Math Lua module]].
* [[Module:BaseConvert]] has the default category [[:Category:Templates based on the BaseConvert Lua module]].
* [[Module:Citation]] and [[Module:Citation/CS1]] both have the default category [[:Category:Lua-based citation templates]].

===Error category===
If no modules are specified, the transcluded page will be added to [[:Category:Lua templates with errors]].

===Category suppression===
To suppress all categorisation, use {{para|nocat|true}}. (As well as "true", the values "yes", "y", and "1" will also work.)

== TemplateData ==
{{Format TemplateData|<templatedata>
{
"description": "Banner for templates that rely on Lua modules",
"format": "inline",
"params": {
"1": {
"label": "Module 1",
"description": "Name of the main module used in the template. Use multiple parameters to specify multiple modules.",
"required": true,
"type": "wiki-page-name"
},
"2": {
"label": "Module 2",
"description": "Name of the second module.",
"type": "wiki-page-name"
},
"3": {
"label": "Module 3",
"description": "Name of the third module.",
"type": "wiki-page-name"
},
"4": {
"label": "Module 4",
"description": "Name of the fourth module.",
"type": "wiki-page-name"
},
"5": {
"label": "Module 5",
"description": "Name of the fifth module.",
"type": "wiki-page-name"
},
"6": {
"label": "Module 6",
"description": "Name of the sixth module.",
"type": "wiki-page-name"
},
"7": {
"label": "Module 7",
"description": "Name of the seventh module.",
"type": "wiki-page-name"
},
"8": {
"label": "Module 8",
"description": "Name of the eighth module.",
"type": "wiki-page-name"
},
"9": {
"label": "Module 9",
"description": "Name of the ninth module.",
"type": "wiki-page-name"
},
"10": {
"label": "Module 10",
"description": "Name of the tenth module.",
"type": "wiki-page-name"
},
"nocat": {
"label": "No Category?",
"description": "Whether to disable categorization.",
"default": "0",
"autovalue": "1",
"type": "boolean"
},
"category": {
"label": "Custom Category",
"description": "Main category to put on pages using this template, without namespace prefix.",
"default": "Lua-based templates",
"type": "string"
}
}
}
</templatedata>}}

== See also ==
* [[Wikipedia:Lua]]
* {{tl|module rating}}

<includeonly>{{Sandbox other|
| 
[[Category:Lua-based templates| ]]
[[Category:Template namespace templates]]
}}</includeonly>

Template:Lua/doc - Revision history

FilipeFonseca: 1 revision imported