Difference between revisions of "Template:Lua/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Mr. Stradivarius
(use nocat=true in the examples)
blackwiki>Mr. Stradivarius
(update with category parameter explanation)
Line 3: Line 3:
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
  
This template is used to show that templates have been converted to Lua. It can be placed on the template's /doc page or on its talk page. It automatically adds the template 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. To suppress categorisation explicitly, use {{para|nocat|true}}.
+
This template is used to show that templates have been converted to Lua. It can be placed on the template's /doc page or on its talk page. It automatically adds the template to [[:Category:Lua-based templates]].
  
 
== Usage ==
 
== Usage ==
{{tlx|lua|''module name''|''note''}}
+
 
 +
; Basic usage
 +
{{tlx|lua|''module name''}}
 +
 
 +
; All parameters
 +
{{tlx|lua|''module name''|''note''|4=category=''custom category''|5=nocat=''true''}}
  
 
== Examples ==
 
== Examples ==
Line 18: Line 23:
 
* {{tlx|lua|Module:Bananas|You can use this script as an example to help you get started.}}
 
* {{tlx|lua|Module:Bananas|You can use this script as an example to help you get started.}}
 
{{lua|Module:Bananas|You can use this script as an example to help you get started.|nocat=true}}
 
{{lua|Module:Bananas|You can use this script as an example to help you get started.|nocat=true}}
 +
 +
== Categorisation ==
 +
 +
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}}. To suppress categorisation, use {{para|nocat|true}}.
  
 
== See also ==
 
== See also ==

Revision as of 03:32, 20 July 2013

This template is used to show that templates have been converted to Lua. It can be placed on the template's /doc page or on its talk page. It automatically adds the template to Category:Lua-based templates.

Usage

Basic usage

{{lua|module name}}

All parameters

{{lua|module name|note|category=custom category|nocat=true}}

Examples

  • {{lua|Module:Bananas}}
  • {{lua|Module:Bananas|You can use this script as an example to help you get started.}}

Categorisation

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. To suppress categorisation, use |nocat=true.

See also