Template:Lua/doc

	This is a documentation subpage for Template:Lua. It contains usage information, categories and other content that is not part of the original template page.

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:module name}}

All parameters

{{Lua|Module:module 1|Module:module 2|Module: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.

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

• {{Uses TemplateStyles}}

TemplateData

Creates a list of modules used by a template.

Template parameters

Parameter		Description	Type	Status
Module Name	1	The list of modules used by the template.	String	required
Category	category	To specify a different category.	String	optional
No Category	nocat	To stop it from automatically adding any categories. Suggested values yes y 1	String	optional