Difference between revisions of "Template:Lua/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>علیرضا
blackwiki>Mr. Stradivarius
(update after switch to Module:Lua banner)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
{{lua|Module:Lua banner}}
 
{{Template shortcut|Lua talk}}
 
{{Template shortcut|Lua talk}}
<!-----Categories where indicated at the bottom of this page, please; interwikis to Wikidata----->
+
<!-- Categories go at the bottom of this page, and interwikis go on Wikidata. -->
  
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]].
+
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.
  
 
== Usage ==
 
== Usage ==
Line 9: Line 10:
 
; Basic : {{tlx|Lua|''module name''}}
 
; Basic : {{tlx|Lua|''module name''}}
  
; All parameters : {{tlx|Lua|icononly{{=}}''on''|''module 1''|''module 2''|''module 3''|''module 4''|''module 5''|category{{=}}''custom category''|nocat{{=}}''true''}}
+
; All parameters : {{tlx|lua|''module 1''|''module 2''|''module 3''|...|category{{=}}''custom category''|nocat{{=}}''true''}}
  
(Setting {{para|icononly}} as "on", "true", "yes", etc, suppresses the "Uses Lua:" text. [[Wikipedia:Lua]] may still be accessed by clicking on the logo.)
+
The first module name is required.
  
 
== Examples ==
 
== Examples ==
  
{{Lua|nocat=true}}
+
* {{tlx|Lua|Module:Bananas}}
* {{tlx|Lua}}
 
{{clear}}
 
 
{{Lua|Module:Bananas|nocat=true}}
 
{{Lua|Module:Bananas|nocat=true}}
* {{tlx|Lua|Module:Bananas}}
 
 
{{clear}}
 
{{clear}}
  
 +
* {{tlx|Lua|icononly{{=}}on|Module:Bananas|Module:BananasArgs}}
 
{{Lua|icononly=on|Module:Bananas|Module:BananasArgs|nocat=true}}
 
{{Lua|icononly=on|Module:Bananas|Module:BananasArgs|nocat=true}}
* {{tlx|Lua|icononly{{=}}on|Module:Bananas|Module:BananasArgs}}
+
{{clear}}
 +
 
 +
* {{tlx|Lua}}
 +
{{Lua|nocat=true}}
 
{{clear}}
 
{{clear}}
  
Line 29: Line 31:
  
 
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}}.
 
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}}.
 +
 +
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] has the default category [[:Category:Lua-based citation templates]].
  
 
== See also ==
 
== See also ==
Line 36: Line 44:
 
<includeonly>
 
<includeonly>
 
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-----Categories below here, please; interwikis to Wikidata----->
+
<!-- Categories go here, and interwikis go on Wikidata. -->
 
[[Category:Wikipedia Lua templates| ]]
 
[[Category:Wikipedia Lua templates| ]]
 
}}
 
}}
 
</includeonly>
 
</includeonly>

Revision as of 07:14, 3 June 2014

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}}
  • {{Lua|icononly=on|Module:Bananas|Module:BananasArgs}}

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.

Some modules have a default category other than Category:Lua-based templates:

See also