Template:Lua/doc: Difference between revisions
More actions
←Created page with '{{Lua|Module:Lua banner}} {{TemplateBox |1 =<!-- Name of the first parameter the template takes --> |1label =Module |1d-en =Name of the module...' |
Use main {{TemplateBox}} |
||
| (6 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | |||
{{TemplateBox | |||
| name = Lua | |||
| mbox = | |||
{{Lua|Module:Lua banner}} | {{Lua|Module:Lua banner}} | ||
{{TemplateBox | {{Uses TNT|Lua banner}} | ||
| desc-en = Banner for templates that rely on Lua modules | |||
| | | namespace = Template | ||
| | | usergroup = all | ||
| | | placement = In the {{para|mbox}} parameter of {{tld|TemplateBox}}. | ||
| | |||
| | | setscats = | ||
* {{cl|{{#invoke:Data|Module:Lua banner/config|error_category}}}}, added if the module call contains errors{{#if:{{yesno|{{#invoke:Data|Module:Lua banner/config|allow_wishes}}}}|. | |||
* {{cl|{{#invoke:Data|Module:Lua banner/config|wish_category}}}}, added if no module is listed. | |||
| (e.g. no module listed). | |||
}} | |||
* {{cl|{{#invoke:Data|Module:Lua banner/config|default_category}}}}, 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 | |||
* {{cl|{{#invoke:Data|Module:Lua banner/config|module_categories|String}}}} ([[Module:String]]) | |||
* {{cl|{{#invoke:Data|Module:Lua banner/config|module_categories|Iteration}}}} ([[Module:Iteration]]) | |||
| example = Module:Bananas | |||
| example-value = {{Lua|Module:Bananas|nocat=true}} | |||
| example3 = wish=true | |||
| example3-value = {{Lua|wish=true|nocat=true}} | |||
| seealso = | |||
* {{tld|Uses TemplateStyles}} | |||
* {{tld|Uses TNT}} | |||
| i18n-method = TNT | |||
| i18n-data-file = Lua banner | |||
| print = line | |||
| useTemplateData = only | |||
| 1 = 1 | |||
| 1label = Module 1 | |||
| 1d-en = Name of the main module used in the template. Use multiple parameters to specify multiple modules. | |||
| 1stat = suggested | |||
| 1type = wiki-page-name | |||
| 2 = 2 | |||
| 2label = Module 2 | |||
| 2d-en = Name of the second module. | |||
| 2stat = optional- | |||
| 2type = wiki-page-name | |||
| 3 = 3 | |||
| 3label = Module 3 | |||
| 3d-en = Name of the third module. | |||
| 3stat = optional- | |||
| 3type = wiki-page-name | |||
| 4 = 4 | |||
| 4label = Module 4 | |||
| 4d-en = Name of the fourth module. | |||
| 4stat = optional- | |||
| 4type = wiki-page-name | |||
| 5 = 5 | |||
| 5label = Module 5 | |||
| 5d-en = Name of the fifth module. | |||
| 5stat = optional- | |||
| 5type = wiki-page-name | |||
| 6 = 6 | |||
| 6label = Module 6 | |||
| 6d-en = Name of the sixth module. | |||
| 6stat = optional- | |||
| 6type = wiki-page-name | |||
| 7 = 7 | |||
| 7label = Module 7 | |||
| 7d-en = Name of the seventh module. | |||
| 7stat = optional- | |||
| 7type = wiki-page-name | |||
| 8 = 8 | |||
| 8label = Module 8 | |||
| 8d-en = Name of the eighth module. | |||
| 8stat = optional- | |||
| 8type = wiki-page-name | |||
| 9 = 9 | |||
| 9label = Module 9 | |||
| 9d-en = Name of the ninth module. | |||
| 9stat = optional- | |||
| 9type = wiki-page-name | |||
| 10 = 10 | |||
| 10label = Module 10 | |||
| 10d-en = Name of the tenth module. | |||
| 10stat = optional- | |||
| 10type = wiki-page-name | |||
| 11 = nocat | |||
| 11label = No Category? | |||
| 11d-en = Whether to disable categorization. | |||
| 11def = 0 | |||
| 11av = 1 | |||
| 11stat = optional- | |||
| 11type = boolean | |||
| 12 = category | |||
| 12label = Custom Category | |||
| 12def = {{#invoke:Data|Module:Lua banner/config|default_category}} | |||
| 12stat = optional- | |||
| 12type = string | |||
}} | }} | ||
<includeonly>[[Category:Internal link templates]]</includeonly> | <includeonly>{{Sandbox other|| | ||
<!-- Categories below this line; interwikis at Wikidata --> | |||
[[Category:Internal link templates]] | |||
}}</includeonly> | |||
Latest revision as of 20:39, 24 November 2024
| Uses Lua: |
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
- 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.
Wikipedia's help about TemplateData • Commons-specific information
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 | suggested |
| Module 10 | 10 | Name of the tenth module. | Page name | optional |
| 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 |
| Custom Category | category |
| String | optional |
| No Category? | nocat | Whether to disable categorization.
| Boolean | 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}}.
Example
{{Lua|Module:Bananas}}
renders as:
| Uses Lua: |
{{Lua|wish=true}}
renders as:
| This template should use Lua |
See also
- {{Uses TemplateStyles}}
- {{Uses TNT}}
Localization
This template is localized using Module:TNT. These translations are stored in Data:I18n/Lua banner.tab.