Template:Lua

Documentation

[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:]], 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:]]:

• Module:String has the default category [[:Category:]].

Error category

If no modules are specified and wishes are not enabled by default, the transcluded page will be added to [[:Category:]].

Wish category

If no modules are specified or |wish=true is used, the page will be added to [[:Category:]]

Category suppression

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

TemplateData

Banner for templates that rely on Lua modules

Template parameters

Parameter		Description	Type	Status
Module 1	1	Name of the main module used in the template. Use multiple parameters to specify multiple modules.	Page name	required
Module 2	2	Name of the second module.	Page name	optional
Module 3	3	Name of the third module.	Page name	optional
Module 4	4	Name of the fourth module.	Page name	optional
Module 5	5	Name of the fifth module.	Page name	optional
Module 6	6	Name of the sixth module.	Page name	optional
Module 7	7	Name of the seventh module.	Page name	optional
Module 8	8	Name of the eighth module.	Page name	optional
Module 9	9	Name of the ninth module.	Page name	optional
Module 10	10	Name of the tenth module.	Page name	optional
No Category?	nocat	Whether to disable categorization. Default 0 Auto value 1	Boolean	optional
Wish?	wish	Whether this template is a candidate for conversion to Lua. Default 0 Auto value 1	Boolean	optional
Custom Category	category	Main category to put on pages using this template, without namespace prefix. Default Lua-based templates	String	optional

Edit parameter translations

The above documentation is transcluded from Template:Lua/doc. (edit | history)