Template:Lua

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

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

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

• {{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: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 and Module:Citation/CS1 both have 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.

TemplateData for Lua

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