Help:Parameter default
From Wikipedia, the free encyclopedia
 |
This is a copy of the master help page at Meta. Do not edit this copy. Edits will be lost in the next update from the master page. See below for more information. |
Note: Information on this page relates to MediaWiki versions 1.6 and later.
Notation: on this page the wikitext {{{a}}} is written as [a].
In a template, [a|b] is equal to [a] if that is defined, and else equal to b.
These results [a] and b can be end results, but they can also be parameter names, parameter values, template names, parts thereof, etc.
If the results are template names as part of template calls involving a parameter of the outer template which may be undefined, one can arrange that an inner template is called with a parameter depending on an undefined outer parameter only if the parameter concerned is not actually used in the inner template, e.g. dummy template Template:x0 containing "<noinclude>This is the empty template. It is used as an alternative choice for conditional expressions embedded in transclusions.</noinclude>" can be called as {{x0|[a]}} even if [a] is undefined, see e.g. m:Template:foreach/pass1 (backlinks, edit).
Contents |
Limitation
In the case of multiple default parts, only the first applies: [a|b|c|d] is equivalent with [a|b]. The default part can only contain "|" as part of full template, parameter or link syntax within it, and within nowiki-tags. Note that "|" can be avoided in table syntax by applying HTML coding (element "<table>").
The expression for the parameter name can also contain "|", as part of full template or parameter syntax within it.
Examples, using Template:x3 containing "<noinclude> This sandbox is itself a template. This sandbox is for experimenting with templates. {{Please leave this line alone (template sandbox heading)}} </noinclude>
If you defined parameters such as <tt>{{Template sandbox|First|Second|name="Named"}}</tt>:
First{{{1}}}Second{{{2}}}Name{{{name}}}
"
and Template:t2 containing "[[w:List of people by name: {{{1}}}{{{2}}}|{{{1}}}{{{2}}}]] <noinclude>[[Category:Demo template]]</noinclude>":
- {{{a|b|c|d}}} gives b
- {{{a|{{x3|b}}}}} gives
If you defined parameters such as {{Template sandbox|First|Second|name="Named"}}:
- First
- b
- Second
- {{{2}}}
- Name
- {{{name}}}
- {{{a|{{{b|c}}}}}} gives c
- {{{a|[[b|c]]}}} gives c
- {{{{{x3|a}}|b}}} gives b - parameter aaa is undefined
- {{{{{{a|b}}}|c}}} gives c - parameter b is undefined
- {{{a|<nowiki>b|c</nowiki>}}} gives b|c - works fine for rendering text, but is not suitable for putting parameters b and c in a template call (there is no function for removing nowiki tags):
- {{t2|{{{a|<nowiki>b|c</nowiki>}}}}} gives [[w:List of people by name: b|c{{{2}}}|b|c{{{2}}}]]
Expressions containing a parameter, with default
Consider the expression [a[b|c]|f([b])] occurring in a template, where f([b]) denotes an expression in [b].
Conditions:
- [a[b]] is undefined for all applicable [b] (all values of parameter b for which the template is called)
- [ac]=d (the template is called with ac=d)
Then the expression gives f([b]) if [b] is defined, and otherwise d.
Note that the conditions require that no applicable [b] has value c. If one wants to be able to use all letters and digits in [b], and also allow null (the empty string), then for c one can take e.g. "@".
If it is desirable or at least acceptable that if [b] is empty, the result is not f("") but "", and the same when [b] is undefined, we take d="", and can for example choose c to be the empty string too. Then we have the expression [a[b|]|f([b])] occurring in the template, giving f([b]) if [b] is defined, and otherwise the empty string, under the following conditions:
- [a[b]] is undefined for all applicable [b] (all values of parameter b for which the template is called)
- the template is called with "a="
The same template can contain several expressions [ai [bi | c ] | fi ([bi ])]. By choosing all ai equal we need only one "a=" in the template call. Then the expressions are [a [bi | c ] | fi ([bi ])].
A special case is with constant functions fi, i.e. not dependent on [bi ]. Then the expressions are [a [bi | c ] | fi ]. In the template call it only matters for each bi whether is gets a value, not which value. For convenience we can assign the empty string to those which are defined at all. Since no applicable [b] should have value c (see above), c should not be the empty string in this case. With d the empty string, the template serves as an array, where for index bi the array value is fi. It is called with "ac=" and "bi=", or even with a list of assignments "bi=", giving a list of the corresponding array values. See m:Template:Short DOW alt 2 (backlinks, edit).
While normally a parameter specification in a template call represents a choice the user of the template has, the need to specify "ac=" is an unfortunate technical requirement imposed on the user of the template; it can be shielded from the user by putting the template call inside another template; on projects where server-strain is a concern this may not be desirable.
The name "a" can be chosen such that no other parameters of the template have a name starting with it, then the first condition is fulfilled (apart from the case, already discussed, that [b] is the empty string). A good choice is "if". Thus
- [if [bi | c ] | fi ([bi ])]
means
- if bi is defined then fi ([bi ])
c="" gives the if-statement which is shortest and with the best appearance, while e.g. c="u" (for "undefined") allows for the shortest specification in the template call to define bi ("bi=") in cases where the value is irrelevant. The latter may be confusing in contexts where "empty" and "undefined" are usually treated as equivalent.
If the result, f([b]) or the empty string, is for final display only, i.e., not for use in expressions for template names, parameter names, parameter values, page names in links, etc., an alternative is using CSS, see MediaWiki talk:Common.css.
For comparison using a="if" and c=d="", and also the shorter class name "if" instead of "HiddenStructure", the two lines are:
<span class=" if{{{b|}}} "> ... </span>
{{{ if{{{b|}}} | ... }}}
In the second method the wikitext in the template is 15 characters shorter for each optional item, but each call is 4 characters ("if=|") longer.
In the first method conflicts with other class names have to be avoided, in the second method conflicts with other parameter names.
Repetition
A "for-loop" is achieved using
m:Template:fors (backlinks, edit), containing:
{{fors/aux
|v@=
|c={{{call}}}
|pv={{{pv|1}}}
|s={{{sep|}}}
|pc1={{{pc1|=}}}
|pc2={{{pc2|=}}}
|pc3={{{pc3|=}}}
|pc4={{{pc4|=}}}|
1={{{1|@}}}|2={{{2|@}}}|3={{{3|@}}}
}}
with m:Template:fors/aux (backlinks, edit), containing:
{{{v{{{1}}}|{{{{{c}}}|{{{pc1}}}|{{{pc2}}}|{{{pc3}}}|{{{pc4}}}|{{{pv}}}={{{1}}}}}}}}
{{{v{{{2}}}|{{{s}}}{{{{{c}}}|{{{pc1}}}|{{{pc2}}}|{{{pc3}}}|{{{pc4}}}|{{{pv}}}={{{2}}}}}}}}
{{{v{{{3}}}|{{{s}}}{{{{{c}}}|{{{pc1}}}|{{{pc2}}}|{{{pc3}}}|{{{pc4}}}|{{{pv}}}={{{3}}}}}}}}
In short form the latter consists of components
[ v[i] | [s] {{[c]|[pc1]|[pc2]|[pc3]|[pc4]|[pv]=[i]}} ] (i = 1, 2, 3, for i = 1 without [s])
or in terms of the parameters of the first template:
[v[i|@] | [sep|] {{[call]|[pc1|]|[pc2|]|[pc3|]|[pc4|]|[pv|1]=[i]}} ]
This is indeed of the above-mentioned form [a[b|c]|f([b])], with a=v, b=i, c=@, and
f(x) = [sep|] {{[call]|[pc1|]|[pc2|]|[pc3|]|[pc4|]|[pv|1]=x}}
The assumptions mentioned above apply for d equal to null, and provided that no [i] is equal to "@".
Variations
Since v@=null we can also take make the concatenation the outer operation: [v[i|@] | [sep|]] [v[i|@] | {{[call]|[pc1|]|[pc2|]|[pc3|]|[pc4|]|[pv|1]=[i]}} ]
Conditional statement
m:Template:if (backlinks, edit) contains:
{{{else{{{test|}}}|{{{test{{{test|}}}|{{{then|}}}}}}}}}
or in short form:
[ else[test|] | [ test[test|] | [then|] ] ]
If [test] is defined this reduces to
[ else[test] | [ test[test] | [then|] ] ]
For test equal to null this reduces to [else|]; otherwise, if no parameter name starting with "test" or "else" applies except these themselves, then this reduces to [then|].
If [test] is undefined we get
[ else | [then|] ]
Last-but technique
Somewhen maybe the last or last but x parameter value is needed, but number of inputted parameter is unknown. The following is a technique to get last "assigned" parameter value without using a template:
[4|[3|[2|[1|*]]]].
Then last but one can be achieved like this: ("ifu" is preassigned with empty)
[[if[4|u]|3]| [[if[3|u]|2]| [[if[2|u]|1]| [[if[1|u]|0]|*] //this line is actually useless, can be replaced by "*". ] ] ]
I.e., to replace "4", "3", "2", "1" with D4, D3, D2, D1. And Dx=[if[x|u]|x-1]. Like this, you can get "last but x" parameter value.
Examples using m:Template:lastbut0 (backlinks, edit) and m:Template:lastbut1 (backlinks, edit):
{{lastbut0}}gives Template:Lastbut0.{{lastbut0|a}}gives Template:Lastbut0.{{lastbut0|a|b|c|d|e|f|g|h|i|j}}gives Template:Lastbut0.{{lastbut1|ifu=}}gives Template:Lastbut1.{{lastbut1|ifu=|a}}gives Template:Lastbut1.{{lastbut1|ifu=|a|b}}gives Template:Lastbut1.{{lastbut1|ifu=|a|b|c|d|e|f|g|h|i|j}}gives Template:Lastbut1.{{lastbut0|53=53|81=81|28=28}}gives Template:Lastbut0 (finds maximum of a list of integers in the range 1 - 100)
See also Template:Timcnl
Server efficiency
Parameter default constructs are said to be more efficiently executed by the server than similar constructs using extra layers of templates.
See also
- m:Template:T opt par (backlinks, edit) - examples
| edit |
Wikipedia-specific help
The MediaWiki parameter default function doesn't return the default value for empty parameters, but only for not defined (null) parameters. That is, {{{logo|default.svg}}} does not return "default.svg" if the template was called like this: {{template|logo=}}. The template {{ifempty}} at Wikipedia solves this, it helps using defaults both for empty and null parameters.
This page is a copy of the master help page at Meta (for general help information all Wikimedia projects can use), with two Wikipedia-specific templates inserted. To update the main text, edit the master help page for all projects at m:Help:Parameter default. For Wikipedia-specific issues, use Template:Ph:Parameter default (the extra text at the bottom of this page) or Template:Phh:Parameter default for a Wikipedia-specific lead (text appears at the top of this page). You are welcome to replace the full wikitext of this page with that of the master page at Meta at any time. To view this page in other languages see the master page at Meta.
