XdandroidBot: Mirror from http://www.mediawiki.org/wiki/Help:Parser functions in templates

2010-06-23T00:37:27Z

Mirror from http://www.mediawiki.org/wiki/Help:Parser functions in templates

New page

When applying [[Help:Extension:ParserFunctions|ParserFunctions]] to [[Help:Template|template]] parameters, a pipe symbol ("|") may be used to provide the empty string as default value, in order to indicate how to handle things if a parameter is or is not passed in.

*<tt><nowiki>{{{1}}}</nowiki></tt>

:;Sample A: <tt><nowiki>{{#if: {{{1}}} | Parameter 1 is not defined, or is defined and non-null/non-empty. | Parameter 1 is null. It contains only empty string(s) or breaking space(s) etc.}}</nowiki></tt>

:;Result: <tt>{{#if: {{{1}}} | Parameter 1 is not defined, or is defined and non-null/non-empty. | Parameter 1 is null. It contains only empty string(s) or breaking space(s) etc.}}</tt>

*<tt><nowiki>{{{1|}}}</nowiki></tt>

:;Sample B: <tt><nowiki>{{#if: {{{1|}}} | Parameter 1 is defined and non-null/non-empty. | Parameter 1 is not defined, or is defined but null. It contains only empty string(s) or breaking space(s) etc.}}</nowiki></tt>

:;Result: <tt>{{#if: {{{1|}}} | Parameter 1 is defined and non-null/non-empty. | Parameter 1 is not defined, or is defined but null. It contains only empty string(s) or breaking space(s) etc.}}</tt>

;Comparison
{| class="wikitable"
! Condition of parameter 1
! Sample A: <nowiki>{{{1}}}</nowiki>
! Sample B: <nowiki>{{{1|}}}</nowiki>
|-
|not defined||'''TRUE'''||''FALSE''
|-
|defined but null/empty||''FALSE''||''FALSE''
|-
|defined and NOT null/empty||'''TRUE'''||'''TRUE'''
|-
|}

The second usage (<tt><nowiki>{{{1|}}}</nowiki></tt>) is often the desired way to handle situations where a parameter exists, but is comprised only of empty space.

One way to test whether a parameter was specified in a template call is thus:
<tt><nowiki>{{#ifeq:{{{v|}}}|{{{v|-}}}| v was specified (and may be empty) | v was not specified }}</nowiki></tt>

In rare cases, a template behaves differently when a parameter is unspecified compared to when it is specified but empty. When this template is used by a wrapper template (which uses the same set of named parameters), one way to ensure undefined parameters remain undefined is as follows (the technique also works with numbered parameters):

<pre>

{{wrapped_template|
normal_parameter={{{normal_parameter|}}}|
sensitive_parameter{{#ifeq:{{{sensitive_parameter|}}}|{{{sensitive_parameter|-}}}||x}}={{{sensitive_parameter|}}}|
...
}}
</pre>

Note that the <tt>wrapped_template</tt> receives a specified but empty <tt>normal_parameter</tt> in two cases: when <tt>normal_parameter</tt> is specified and empty, and when <tt>normal_parameter</tt> is unspecified (because the default empty value is then specified by the wrapper template).

By contrast, the <tt>wrapped_template</tt> receives a specified <tt>sensitive_parameter</tt> ''only'' when it is indeed specified, because the <tt>#ifeq</tt> changes the <tt>wrapped_template</tt> parameter name to « <tt>sensitive_parameterx</tt> » when <tt>sensitive_parameter</tt> is undefined. Note also that <tt>wrapped_template</tt> receives a specified and empty <tt>sensitive_parameter</tt> ''only'' when the wrapper template receives a specified and empty <tt>sensitive_parameter</tt>. Of course, one must make sure the suffixed <tt>wrapped_template</tt> parameter name is meaningless to the <tt>wrapped_template</tt> for this to work properly.

==See also==
*[[Help:Extension:ParserFunctions]]
*[[Help:Template]]

{{Languages}}

[[Category:Help|Parser functions in templates]]
[[Category:Imported help]]

Help:Parser functions in templates - Revision history

XdandroidBot: Mirror from http://www.mediawiki.org/wiki/Help:Parser functions in templates