Module:Template invocation/doc
 | This is a documentation subpage for Module:Template invocation. It may contain usage information, categories and other content that is not part of the original module page. |
This is a meta-module for producing MediaWiki template invocations.
 | This Lua module is used on approximately 3,200 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
 | This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
Usage
[edit]First, load the module:
local mTemplateInvocation = require('Module:Template invocation')
Then you can use the individual functions as documented below.
Name
[edit]mTemplateInvocation.name(title)
This function produces the name to be used in a template invocation. For pages in the template namespace it returns the page name with no namespace prefix, for pages in the main namespace it returns the full page name prefixed with ":", and for other pages it returns the full page name. title can be a string or a mw.title object.
Invocation
[edit]mTemplateInvocation.invocation(name, args, format)
This function creates a MediaWiki template invocation.
Parameters:
- name – the name of the template (string, required). This should be exactly as it will appear in the invocation, e.g. for Template:Example use "Example". To generate the template name from a page name, you can use the name function.
- args – the arguments to use in the invocation (table, required). Table keys and values must be either strings or numbers.
- format – the format of the invocation (string, optional). The default is a normal invocation with unescaped curly braces, pipes, and equals signs. If this parameter is the string "nowiki", then the curly braces, pipes and equals signs are replaced with the appropriate HTML entities.
Example
The code mTemplateInvocation.invocation('foo', {'bar', 'baz', abc = 'def'}) would produce {{foo|bar|baz |abc=def}}.