Module:Template invocation/doc: Difference between revisions

Revision as of 01:51, 15 December 2016

Revision as of 13:28, 7 July 2020

Line 5:

First load the module:

<sourcesyntaxhighlight lang="lua">

local mTemplateInvocation = require('Module:Template invocation')

</syntaxhighlight>

</source>

Then you can use the individual functions as documented below.

Line 13:

=== Name ===

<sourcesyntaxhighlight lang="lua">

mTemplateInvocation.name(title)

</syntaxhighlight>

</source>

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

Line 21:

=== Invocation ===

<sourcesyntaxhighlight lang="lua">

mTemplateInvocation.invocation(name, args, format)

</syntaxhighlight>

</source>

This function creates a MediaWiki [[Help:Template|template]] invocation.