Template:Lua/doc
This is a documentation subpage for Template:Lua. It contains usage information, categories and other content or metadata that is not part of the original template. |
This template is used to show that templates have been converted to Lua. It is placed at the top of the template's /doc page. It automatically adds the template to [[:Category:{{#invoke:Data|Module:Lua banner/config|default_category}}]], or to one of its subcategories.
Usage
- Basic
{{Lua|module name}}
- All parameters
{{Lua|module 1|module 2|module 3|...|category=custom category|nocat=true}}
The first module name is required.
Examples
{{Lua|Module:Bananas}}
{{Lua|Module:Bananas|Module:BananasArgs}}
{{Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}
{{Lua|wish=true}}
{{Lua}}
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 |category = parameter, e.g. |category = Lua String-based templates.
Some modules have a default category other than [[:Category:{{#invoke:Data|Module:Lua banner/config|default_category}}]]:
- Module:String has the default category [[:Category:{{#invoke:Data|Module:Lua banner/config|module_categories|String}}]].
Error category
If no modules are specified and wishes are not enabled by default, the transcluded page will be added to [[:Category:{{#invoke:Data|Module:Lua banner/config|error_category}}]].
Wish category
If no modules are specified or |wish = true is used, the page will be added to [[:Category:{{#invoke:Data|Module:Lua banner/config|wish_category}}]]
Category suppression
To suppress all categorisation, use |nocat = true. (As well as "true", the values "yes", "y", and "1" will also work.)
TemplateData
TemplateData for Lua
{{#invoke:TNT|doc|Lua banner}}