Module:Template invocation/doc: Difference between revisions
From Kenshi Wiki
More actions
Created page with "This is a meta-module for producing MediaWiki template invocations. {{High-use|demo=Module:Unsubst|2=yes}} {{Module rating|p}} == 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 t..." |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{doc sub}} | |||
This is a meta-module for producing MediaWiki template invocations. | This is a meta-module for producing MediaWiki template invocations. | ||
== Usage == | == Usage == | ||
| Line 42: | Line 38: | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
<!-- Categories go here and interwikis go in Wikidata. --> | <!-- Categories go here and interwikis go in Wikidata. --> | ||
[[Category:Modules]] | |||
}}</includeonly> | }}</includeonly><noinclude> | ||
[[Category:Module documents]] | |||
</noinclude> | |||
Latest revision as of 01:11, 10 March 2025
 | 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.
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.
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}}.