Difference between revisions of "Template:Lua/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Mr. Stradivarius
(update)
m (37 revisions imported)
 
(24 intermediate revisions by 14 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
{{template shortcut|lua talk}}
+
{{Template shortcut|Lua talk}}
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
+
{{Lua|Module:Lua banner}}
 +
<!-- Categories go at the bottom of this page, and interwikis go on Wikidata. -->
 +
{{for|template to indicate [[Luba-Kasai language]] words|Template:Lang-lua}}
 +
This template is used to show that templates have been converted to [[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 [[Lua (programming language)|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 ==
+
; Basic : {{tlx|Lua|''module name''}}
  
; Basic usage
+
; All parameters : {{tlx|Lua|''module 1''|''module 2''|''module 3''|...|category{{=}}''custom category''|nocat{{=}}''true''}}
{{tlx|lua|''module name''}}
 
  
; All parameters
+
The first module name is required.
{{tlx|lua|''module 1''|''module 2''|''module 3''|''module 4''|''module 5''|7=category=''custom category''|8=nocat=''true''}}
 
  
 
== Examples ==
 
== Examples ==
  
* {{tlx|lua|Module:Bananas}}
+
* {{tlx|Lua|Module:Example}}
{{lua|Module:Bananas|nocat=true}}
+
{{Lua|Module:Example|nocat=true}}
 +
{{clear}}
 +
 
 +
* {{tlx|Lua|Module:Example|Module:Example}}
 +
{{Lua|Module:Example|Module:Example|nocat=true}}
 
{{clear}}
 
{{clear}}
  
* {{tlx|lua|Module:Bananas|Module:BananasArgs}}
+
* {{tlx|Lua}}
{{lua|Module:Bananas|Module:BananasArgs|nocat=true}}
+
{{Lua|nocat=true}}
 
{{clear}}
 
{{clear}}
  
 
== Categorisation ==
 
== 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}}.
+
===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}}.
 +
 
 +
Some modules have a default category other than [[:Category:Lua-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===
 +
If no modules are specified, the transcluded page will be added to [[:Category:Lua templates with errors]].
 +
 
 +
===Category suppression===
 +
To suppress all categorisation, use {{para|nocat|true}}. (As well as "true", the values "yes", "y", and "1" will also work.)
  
 
== See also ==
 
== See also ==
Line 31: Line 49:
 
* {{tl|module rating}}
 
* {{tl|module rating}}
  
<includeonly>
+
<includeonly>{{Sandbox other|
<!-- Categories go here, and interwikis go in Wikidata -->
+
| <!-- Categories go here, and interwikis go on Wikidata. -->
[[Category:Wikipedia Lua templates]]
+
[[Category:Lua-based templates| ]]
 
+
[[Category:Template namespace templates]]
</includeonly>
+
}}</includeonly>

Latest revision as of 11:24, 22 September 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:Example}}
  • {{Lua|Module:Example|Module:Example}}

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