Difference between revisions of "Template:Lua/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Sardanaphalus
m (ditto)
blackwiki>Sardanaphalus
(added example (three parameters))
Line 10: Line 10:
 
; Basic : {{tlx|Lua|''module name''}}
 
; Basic : {{tlx|Lua|''module name''}}
  
; All parameters : {{tlx|lua|''module 1''|''module 2''|''module 3''|...|category{{=}}''custom category''|nocat{{=}}''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 22: Line 22:
 
* {{tlx|Lua|Module:Bananas|Module:BananasArgs}}
 
* {{tlx|Lua|Module:Bananas|Module:BananasArgs}}
 
{{Lua{{ifsandbox}}|Module:Bananas|Module:BananasArgs|nocat=true}}
 
{{Lua{{ifsandbox}}|Module:Bananas|Module:BananasArgs|nocat=true}}
 +
{{clear}}
 +
 +
* {{tlx|Lua|Module:Bananas|Module:BananasArgs|Module:HelloWorld}}
 +
{{Lua{{ifsandbox}}|Module:Bananas|Module:BananasArgs|Module:HelloWorld|nocat=true}}
 
{{clear}}
 
{{clear}}
  
Line 30: Line 34:
 
== Categorisation ==
 
== Categorisation ==
  
=== 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 {{para|category}} parameter, e.g. {{para|category|Lua String-based templates}}.
  
Line 40: Line 43:
 
* [[Module:Citation]] and [[Module:Citation/CS1]] both have the default category [[:Category:Lua-based citation templates]].
 
* [[Module:Citation]] and [[Module:Citation/CS1]] both have the default category [[:Category:Lua-based citation templates]].
  
=== Error category ===
+
===Error category===
 
 
 
If no modules are specified, the transcluded page will be added to [[:Category:Lua templates with errors]].
 
If no modules are specified, the transcluded page will be added to [[:Category:Lua templates with errors]].
  
=== 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.)
  

Revision as of 23:22, 30 August 2014

{{LuaTemplate:Ifsandbox|Module:Lua banner}}

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

{{LuaTemplate:Ifsandbox|Module:Bananas|nocat=true}}

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

{{LuaTemplate:Ifsandbox|Module:Bananas|Module:BananasArgs|nocat=true}}

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

{{LuaTemplate:Ifsandbox|Module:Bananas|Module:BananasArgs|Module:HelloWorld|nocat=true}}

{{LuaTemplate:Ifsandbox|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 |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.)

See also