Template:Lua/Documentation: Difference between revisions

Template page
w:c:strategywiki>Prod
m (category)
w:c:strategywiki>Prod
(cleanup)
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 {{para|category}} parameter, e.g. {{para|category|Lua String-based templates}}.
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]]:
Some modules have a default category other than [[:Category:Lua-based templates]]:
* [[Module:String]] has the default category [[:Category:Lua String-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===
===Error category===
Line 41: Line 38:


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

Revision as of 19:00, 2 January 2020

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 |category parameter, e.g. |category=Lua String-based templates.

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 |nocat=true. (As well as "true", the values "yes", "y", and "1" will also work.)