Template:Wrapper/doc

This is a documentation subpage for Template:Wrapper.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:Params

This template is a doc page banner that flags a wrapper template.

Usage

Wikitext (see {{Family name footnote}}):

{{Wrapper|Family name explanation
	| except = type -> footnote // reftype -> <nowiki>{{{reftype|efn}}}</nowiki>
}}

Effect:

This is a customized wrapper for the {{Family name explanation}} template, which means it's built upon the other template's code. Parameters from {{Family name explanation}} will work here. However, the following are exceptions:

Parameter passed to {{Family name explanation}}	Value
`\|reftype=`	`{{{reftype\|efn}}}`
`\|type=`	`footnote`

Wikitext (see {{Bts}}):

{{Wrapper|Station link
	| except = MBTA // <nowiki>{{{1|}}}</nowiki> // <nowiki>{{{2|}}}</nowiki> // <nowiki>{{{3|}}}</nowiki>
	| passing-through =
}}

or, equivalently,

{{Wrapper|Station link
	| except =
		1 -> MBTA //
		2 -> <nowiki>{{{1|}}}</nowiki> //
		3 -> <nowiki>{{{2|}}}</nowiki> //
		4 -> <nowiki>{{{3|}}}</nowiki>
	| passing-through =
}}

Effect:

This is a customized wrapper for the {{Station link}} template, which means it's built upon the other template's code. Since all parameters are already managed, no parameters from {{Station link}} will work here. The parameters passed are managed as follows:

Parameter passed to {{Station link}}	Value
`\|1=`	`MBTA`
`\|2=`	`{{{1\|}}}`
`\|3=`	`{{{2\|}}}`
`\|4=`	`{{{3\|}}}`

Wikitext (see {{Don't ping}}):

{{Wrapper|Please ping
	| except = 1 -> no
	| omitting = tps // nw // big // thanks // cond
	| passing-through =
}}

Effect:

This is a customized wrapper for the {{Please ping}} template, which means it's built upon the other template's code. Since all parameters are already managed, no parameters from {{Please ping}} will work here. The parameters passed are managed as follows:

Parameter passed to {{Please ping}}	Value
`\|1=`	`no`
`\|big=`	(undefined)
`\|cond=`	(undefined)
`\|nw=`	(undefined)
`\|thanks=`	(undefined)
`\|tps=`	(undefined)

Wikitext (see {{Sfnlinka}}):

{{Wrapper|Sfnlink
	| except = article -> *
	| omitting = rev // lang
	| passing-through = p // page // pp // pages // loc // nb // text
}}

Effect:

This is a customized wrapper for the {{Sfnlink}} template, which means it's built upon the other template's code. The following parameters from {{Sfnlink}} will work here: |loc=, |nb=, |p=, |page=, |pages=, |pp=, and |text=. The other parameters passed are managed as follows:

Parameter passed to {{Sfnlink}}	Value
`\|article=`	`*`
`\|lang=`	(undefined)
`\|rev=`	(undefined)

Wikitext (see {{Tanakhverse}}):

{{Wrapper|Bibleverse
	| except = 3 -> <nowiki>{{{3|HE}}}</nowiki>
	| omitting = 4 // 5
}}

Effect:

This is a customized wrapper for the {{Bibleverse}} template, which means it's built upon the other template's code. Parameters from {{Bibleverse}} will work here. However, the following are exceptions:

Parameter passed to {{Bibleverse}}	Value
`\|3=`	`{{{3\|HE}}}`
`\|4=`	(undefined)
`\|5=`	(undefined)

Wikitext:

{{Wrapper|Debug}}

Effect:

This is a customized wrapper for the {{Debug}} template, which means it's built upon the other template's code. All parameters from {{Debug}} will work here.

Template data

This documentation box informs that a template is a wrapper of another template.

Template parameters
Parameter		Description	Type	Status
Template	`1`	Name of the wrapped template Example Please ping	String	required
Bound parameters	`except`	The list of pre-assigned parameters; use ‘//’ to separate them and ‘->’ to assign them a value—see ‘\|separator=’ and ‘\|setter=’ to set other strings Example 1 -> no	String	optional
Undefined parameters	`omitting`	The list of parameter names left undefined; use ‘//’ to separate them—see ‘\|separator=’ to set another string Example tps // nw // big // thanks // cond	String	optional
Parameters passed through	`passing-through`	The list of parameter names left available to use; use ‘//’ to separate them—see ‘\|separator=’ to set another string; you can provide a blank parameter to signal that no parameters are left available Example lorem // ipsum // foo // bar	String	optional
Separator string	`separator`	The string to use as separator between parameters Default // Example ;	String	optional
Setter string	`setter`	The string to use as value setter Default -> Example :	String	optional
Table class	`table-class`	The ‘class=’ HTML attribute assigned to the table of managed parameters Default wikitable Example wikitable mw-collapsible mw-collapsed	String	optional
No category	`nocat`	Disable automatic categorization into ‘Category:Templates calling Example’ or ‘Category:Wrapper templates’ (depending on the case) Default no Example yes	Boolean	optional

Template:Wrapper/doc

Usage

Template data

See also

Content Disclaimer