Template:Lua/doc

This template is used to indicate that a template uses one or more Lua modules (pages in the  namespace). It is placed at the top of the template's /doc page. It automatically adds a floating right notification box, and it adds the template to Category:Lua-based templates or to one of its subcategories.

Usage

 * Basic :


 * All parameters :

The first module name is required.

Examples






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. Lua String-based templates.

Some modules have a default category other than Category:Lua-based templates:
 * Module:String has the default category Category:Templates based on the String 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:Citation and Module:Citation/CS1 both have the default category Category:Templates based on the Citation/CS1 Lua module.

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 true. (As well as "true", the values "yes", "y", and "1" will also work.)