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. |
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
[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}}
Uses Lua: |
- {{Lua|Module:Bananas|Module:BananasArgs}}
Uses Lua: |
- {{Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}
Uses Lua: |
- {{Lua|wish=true}}
This template should use Lua |
- {{Lua}}
Error: no modules specified |
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:
- Module:String has the default category Category:Lua String-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
Parameter | Description | Type | Status | |
---|---|---|---|---|
Module 1 | 1 | Name of the main module used in the template. Use multiple parameters to specify multiple modules. | Page name | required |
Module 2 | 2 | Name of the second module. | Page name | optional |
Module 3 | 3 | Name of the third module. | Page name | optional |
Module 4 | 4 | Name of the fourth module. | Page name | optional |
Module 5 | 5 | Name of the fifth module. | Page name | optional |
Module 6 | 6 | Name of the sixth module. | Page name | optional |
Module 7 | 7 | Name of the seventh module. | Page name | optional |
Module 8 | 8 | Name of the eighth module. | Page name | optional |
Module 9 | 9 | Name of the ninth module. | Page name | optional |
Module 10 | 10 | Name of the tenth module. | Page name | optional |
No Category? | nocat | Whether to disable categorization.
| Boolean | optional |
Wish? | wish | Whether this template is a candidate for conversion to Lua.
| Boolean | optional |
Custom Category | category | Main category to put on pages using this template, without namespace prefix.
| String | optional |
Edit parameter translations