Template:Lua/Documentation: Difference between revisions

Template page
w:c:strategywiki>Prod
m (1 revision imported)
m (11 revisions imported: Imported from https://strategywiki.org/)
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Documentation subpage}}
This template is used to show that templates have been converted to [[wp:Lua (programming language)|Lua]]. It is placed at the top of the template's /doc page. It automatically adds the template to [[:Category:Templates using Lua modules]].
{{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.


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


== Examples ==
== Examples ==
* {{t|Lua|Module:Sandbox}}
{{Lua|Module:Sandbox|nocat=true}}
{{-}}


* {{tlx|Lua|Module:Bananas}}
* {{t|Lua|Module:Sandbox|Module:BananasArgs}}
{{Lua{{\sandbox}}|Module:Bananas|nocat=true}}
{{Lua|Module:Sandbox|Module:BananasArgs|nocat=true}}
{{clear}}
{{-}}
 
* {{tlx|Lua|Module:Bananas|Module:BananasArgs}}
{{Lua{{\sandbox}}|Module:Bananas|Module:BananasArgs|nocat=true}}
{{clear}}
 
* {{tlx|Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}
{{Lua{{\sandbox}}|Module:Bananas|Module:BananasArgs|Module:HelloWorld|nocat=true}}
{{clear}}
 
* {{tlx|Lua}}
{{Lua{{\sandbox}}|nocat=true}}
{{clear}}
 
== 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 {{para|category}} parameter, e.g. {{para|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]].
* [[Module:Math]] has the default category [[:Category:Templates based on the Math Lua module]].
* [[Module:BaseConvert]] has the default category [[:Category:Templates based on the BaseConvert Lua module]].
* [[Module:Citation]] and [[Module:Citation/CS1]] both have the default category [[:Category:Lua-based citation templates]].
 
===Error category===
If no modules are specified, the transcluded page will be added to [[:Category:Lua templates with errors]].


===Category suppression===
* {{t|Lua|Module:Sandbox|Module:BananasArgs|Module:HelloWorld}}
To suppress all categorisation, use {{para|nocat|true}}. (As well as "true", the values "yes", "y", and "1" will also work.)
{{Lua|Module:Sandbox|Module:BananasArgs|Module:HelloWorld|nocat=true}}
{{-}}


== See also ==
* {{t|Lua}}
* [[Wikipedia:Lua]]
{{Lua|nocat=true}}
* {{tl|module rating}}
{{-}}


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
<noinclude>[[Category:Template documentation]]</noinclude>
| <!-- Categories go here, and interwikis go on Wikidata. -->
[[Category:Wikipedia Lua templates| ]]
}}</includeonly>

Latest revision as of 18:27, 28 October 2023

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:Templates using Lua modules.

Usage[edit source]

Basic
{{Lua|module name}}
All parameters
{{Lua|module 1|module 2|module 3|nocat=true}}

Examples[edit source]

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