Difference between revisions of "Template:Lua/doc"
blackwiki>Mr. Stradivarius (→Examples: remove icononly from the examples) |
blackwiki>Mr. Stradivarius (→Categorisation: expand) |
||
| Line 30: | Line 30: | ||
== 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 | + | === 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]]: | Some modules have a default category other than [[:Category:Lua-based templates]]: | ||
| Line 36: | Line 38: | ||
* [[Module:Math]] has the default category [[:Category:Templates based on the Math Lua module]]. | * [[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:BaseConvert]] has the default category [[:Category:Templates based on the BaseConvert Lua module]]. | ||
| − | * [[Module:Citation] | + | * [[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 == | ||
Revision as of 11:26, 3 June 2014
| This is a documentation subpage for Template:Lua. It contains usage information, categories and other content that is not part of the original template page. |
| This template uses Lua: |
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.
Contents
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}}
| This template uses Lua: |
{{Lua|Module:Bananas|Module:BananasArgs}}
| This template uses Lua: |
{{Lua}}
| Error: no modules specified |
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:
- 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 |nocat=true. (As well as "true", the values "yes", "y", and "1" will also work.)
See also