Template:Lua/doc: Difference between revisions
(Created page with "{{Documentation subpage}} {{Lua|Module:Lua banner}} __NOTOC__ This template is used to indicate that a template uses one or more '''Lua''' modules (pages in the {{code|Module:}} namespace). It is placed at the top of the template's /doc page. It automatically adds a floating right notification box, and it adds the template to {{Cat|Lua-based templates}} or to one of its subcategories. == Usage == ; Basic : {{tlb|Lua|''Module:module name''}} ; All parameters : {{tlb|L...") |
mNo edit summary |
||
| Line 7: | Line 7: | ||
== Usage == | == Usage == | ||
; Basic : {{ | ; Basic : {{Pre|{{{{fcb|#4169e1|Lua}}|{{fcb|#2e8b57|Module:module name}}}} }} | ||
; All parameters : {{ | ; All parameters : {{Pre|{{{{fcb|#4169e1|Lua}}|{{fcb|#2e8b57|Module:}}{{font color|#933|module 1}}|{{fcb|#2e8b57|Module:}}{{font color|#933|module 2}}|{{fcb|#2e8b57|Module:}}{{font color|#933|module 3}}|...|{{fcb|#2e8b57|category}} {{=}} {{font color|#933|custom category}}|{{fcb|#2e8b57|nocat}} {{=}} {{font color|#933|true}}}} }} | ||
The first module name is required. | The first module name is required. | ||
| Line 43: | Line 43: | ||
== See also == | == See also == | ||
* {{tl|Uses TemplateStyles}} | * {{tl|Uses TemplateStyles}} | ||
* {{tl|Support Template}} | |||
== TemplateData == | == TemplateData == | ||
Revision as of 03:04, 18 June 2023
|
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 indicate that a template uses one or more Lua modules (pages in the Module: namespace). It is placed at the top of the template's /doc page. It automatically adds a floating right notification box, and it adds the template to Category:Lua-based templates or to one of its subcategories.
Usage
- Basic
{{Lua|Module:module name}}
- All parameters
{{Lua|Module:module 1|Module:module 2|Module: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:Templates based on the String Lua module.
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.)
See also
- {{Uses TemplateStyles}}
- {{Support Template}}
TemplateData
Creates a list of modules used by a template.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Module Name | 1 | The list of modules used by the template. | String | required |
| Category | category | To specify a different category. | String | optional |
| No Category | nocat | To stop it from automatically adding any categories.
| String | optional |