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 uses Lua: |
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:Example}}
| This template uses Lua: |
{{Lua|Module:Example|Module:Example}}
| This template uses Lua: |
{{Lua}}
| Error: no modules specified |
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:Lua String-based templates.
- 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:Lua-based citation 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.)
TemplateData
TemplateData for Lua
| ⧼templatedata-doc-param-name⧽ | ⧼templatedata-doc-param-desc⧽ | ⧼templatedata-doc-param-type⧽ | ⧼templatedata-doc-param-status⧽ | |
|---|---|---|---|---|
| Module 1 | 1 | Name of the main module used in the template. Use multiple parameters to specify multiple modules. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-required⧽ |
| Module 2 | 2 | Name of the second module. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Module 3 | 3 | Name of the third module. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Module 4 | 4 | Name of the fourth module. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Module 5 | 5 | Name of the fifth module. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Module 6 | 6 | Name of the sixth module. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Module 7 | 7 | Name of the seventh module. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Module 8 | 8 | Name of the eighth module. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Module 9 | 9 | Name of the ninth module. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Module 10 | 10 | Name of the tenth module. | ⧼templatedata-doc-param-type-wiki-page-name⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| No Category? | nocat | Whether to disable categorization.
| ⧼templatedata-doc-param-type-boolean⧽ | ⧼templatedata-doc-param-status-optional⧽ |
| Custom Category | category | Main category to put on pages using this template, without namespace prefix.
| ⧼templatedata-doc-param-type-string⧽ | ⧼templatedata-doc-param-status-optional⧽ |
Format: inline
See also