Template:Lua/sandbox

This is the template sandbox page for Template:Lua (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

{{Lua talk}}
{{Uses Lua}}

This template is used on approximately 9,900 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Lua banner (sandbox)

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 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:Example}}

This template uses Lua:

Module:Example (sandbox)

{{Lua|Module:Example|Module:Example}}

This template uses Lua:

{{Lua|Module:$Example$}}

This template uses Lua:

Module:$Example$

{{Lua}}

Error: no modules specified

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: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/CS1 has 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 |nocat=true. (As well as "true", the values "yes", "y", and "1" will also work.)

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Lua in articles based on its TemplateData.

TemplateData for Lua

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