Template:Lua/doc

Banner for templates that rely on Lua modules

The template automatically sets the following categories:

• Category:Lua templates with errors, added if the module call contains errors.
• Category:Lua-candidates, added if no module is listed.
• Category:Lua-based templates, added if none of the below module_categories matches the first module listed.

Module categories: one of these categories is added if the first listed module is the listed module

• Category:Lua String-based templates (Module:String)
• Category:Lua-based iteration templates (Module:Iteration)

Usage

{{Lua |1= }}

Template parameters

 Parameter text is empty

<templatedata>JSON</templatedata> ./. {{TemplateBox}}

TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

---

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.

---

Wikipedia's help about TemplateData • Commons-specific information

Banner for templates that rely on Lua modules

Template parameters

This template prefers inline formatting of 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	suggested
Module 2	2	Name of the second module.	Page	optional
Module 3	3	Name of the third module.	Page	optional
Module 4	4	Name of the fourth module.	Page	optional
Module 5	5	Name of the fifth module.	Page	optional
Module 6	6	Name of the sixth module.	Page	optional
Module 7	7	Name of the seventh module.	Page	optional
Module 8	8	Name of the eighth module.	Page	optional
Module 9	9	Name of the ninth module.	Page	optional
Module 10	10	Name of the tenth module.	Page	optional
No Category?	nocat	Whether to disable categorization. Default 0 Auto value 1	Boolean	optional
Custom Category	category	Default Lua-based templates	String	optional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

Placement:

In the |mbox= parameter of {{TemplateBox}}.

Examples

{{Lua|Module:Bananas}}

renders as:

---

{{Lua|wish=true}}

renders as:

⧼Seealso⧽

• {{Uses TemplateStyles}}
• {{Uses TNT}}

Localization

This template is localized using Module:TNT. These translations are stored in Data:I18n/Lua banner.tab.