Module:Template wrapper/doc - Revision history

Cedar101: /* Usage */ monospace

2025-02-04T06:45:06Z

Usage: monospace

← Previous revision		Revision as of 06:45, 4 February 2025
Line 31:		Line 31:
	:default parameter – a canonical parameter given a default value in the wrapper template		:default parameter – a canonical parameter given a default value in the wrapper template

	{\| class="nowrap"		{\| class="nowrap" style="font-family:monospace"
	\|+parameter processing		\|+parameter processing
	!style="border:1px solid black"\|wrapper<br />template !! !!style="border:1px solid black" colspan="11"\|Module:Template wrapper !! !! style="border:1px solid black"\|working<br />template		!style="border:1px solid black"\|wrapper<br />template !! !!style="border:1px solid black" colspan="11"\|Module:Template wrapper !! !! style="border:1px solid black"\|working<br />template

Nardog: _ is stripped

2024-12-31T07:17:31Z

_ is stripped

Trappist the monk: /* _reuse */

2024-12-30T15:34:06Z

_reuse

← Previous revision		Revision as of 15:34, 30 December 2024
Line 77:		Line 77:

	===_reuse===		===_reuse===
	{{para\|_reuse}} takes a comma-separated list of canonical parameters that have meaning to both the wrapper template and to the working template		{{para\|_reuse}} takes a comma-separated list of canonical parameters that have meaning to both the wrapper template and to the working template; not supported for positional parameters.

	In the simplest cases, a canonical parameter passed into the wrapper template overrides a default parameter provided in the wrapper template. Sometimes a wrapper parameter is the same as a canonical parameter and the wrapper template needs to modify the parameter value before it is passed to the working template. In this example, {{para\|title}} is both a wrapper parameter and a canonical parameter that the wrapper template needs to modify before passing to the working template. To do this we first write:		In the simplest cases, a canonical parameter passed into the wrapper template overrides a default parameter provided in the wrapper template. Sometimes a wrapper parameter is the same as a canonical parameter and the wrapper template needs to modify the parameter value before it is passed to the working template. In this example, {{para\|title}} is both a wrapper parameter and a canonical parameter that the wrapper template needs to modify before passing to the working template. To do this we first write:

Grufo at 01:25, 3 October 2024

2024-10-03T01:25:32Z

← Previous revision		Revision as of 01:25, 3 October 2024
Line 3:		Line 3:
	{{high-use}}		{{high-use}}

	'' See also: {{mfl\|params\|concat_and_call}}''		: ''See also: {{mfl\|params\|concat_and_call}}''

	This module is to be used in [[Wikipedia:Wrapper templates\|wrapper templates]] to allow those templates to provide default parameter values and allow editors to pass additional parameters to the underlying working template.		This module is to be used in [[Wikipedia:Wrapper templates\|wrapper templates]] to allow those templates to provide default parameter values and allow editors to pass additional parameters to the underlying working template.

Grufo at 13:46, 1 October 2024

2024-10-01T13:46:02Z

← Previous revision		Revision as of 13:46, 1 October 2024
Line 3:		Line 3:
	{{high-use}}		{{high-use}}

	{{See also~~\|Module~~:~~Params~~}}		'' See also: {{mfl\|params\|concat_and_call}}''

	This module is to be used in [[Wikipedia:Wrapper templates\|wrapper templates]] to allow those templates to provide default parameter values and allow editors to pass additional parameters to the underlying working template.		This module is to be used in [[Wikipedia:Wrapper templates\|wrapper templates]] to allow those templates to provide default parameter values and allow editors to pass additional parameters to the underlying working template.

Grufo: see also

2024-10-01T13:42:35Z

BrandonXLF: /* Debugging/documentation mode */ Add Category:Template metamodules

2024-09-02T21:19:46Z

Debugging/documentation mode: Add Category:Template metamodules

← Previous revision		Revision as of 21:19, 2 September 2024
Line 129:		Line 129:
	<includeonly>{{sandbox other\|\|		<includeonly>{{sandbox other\|\|
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->
			[[Category:Template metamodules]]

	}}</includeonly>		}}</includeonly>

ShakespeareFan00 at 22:09, 2 May 2023

2023-05-02T22:09:12Z

← Previous revision		Revision as of 22:09, 2 May 2023
Line 111:		Line 111:

	As an example, {{tlx\|cite wikisource}} is a wrapper template that uses {{tlx\|citation}} as its working template. {{tld\|cite wikisource}} accepts positional parameters but {{tld\|citation}} does not so the wrapper template must convert the positional parameters to named parameters which it does using the {{para\|_alias-map}} parameter:		As an example, {{tlx\|cite wikisource}} is a wrapper template that uses {{tlx\|citation}} as its working template. {{tld\|cite wikisource}} accepts positional parameters but {{tld\|citation}} does not so the wrapper template must convert the positional parameters to named parameters which it does using the {{para\|_alias-map}} parameter:
	:<syntaxhighlight lang="~~moin~~">{{#invoke:template wrapper\|{{#if:{{{_debug\|}}}\|list\|wrap}}\|_template=citation		:<syntaxhighlight lang="wikitext">{{#invoke:template wrapper\|{{#if:{{{_debug\|}}}\|list\|wrap}}\|_template=citation
	\|_exclude=..., _debug <!-- unnecessary detail omitted -->		\|_exclude=..., _debug <!-- unnecessary detail omitted -->
	\|_alias-map=1:title, 2:author, 3:language</syntaxhighlight>		\|_alias-map=1:title, 2:author, 3:language</syntaxhighlight>

GKFX: Add template high-use

2021-05-08T08:02:46Z

Add template high-use

← Previous revision		Revision as of 08:02, 8 May 2021
Line 1:		Line 1:
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

			{{high-use}}

	This module is to be used in [[Wikipedia:Wrapper templates\|wrapper templates]] to allow those templates to provide default parameter values and allow editors to pass additional parameters to the underlying working template.		This module is to be used in [[Wikipedia:Wrapper templates\|wrapper templates]] to allow those templates to provide default parameter values and allow editors to pass additional parameters to the underlying working template.

GKFX: /* Debugging aid */ Document the "link" function.

2021-05-07T16:53:14Z

Debugging aid: Document the "link" function.

← Previous revision		Revision as of 16:53, 7 May 2021
Line 103:		Line 103:
	_reused parameters cannot be <code>unset</code> or overridden.		_reused parameters cannot be <code>unset</code> or overridden.

	==Debugging ~~aid~~==		==Debugging/documentation mode==
	This module has two entry points. A wrapper template might use a module <code><nowiki>{{#invoke:}}</nowiki></code> written like this:		This module has two entry points. A wrapper template might use a module <code><nowiki>{{#invoke:}}</nowiki></code> written like this:
	:<code><nowiki>{{#invoke:</nowiki>{{BASEPAGENAME}}\|<nowiki>{{#if:{{{_debug\|}}}\|list\|wrap}}</nowiki>\|_template=<{{var\|working template}}>\|_exclude=_debug, ...\|...}}</code>		:<code><nowiki>{{#invoke:</nowiki>{{BASEPAGENAME}}\|<nowiki>{{#if:{{{_debug\|}}}\|list\|wrap}}</nowiki>\|_template=<{{var\|working template}}>\|_exclude=_debug, ...\|...}}</code>
Line 119:		Line 119:
	::{{cite wikisource\|Sentido y sensibilidad\|Jane Austen\|es\|_debug=}}		::{{cite wikisource\|Sentido y sensibilidad\|Jane Austen\|es\|_debug=}}
	The {{para\|_debug}} name is chosen here for convenience but may be anything so long as it matches the <code><nowiki>{{#if:}}</nowiki></code> in the <code><nowiki>{{#invoke:}}</nowiki></code>.		The {{para\|_debug}} name is chosen here for convenience but may be anything so long as it matches the <code><nowiki>{{#if:}}</nowiki></code> in the <code><nowiki>{{#invoke:}}</nowiki></code>.

			You may also call the <code>link</code> function to get something like the left-hand side of [[Template:yy]]. This is essentially the <code>list</code> function with the template name turned into a link.
			{{yytop\|headers=no}}
			{{yy\|User in New Zealand\|4}}
			{{yybottom}}

	<includeonly>{{sandbox other\|\|		<includeonly>{{sandbox other\|\|
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->

← Previous revision		Revision as of 13:42, 1 October 2024
Line 2:		Line 2:

	{{high-use}}		{{high-use}}

			{{See also\|Module:Params}}

	This module is to be used in [[Wikipedia:Wrapper templates\|wrapper templates]] to allow those templates to provide default parameter values and allow editors to pass additional parameters to the underlying working template.		This module is to be used in [[Wikipedia:Wrapper templates\|wrapper templates]] to allow those templates to provide default parameter values and allow editors to pass additional parameters to the underlying working template.

← Previous revision		Revision as of 07:17, 31 December 2024
Line 39:		Line 39:
	\| style="border: 1px solid black;"\|{{para\|plain=yes\|{{var\|wrapper parameters}}}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| →		\| style="border: 1px solid black;"\|{{para\|plain=yes\|{{var\|wrapper parameters}}}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| →
	\|-		\|-
	\| \|\| \|\| style="border: 1px solid black;"\|{{para\|plain=yes\|[[#~~_exclude~~\|_exclude]]}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\| →		\| \|\| \|\| style="border: 1px solid black;"\|{{para\|plain=yes\|[[#exclude\|_exclude]]}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\| →
	\|-		\|-
	\| \|\| \|\| style="border: 1px solid black;"\|{{para\|plain=yes\|[[#~~_include~~-positional\|_include-positional]]}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| →		\| \|\| \|\| style="border: 1px solid black;"\|{{para\|plain=yes\|[[#include-positional\|_include-positional]]}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| →
	\|-		\|-
	\| \|\| \|\| style="border: 1px solid black;"\|{{para\|plain=yes\|[[#~~_alias~~-map\|_alias-map]]}}\|\| → \|\|style="border: 2px solid black;" rowspan="3"\|convert alias<br />parameters to<br />canonical<br />parameters\|\| → \|\|style="border: 1px solid black;" rowspan="2"\|{{para\|plain=yes\|{{var\|canonical parameters}}}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\| \|\| →		\| \|\| \|\| style="border: 1px solid black;"\|{{para\|plain=yes\|[[#alias-map\|_alias-map]]}}\|\| → \|\|style="border: 2px solid black;" rowspan="3"\|convert alias<br />parameters to<br />canonical<br />parameters\|\| → \|\|style="border: 1px solid black;" rowspan="2"\|{{para\|plain=yes\|{{var\|canonical parameters}}}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\| \|\| →
	\|-		\|-
	\| \|\| \|\| \|\| \|\| → \|\| → \|\|style="border: 2px solid black;" rowspan="4"\|modify<br />reused<br />canonical<br />parameters		\| \|\| \|\| \|\| \|\| → \|\| → \|\|style="border: 2px solid black;" rowspan="4"\|modify<br />reused<br />canonical<br />parameters
Line 49:		Line 49:
	\| style="border: 1px solid black;"\|{{para\|plain=yes\|{{var\|alias parameters}}}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\| \|\| \|\| \|\| → \|\|style="border: 1px solid black;"\|{{para\|plain=yes\|{{var\|reused parameters}}}}\|\| → \|\|style="text-align: center;"\|–––→\|\| →		\| style="border: 1px solid black;"\|{{para\|plain=yes\|{{var\|alias parameters}}}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\| \|\| \|\| \|\| → \|\|style="border: 1px solid black;"\|{{para\|plain=yes\|{{var\|reused parameters}}}}\|\| → \|\|style="text-align: center;"\|–––→\|\| →
	\|-		\|-
	\| \|\| \|\| style="border: 1px solid black;"\|{{para\|plain=yes\|[[#~~_reuse~~\|_reuse]]}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| →		\| \|\| \|\| style="border: 1px solid black;"\|{{para\|plain=yes\|[[#reuse\|_reuse]]}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| →
	\|-		\|-
	\| style="border: 1px solid black;"\|{{para\|plain=yes\|{{var\|canonical parameters}}}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| →		\| style="border: 1px solid black;"\|{{para\|plain=yes\|{{var\|canonical parameters}}}}\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| → \|\|style="text-align: center;"\|–––––––→\|\| →
Line 100:		Line 100:
	{{para\|_include-positional}} is a boolean parameter that takes only one value: <code>yes</code>; the default (empty, missing) is <code>no</code> (positional parameters normally excluded). When set to <code>yes</code>, Module:Template wrapper will pass all positional parameters to the working template.		{{para\|_include-positional}} is a boolean parameter that takes only one value: <code>yes</code>; the default (empty, missing) is <code>no</code> (positional parameters normally excluded). When set to <code>yes</code>, Module:Template wrapper will pass all positional parameters to the working template.

	See also §[[#~~_alias~~-map\|_alias-map]].		See also §[[#alias-map\|_alias-map]].

	===Overriding default parameters===		===Overriding default parameters===