Difference between revisions of "Template:Lua/doc"

From RimWorld Wiki
Jump to navigation Jump to search
 
Line 1: Line 1:
 
+
{{Rewrite|reason=Lots of bad links that have been disabled to remove them from wanted pages, but the documentation needs to be updated to see what is actually necessary.}}
 
<!-- Categories go at the bottom of this page, and interwikis go on 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. 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. It is placed at the top of the template's /doc page. It automatically adds the template to <nowiki>[[:Category:Lua-based templates]]</nowiki>, or to one of its subcategories.
  
 
== Usage ==
 
== Usage ==

Latest revision as of 23:35, 4 April 2023

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[edit]

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[edit]

  • {{Lua|Module:Bananas}}


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


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



Categorisation[edit]

Template category[edit]

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[edit]

If no modules are specified, the transcluded page will be added to [[:Category:Lua templates with errors]].

Category suppression[edit]

To suppress all categorisation, use {{para|nocat|true}}. (As well as "true", the values "yes", "y", and "1" will also work.)

See also[edit]