Template:Lua/Documentation: Difference between revisions

Template page
w:c:strategywiki>Prod
m (fix link)
w:c:strategywiki>Prod
m (fix links)
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]], or to one of its subcategories.


== Usage ==
== Usage ==
Line 29: Line 29:


===Template category===
===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>.
This template adds pages to [[:Category:Templates using Lua modules]] 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]]:
Some modules have a default category other than [[:Category:Templates using Lua modules]]:
* [[Module:String]] has the default category [[:Category:Lua String-based templates]].
* [[Module:String]] has the default category [[:Category:Templates using the String Lua module]].


===Error category===
===Error category===

Revision as of 16:16, 1 November 2022

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, 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:Sandbox}}
  • {{Lua|Module:Sandbox|Module:BananasArgs}}
  • {{Lua|Module:Sandbox|Module:BananasArgs|Module:HelloWorld}}

Categorisation

Template category

This template adds pages to Category:Templates using Lua modules 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:Templates using Lua modules:

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.)