View source for Template:Lua/doc

{{Documentation subpage}}
{{Template shortcut|Lua talk}}
{{Lua|Module:Lua banner}}
<!-- Categories go at the bottom of this page, and interwikis go on Wikidata. -->
{{for|template to indicate [[Luba-Kasai language]] words|Template:Lang-lua}}
This template is used to indicate that a template uses one or more [[Lua (programming language)|Lua]] modules (pages in the <code>Module:</code> namespace). It is placed at the top of the template's /doc page. It automatically adds a floating right notification box, and it 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:Templates based on the String Lua module]].
* [[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:Templates based on the Citation/CS1 Lua module]].

===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|TNT=Lua banner}}

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

<includeonly>{{Sandbox other|
| <!-- Categories go here, and interwikis go on Wikidata. -->
[[Category:Lua-based templates| ]]
[[Category:Template namespace templates]]
}}</includeonly>