Module:Template invocation/doc: Difference between revisions
From Neodyland Wiki
More actions
No edit summary |
m 12 revisions imported |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
This is a meta-module for producing MediaWiki template invocations. | This is a meta-module for producing MediaWiki template invocations. | ||
{{High-use | {{High-use}} | ||
{{Module rating|p}} | |||
== Usage == | == Usage == | ||
First load the module: | First, load the module: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
| Line 30: | Line 32: | ||
Parameters: | Parameters: | ||
* '''name''' | * '''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''' | * '''args''' – the arguments to use in the invocation (table, required). Table keys and values must be either strings or numbers. | ||
* '''format''' | * '''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''' | '''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>. | 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|| | ||
Latest revision as of 16:09, 12 August 2026
This is a meta-module for producing MediaWiki template invocations.
This template is being used in the wrong namespace. Use {{Heavily used module}} instead!
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
Usage
editFirst, load the module:
local mTemplateInvocation = require('Module:Template invocation')
Then you can use the individual functions as documented below.
Name
editmTemplateInvocation.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
editmTemplateInvocation.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}}.