Template:Lua

Template documentation

[view] [edit] [history] [purge]

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:Lua-based templates, 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:Lua-based templates:

• Module:String has the default category Category:Lua String-based templates.

Error category

If no modules are specified and wishes are not enabled by default, the transcluded page will be added to Category:Lua templates with errors.

Wish category

If no modules are specified and |wish=true is used, the page will be added to Category:Lua-candidates

Category suppression

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

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Lua

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

See also

• Wikipedia:Lua
• {{Module rating }}

The above documentation is transcluded from Template:Lua/doc. (edit | history)
Editors can experiment in this template’s sandbox (edit | diff) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.