Module:Template invocation
.svg/60px-Test_Template_Info-Icon_-_Version_(2).svg.png){kind=icon}
This is a meta-module for producing MediaWiki template invocations.
 | This Lua module is used on 13,600,000+ pages, or roughly 22% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
 | 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
First, load the module:
localmTemplateInvocation=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}}.
-- This module provides functions for making MediaWiki template invocations.localcheckType=require('libraryUtil').checkTypelocalp={}-------------------------------------------------------------------------- Name: p.name-- Purpose: Find a template invocation name from a page name or a-- mw.title object.-- Description: This function detects whether a string or a mw.title-- object has been passed in, and uses that to find a-- template name as it is used in template invocations.-- Parameters: title - full page name or mw.title object for the-- template (string or mw.title object)-- Returns: String------------------------------------------------------------------------functionp.name(title)iftype(title)=='string'thentitle=mw.title.new(title)ifnottitleor#title.prefixedText==0or#title.interwiki>0thenerror("invalid title in parameter #1 of function 'name'",2)endelseiftype(title)~='table'ortype(title.getContent)~='function'thenerror("parameter #1 of function 'name' must be a string or a mw.title object",2)endiftitle.namespace==10thenlocaltext=title.textlocalcheck=mw.title.new(text,10)-- Exclude the prefix, unless we have something like "Template:Category:Foo", which can't be abbreviated to "Category:Foo".returncheckandmw.title.equals(title,check)andtextortitle.prefixedTextelseiftitle.namespace==0thenreturn':'..title.prefixedTextelsereturntitle.prefixedTextendend-------------------------------------------------------------------------- Name: p.invocation-- Purpose: Construct a MediaWiki template invocation.-- Description: This function makes a template invocation from the-- name and the arguments given. Note that it isn't-- perfect: we have no way of knowing what whitespace was-- in the original invocation, the named parameters will be-- alphabetically sorted, and any parameters with duplicate keys-- will be removed.-- Parameters: name - the template name, formatted as it will appear-- in the invocation. (string)-- args - a table of template arguments. (table)-- format - formatting options. (string, optional)-- Set to "nowiki" to escape, curly braces, pipes and-- equals signs with their HTML entities. The default-- is unescaped.-- Returns: String------------------------------------------------------------------------functionp.invocation(name,args,format)checkType('invocation',1,name,'string')checkType('invocation',2,args,'table')checkType('invocation',3,format,'string',true)-- Validate the args table and make a copy to work from. We need to-- make a copy of the table rather than just using the original, as-- some of the values may be erased when building the invocation.localinvArgs={}fork,vinpairs(args)dolocaltypek=type(k)localtypev=type(v)iftypek~='string'andtypek~='number'ortypev~='string'andtypev~='number'thenerror("invalid arguments table in parameter #2 of ".."'invocation' (keys and values must be strings or numbers)",2)endinvArgs[k]=vend-- Get the separators to use.localseps={openb='{{',closeb='}}',pipe='|',equals='='}ifformat=='nowiki'thenfork,vinpairs(seps)doseps[k]=mw.text.nowiki(v)endend-- Build the invocation body with numbered args first, then named.localret={}ret[#ret+1]=seps.openbret[#ret+1]=namefork,vinipairs(invArgs)doiftype(v)=='string'andv:find('=',1,true)then-- Likely something like 1=foo=bar which needs to be displayed as a named arg.elseret[#ret+1]=seps.piperet[#ret+1]=vinvArgs[k]=nil-- Erase the key so that we don't add the value twiceendendlocalkeys={}-- sort parameter list; better than arbitrary orderfork,_inpairs(invArgs)dokeys[#keys+1]=kendtable.sort(keys,function(a,b)-- Sort with keys of type number first, then string.iftype(a)==type(b)thenreturna<belseiftype(a)=='number'thenreturntrueendend)localmaybeSpace=''-- First named parameter should not be separated by a spacefor_,vinipairs(keys)do-- Add named args based on sorted parameter listret[#ret+1]=maybeSpace..seps.piperet[#ret+1]=tostring(v)ret[#ret+1]=seps.equalsret[#ret+1]=invArgs[v]maybeSpace=' 'endret[#ret+1]=seps.closebreturntable.concat(ret)endreturnp