Template:Lua/Documentation: Difference between revisions

Template page
w:c:strategywiki>Prod
m (Prod moved page Template:Lua/doc to Template:Lua/Documentation without leaving a redirect)
w:c:strategywiki>Prod
(some cleanup, needs mroe)
Line 1: Line 1:
{{Documentation subpage}}
{{Template shortcut|Lua talk}}
{{Lua{{\sandbox}}|Module:Lua banner}}
<!-- Categories go at the bottom of this page, and interwikis go on Wikidata. -->
{{for|template to indicate [[Luba-Kasai language]] words|Template:Lang-lua}}
This template is used to show that templates have been converted to [[Lua (programming language)|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.
This template is used to show that templates have been converted to [[Lua (programming language)|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 ==
== Usage ==


; Basic : {{tlx|Lua|''module name''}}
; Basic : {{t|Lua|''module name''}}
 
; All parameters : {{t|Lua|''module 1''|''module 2''|''module 3''|...|category&#61;''custom category''|nocat&#61;''true''}}
; All parameters : {{tlx|Lua|''module 1''|''module 2''|''module 3''|...|category{{=}}''custom category''|nocat{{=}}''true''}}


The first module name is required.
The first module name is required.
Line 16: Line 10:
== Examples ==
== Examples ==


* {{tlx|Lua|Module:Bananas}}
* {{t|Lua|Module:Bananas}}
{{Lua{{\sandbox}}|Module:Bananas|nocat=true}}
{{Lua|Module:Bananas|nocat=true}}
{{clear}}
{{~}}


* {{tlx|Lua|Module:Bananas|Module:BananasArgs}}
* {{t|Lua|Module:Bananas|Module:BananasArgs}}
{{Lua{{\sandbox}}|Module:Bananas|Module:BananasArgs|nocat=true}}
{{Lua|Module:Bananas|Module:BananasArgs|nocat=true}}
{{clear}}
{{~}}


* {{tlx|Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}
* {{t|Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}
{{Lua{{\sandbox}}|Module:Bananas|Module:BananasArgs|Module:HelloWorld|nocat=true}}
{{Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld|nocat=true}}
{{clear}}
{{~}}


* {{tlx|Lua}}
* {{t|Lua}}
{{Lua{{\sandbox}}|nocat=true}}
{{Lua|nocat=true}}
{{clear}}
{{~}}


== Categorisation ==
== Categorisation ==
Line 48: Line 42:
===Category suppression===
===Category suppression===
To suppress all categorisation, use {{para|nocat|true}}. (As well as "true", the values "yes", "y", and "1" will also work.)
To suppress all categorisation, use {{para|nocat|true}}. (As well as "true", the values "yes", "y", and "1" will also work.)
== See also ==
* [[Wikipedia:Lua]]
* {{tl|module rating}}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- Categories go here, and interwikis go on Wikidata. -->
[[Category:Wikipedia Lua templates| ]]
}}</includeonly>

Revision as of 21:02, 9 December 2019

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:Bananas}}

Template:~

  • {{Lua|Module:Bananas|Module:BananasArgs}}

Template:~

  • {{Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}

Template:~

Template:~

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 Template:Para parameter, e.g. Template:Para.

Some modules have a default category other than Category:Lua-based 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 Template:Para. (As well as "true", the values "yes", "y", and "1" will also work.)