Template:Lua/Documentation: Difference between revisions

Template page
w:c:strategywiki>Prod
m (fix link)
m (11 revisions imported: Imported from https://strategywiki.org/)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
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:Lua-based templates]], or to one of its subcategories.
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]].


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


== Examples ==
== Examples ==
* {{t|Lua|Module:Sandbox}}
* {{t|Lua|Module:Sandbox}}
{{Lua|Module:Sandbox|nocat=true}}
{{Lua|Module:Sandbox|nocat=true}}
Line 25: Line 21:
{{Lua|nocat=true}}
{{Lua|nocat=true}}
{{-}}
{{-}}
== 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 <tt>|category</tt> parameter, e.g. <tt>|category=Lua String-based templates</tt>.
Some modules have a default category other than [[:Category:Lua-based templates]]:
* [[Module:String]] has the default category [[:Category:Lua String-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 <tt>|nocat=true</tt>. (As well as "true", the values "yes", "y", and "1" will also work.)


<noinclude>[[Category:Template documentation]]</noinclude>
<noinclude>[[Category:Template documentation]]</noinclude>

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