Module:Template invocation/doc: Difference between revisions
Content deleted Content added
start the documentation |
document the invocation function |
||
| Line 18: | Line 18: | ||
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]]. {{red|If <var>title</var> is a string, a mw.title object is created for it, which is [[WP:EXPENSIVE|expensive]].}} |
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]]. {{red|If <var>title</var> is a string, a mw.title object is created for it, which is [[WP:EXPENSIVE|expensive]].}} |
||
=== Invocation === |
|||
<source lang="lua"> |
|||
mTemplateInvocation.invocation(name, args, format) |
|||
</source> |
|||
This function creates a MediaWiki [[Help:Template|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 [[HTML entities]]. |
|||
'''Example''' |
|||
The code {{code|1=mTemplateInvocation.invocation('foo', {'bar', 'baz', abc = 'def'})|2=lua}} would produce <code><nowiki>{{foo|bar|baz|abc=def}}</nowiki></code>. |
|||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
||
Revision as of 03:56, 24 November 2014
This is a meta-module for producing MediaWiki template invocations.
Usage
First load the module:
local mTemplateInvocation = require('Module:Template invocation')
Then you can use the individual functions as documented below.
Name
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. If title is a string, a mw.title object is created for it, which is expensive.
Invocation
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}}.