Module:Template invocation/doc - Revision history

Mikhail Ryazanov: punct.

2024-02-11T00:24:12Z

punct.

← Previous revision		Revision as of 00:24, 11 February 2024
Line 7:		Line 7:
	== Usage ==		== Usage ==

	First load the module:		First, load the module:

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 32:		Line 32:

	Parameters:		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.		* '''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.		* '''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]].		* '''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\|\|

Mr. Guye at 08:11, 28 November 2022

2022-11-28T08:11:44Z

← Previous revision		Revision as of 08:11, 28 November 2022
Line 3:		Line 3:
	{{High-use\|demo=Module:Unsubst\|2=yes}}		{{High-use\|demo=Module:Unsubst\|2=yes}}

	{{Module rating\|~~templateprotected~~}}		{{Module rating\|p}}

	== Usage ==		== Usage ==

Mr. Guye at 08:07, 28 November 2022

2022-11-28T08:07:48Z

← Previous revision		Revision as of 08:07, 28 November 2022
Line 3:		Line 3:
	{{High-use\|demo=Module:Unsubst\|2=yes}}		{{High-use\|demo=Module:Unsubst\|2=yes}}

	{{Module rating\|~~template-protected~~}}		{{Module rating\|templateprotected}}

	== Usage ==		== Usage ==

Mr. Guye at 08:07, 28 November 2022

2022-11-28T08:07:28Z

← Previous revision		Revision as of 08:07, 28 November 2022
Line 3:		Line 3:
	{{High-use\|demo=Module:Unsubst\|2=yes}}		{{High-use\|demo=Module:Unsubst\|2=yes}}

	{{Module rating}}		{{Module rating\|template-protected}}

	== Usage ==		== Usage ==

Mr. Guye at 08:06, 28 November 2022

2022-11-28T08:06:27Z

← Previous revision		Revision as of 08:06, 28 November 2022
Line 2:		Line 2:

	{{High-use\|demo=Module:Unsubst\|2=yes}}		{{High-use\|demo=Module:Unsubst\|2=yes}}

			{{Module rating}}

	== Usage ==		== Usage ==

Mr. Guye at 07:48, 28 November 2022

2022-11-28T07:48:42Z

← Previous revision		Revision as of 07:48, 28 November 2022
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\|demo=Module:Unsubst\|2=yes}}

	== Usage ==		== Usage ==

Mr. Guye: Used by Module:Unsubst

2022-11-28T07:42:45Z

Used by Module:Unsubst

← Previous revision		Revision as of 07:42, 28 November 2022
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}}

	== Usage ==		== Usage ==

WOSlinker: change source to syntaxhighlight

2020-07-07T13:28:18Z

change source to syntaxhighlight

← Previous revision		Revision as of 13:28, 7 July 2020
Line 5:		Line 5:
	First load the module:		First load the module:

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	local mTemplateInvocation = require('Module:Template invocation')		local mTemplateInvocation = require('Module:Template invocation')
			</syntaxhighlight>
	</source>

	Then you can use the individual functions as documented below.		Then you can use the individual functions as documented below.
Line 13:		Line 13:
	=== Name ===		=== Name ===

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	mTemplateInvocation.name(title)		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]].		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:		Line 21:
	=== Invocation ===		=== Invocation ===

	<~~source~~ lang="lua">		<syntaxhighlight lang="lua">
	mTemplateInvocation.invocation(name, args, format)		mTemplateInvocation.invocation(name, args, format)
			</syntaxhighlight>
	</source>

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

Mr. Stradivarius: remove expensive function warning - this no longer applies

2016-12-15T01:51:54Z

remove expensive function warning - this no longer applies

← Previous revision		Revision as of 01:51, 15 December 2016
Line 17:		Line 17:
	</source>		</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]]. ~~{{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]].

	=== Invocation ===		=== Invocation ===

Mr. Stradivarius: document the invocation function

2014-11-24T03:56:26Z

document the invocation function

← Previous revision		Revision as of 03:56, 24 November 2014
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\|\|