Template:Lua/doc

From RimWorld Wiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

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|Module:Bananas|Module:BananasArgs}}


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



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 {{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]].

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