View source for Module:Template invocation/doc

This is a meta-module for producing MediaWiki template invocations.

== Usage ==

First load the module:

<syntaxhighlight lang="lua">
local mTemplateInvocation = require('Module:Template invocation')
</syntaxhighlight>

Then you can use the individual functions as documented below.

=== Name ===

<syntaxhighlight lang="lua">
mTemplateInvocation.name(title)
</syntaxhighlight>

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. <var>title</var> can be a string or a [[mw:Extension:Scribunto/Lua reference manual#Title objects|mw.title object]].

=== Invocation ===

<syntaxhighlight lang="lua">
mTemplateInvocation.invocation(name, args, format)
</syntaxhighlight>

This function creates a MediaWiki [[Help:Templates|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|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 [[w:HTML entities|HTML entities]].

'''Example'''

The code <syntaxhighlight lang=lua inline>mTemplateInvocation.invocation('foo', {'bar', 'baz', abc = 'def'})</syntaxhighlight> would produce <code><nowiki>{{foo|bar|baz|abc=def}}</nowiki></code>.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go here and interwikis go in Wikidata. -->

}}</includeonly>