Template:Lua/doc

From MattWiki
Jump to: navigation, search

{{LuaTemplate:\sandbox|Module:Lua banner}}

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

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

{{LuaTemplate:\sandbox|Module:Bananas|nocat=true}}

  • {{Lua|Module:Bananas|Module:BananasArgs}}

{{LuaTemplate:\sandbox|Module:Bananas|Module:BananasArgs|nocat=true}}

  • {{Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}

{{LuaTemplate:\sandbox|Module:Bananas|Module:BananasArgs|Module:HelloWorld|nocat=true}}

{{LuaTemplate:\sandbox|nocat=true}}

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:

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.)

See also