Template:Lua

From mediawiki.org
Jump to navigation Jump to search
Template documentation

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[edit]

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[edit]

  • {{Lua|Module:Bananas}}
  • {{Lua|Module:Bananas|Module:BananasArgs}}
  • {{Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}
  • {{Lua|wish=true}}

Categorisation[edit]

Template category[edit]

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:

Error category[edit]

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[edit]

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

TemplateData[edit]

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

Lua

Banner for templates that rely on Lua modules

Template parameters

ParameterDescriptionTypeStatus
Module 11

Name of the main module used in the template. Use multiple parameters to specify multiple modules.

Page namerequired
Module 22

Name of the second module.

Page nameoptional
Module 33

Name of the third module.

Page nameoptional
Module 44

Name of the fourth module.

Page nameoptional
Module 55

Name of the fifth module.

Page nameoptional
Module 66

Name of the sixth module.

Page nameoptional
Module 77

Name of the seventh module.

Page nameoptional
Module 88

Name of the eighth module.

Page nameoptional
Module 99

Name of the ninth module.

Page nameoptional
Module 1010

Name of the tenth module.

Page nameoptional
No Category?nocat

Whether to disable categorization.

Default
0
Auto value
1
Booleanoptional
Wish?wish

Whether this template is a candidate for conversion to Lua.

Default
0
Auto value
1
Booleanoptional
Custom Categorycategory

Main category to put on pages using this template, without namespace prefix.

Default
Lua-based templates
Stringoptional
Edit parameter translations

See also[edit]