Template:Lua/doc: Difference between revisions
(Created page with "{{Doc/start}} {{Lua|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:{{#invoke:Data|Module:Lua banner/config|default_category}}]], or to one of its subcategories. == Usage == ; Basic : {{tlx|Lua|''module name''}} ; All parameters : {{tlx|Lua|''module 1''|''module 2''|''module 3''|...|categor...") |
No edit summary |
||
Line 1: | Line 1: | ||
{{ | {{doc/start}} | ||
{{Lua|Module:Lua banner}} | {{Lua|Module:Lua banner}} | ||
This template is used to show that templates have been converted to [[w:Lua (programming language)|Lua]]. It is placed at the top of the template's /doc page. It automatically adds the template to [[:Category:{{#invoke:Data|Module:Lua banner/config|default_category}}]], or to one of its subcategories. | This template is used to show that templates have been converted to [[w:Lua (programming language)|Lua]]. It is placed at the top of the template's /doc page. It automatically adds the template to [[:Category:{{#invoke:Data|Module:Lua banner/config|default_category}}]], or to one of its subcategories. | ||
Line 53: | Line 53: | ||
{{TemplateData header}} | {{TemplateData header}} | ||
{{#invoke:TNT|doc|Lua banner}} | {{#invoke:TNT|doc|Lua banner}} | ||
{{doc/end}} | |||
<includeonly></includeonly> | |||
Latest revision as of 01:07, 26 June 2022
Script error: No such 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 error in package.lua at line 80: module 'Module:Lua banner/config' not found.]], 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}}
Script error: No such module "Lua banner".
{{Lua|Module:Bananas|Module:BananasArgs}}
Script error: No such module "Lua banner".
{{Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}
Script error: No such module "Lua banner".
{{Lua|wish=true}}
Script error: No such module "Lua banner".
{{Lua}}
Script error: No such module "Lua banner".
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 error in package.lua at line 80: module 'Module:Lua banner/config' not found.]]:
- Module:String has the default category [[:Category:Lua error in package.lua at line 80: module 'Module:Lua banner/config' not found.]].
Error category
If no modules are specified and wishes are not enabled by default, the transcluded page will be added to [[:Category:Lua error in package.lua at line 80: module 'Module:Lua banner/config' not found.]].
Wish category
If no modules are specified or |wish=true
is used, the page will be added to [[:Category:Lua error in package.lua at line 80: module 'Module:Lua banner/config' not found.]]
Category suppression
To suppress all categorisation, use |nocat=true
. (As well as "true", the values "yes", "y", and "1" will also work.)
TemplateData
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 |
This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.