Template:Lua/doc

This template is used to indicate that a template uses one or more Lua modules (pages in the Module: 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 one of its subcategories.

Usage

Basic

{{Lua|module name}}

All parameters

{{Lua|module 1|module 2|module 3|…|category=custom category|nocat=true}}

At least one module name is required.

Examples

• Specifying one module: {{Lua|Module:Map}}

• Specifying multiple modules: {{Lua|Module:Map|Module:Coordinates}}

• Failing to specify at least one Lua module: {{Lua}}

Categorization

Template category

This template adds pages to Category:Lua-based templates if the page is in the template namespace and it is not a /doc, /sandbox, /sandbox2 or /testcases subpage. You can specify a different category with the |category= parameter, such as |category=Lua String-based templates.

Some modules have a default category other than Category:Lua-based templates:

• Module:Math has the default category Category:Templates based on the Math Lua module.
• Module:String has the default category Category:Templates based on the String Lua module.

Error category

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

Categorization suppression

To suppress all categorization, use |nocat=true, or any of the other standard Boolean "truthy" values: yes, y and 1.

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

See also

• Lua
• {{Uses TemplateStyles}}