View source for Template:If/doc

{{Documentation subpage}}
With this template the parser functions of [[mw:Help:Extension:ParserFunctions|Extension:ParserFunctions]] with names starting with "#if" can be used in a way such that they do not [[Help:Newlines_and_spaces#Stripping_on_expansion|strip spaces and newlines]] from the "then" and "else" part. For evaluating the condition spaces and newlines are stripped like with ParserFunctions.

==Usage==
{|class="wikitable" width="100%"
|-
!scope="col"| Using this <code><nowiki>{{if|*|...}}</nowiki></code> template, with <code><nowiki>{{=}}</nowiki></code> where necessary
!scope="col"| Compare to using a <code><nowiki>{{#if*:...}}</nowiki></code> parser function
|-
|valign="top"| 2 parameters:
* <code><nowiki>"{{if|error| GOOD }}"</nowiki></code> gives <code>"{{if|error| GOOD }}"</code>
* <code><nowiki>"{{if|error| <span class{{=}}"good">x</span> }}"</nowiki></code> gives <code>"{{if|error| <span class{{=}}"good">x</span> }}"</code>
* <code><nowiki>"{{if|error| <span class{{=}}"error">x</span> }}"</nowiki></code> gives <code>"{{if|error| <span class{{=}}"error">x</span> }}"</code>
|valign="top"| 1 parameter:
* <code><nowiki>"{{#iferror: GOOD }}"</nowiki></code> gives <code>"{{#iferror: GOOD }}"</code>
* <code><nowiki>"{{#iferror: <span class="good">x</span> }}"</nowiki></code> gives <code>"{{#iferror: <span class="good">x</span> }}"</code>
* <code><nowiki>"{{#iferror: <span class="error">x</span> }}"</nowiki></code> gives <code>"{{#iferror: <span class="error">x</span> }}"</code>
|-
|valign="top"| 3 parameters:
* <code><nowiki>"{{if|error| 7 | ERROR }}"</nowiki></code> gives "{{if|error| 7 | ERROR }}"
* <code><nowiki>"{{if|error| <span class{{=}}"error">x</span> | ERROR }}"</nowiki></code> gives <code>"{{if|error| <span class{{=}}"error">x</span> | ERROR }}"</code>
|valign="top"| 2 parameters:
* <code><nowiki>"{{#iferror: 7 | ERROR }}"</nowiki></code> gives "{{#iferror: 7 | ERROR }}"
* <code><nowiki>"{{#iferror: <span class="error">x</span> | ERROR }}"</nowiki></code> gives <code>"{{#iferror:<span class="error">x</span> | ERROR }}"</code>
|-
|valign="top"| 4 parameters:
* <code><nowiki>"{{if|error| 7 | ERROR | ALT }}"</nowiki></code> gives <code>"{{if|error| 7 | ERROR | ALT }}"</code>
* <code><nowiki>"{{if|error|<span class{{=}}"error">x</span>| ERROR | ALT }}"</nowiki></code> gives <code>"{{if|error|<span class{{=}}"error">x</span>| ERROR | ALT }}"</code>
* <code><nowiki>"{{if|error| 7 | ERROR | }}"</nowiki></code> gives <code>"{{if|error| 7 | ERROR | }}"</code>
* <code><nowiki>"{{if|error| 7 | ERROR |}}"</nowiki></code> gives <code>"{{if|error| 7 | ERROR |}}"</code>
* <code><nowiki>"{{if|error| 7 | ERROR }}"</nowiki></code> gives <code>"{{if|error| 7 | ERROR }}"</code>
* <code><nowiki>"{{if||x| YES | NO }}"</nowiki></code> gives <code>"{{if||x| YES | NO }}"</code>
* <code><nowiki>"{{if|| | YES | NO }}"</nowiki></code> gives <code>"{{if|| | YES | NO }}"</code>
* <code><nowiki>"{{if||| YES | NO }}"</nowiki></code> gives <code>"{{if||| YES | NO }}"</code>
* <code><nowiki>"{{if|expr|2<3| YES | NO }}"</nowiki></code> gives <code>"{{if|expr|2<3| YES | NO }}"</code>
* <code><nowiki>"{{if|expr|2>3| YES | NO }}"</nowiki></code> gives <code>"{{if|expr|2>3| YES | NO }}"</code>
* <code><nowiki>"{{if|expr|2{{=}}3| YES | NO }}"</nowiki></code> gives <code>"{{if|expr|2{{=}}3| YES | NO }}"</code>
* <code><nowiki>"{{if|exist| Help:Link | YES | NO }}"</nowiki></code> gives <code>"{{if|exist| Help:Link | YES | NO }}"</code>
* <code><nowiki>"{{if|exist| Hulp:Link | YES | NO }}"</nowiki></code> gives <code>"{{if|exist| Hulp:Link | YES | NO }}"</code>
* <code><nowiki>"{{if|eq| u |u| YES }}"</nowiki></code> gives <code>"{{if|eq| u |u| YES }}"</code>
* <code><nowiki>"{{if|eq| u |v| YES }}"</nowiki></code> gives <code>"{{if|eq| u |v| YES }}"</code>
|valign="top"| 3 parameters:
* <code><nowiki>"{{#iferror: 7 | ERROR | ALT }}"</nowiki></code> gives <code>"{{#iferror: 7 | ERROR | ALT }}"</code>
* <code><nowiki>"{{#iferror:<span class="error">x</span>| ERROR | ALT }}"</nowiki></code> gives <code>"{{#iferror:<span class="error">x</span>| ERROR | ALT }}"</code>
* <code><nowiki>"{{#iferror: 7 | ERROR | }}"</nowiki></code> gives <code>"{{#iferror: 7 | ERROR | }}"</code>
* <code><nowiki>"{{#iferror: 7 | ERROR |}}"</nowiki></code> gives <code>"{{#iferror: 7 | ERROR |}}"</code>
* <code><nowiki>"{{#iferror: 7 | ERROR }}"</nowiki></code> gives <code>"{{#iferror: 7 | ERROR }}"</code>
* <code><nowiki>"{{#if:x| YES | NO }}"</nowiki></code> gives <code>"{{#if:x| YES | NO }}"</code>
* <code><nowiki>"{{#if: | YES | NO }}"</nowiki></code> gives <code>"{{#if: | YES | NO }}"</code>
* <code><nowiki>"{{#if:| YES | NO }}"</nowiki></code> gives <code>"{{#if:| YES | NO }}"</code>
* <code><nowiki>"{{#ifexpr:2<3| YES | NO }}"</nowiki></code> gives <code>"{{#ifexpr:2<3| YES | NO }}"</code>
* <code><nowiki>"{{#ifexpr:2>3| YES | NO }}"</nowiki></code> gives <code>"{{#ifexpr:2>3| YES | NO }}"</code>
* <code><nowiki>"{{#ifexpr:2=3| YES | NO }}"</nowiki></code> gives <code>"{{#ifexpr:2=3| YES | NO }}"</code>
* <code><nowiki>"{{#ifexist: Help:Link | YES | NO }}"</nowiki></code> gives <code>"{{#ifexist: Help:Link | YES | NO }}"</code>
* <code><nowiki>"{{#ifexist: Hulp:Link | YES | NO }}"</nowiki></code> gives <code>"{{#ifexist: Hulp:Link | YES | NO }}"</code>
* <code><nowiki>"{{#ifeq: u |u| YES }}"</nowiki></code> gives <code>"{{#ifeq: u |u| YES }}"</code>
* <code><nowiki>"{{#ifeq: u |v| YES }}"</nowiki></code> gives <code>"{{#ifeq: u |v| YES }}"</code>
|-
|valign="top"| 5 parameters:
* <code><nowiki>"{{if|eq| u |u| YES | NO }}"</nowiki></code> gives <code>"{{if|eq| u |u| YES | NO }}"</code>
* <code><nowiki>"{{if|eq| u |v| YES | NO }}"</nowiki></code> gives <code>"{{if|eq| u |v| YES | NO }}"</code>
|valign="top"| 4 parameters:
* <code><nowiki>"{{#ifeq: u |u| YES | NO }}"</nowiki></code> gives <code>"{{#ifeq: u |u| YES | NO }}"</code>
* <code><nowiki>"{{#ifeq: u |v| YES | NO }}"</nowiki></code> gives <code>"{{#ifeq: u |v| YES | NO }}"</code>
|}

Note that, unlike parser functions, templates require writing equals signs in values of unnamed parameters as <code><nowiki>{{=}}</nowiki></code>.
: Alternatively you may want pass the condition containing the equal sign by explicitly giving the parameter 2 by name, but then the unnumbered parameters after it after it would override the condition (and you don't want to pass them by name because their value would have their whitespace trimmed), so you still need to pass the unnumbered parameter 2, and override it with the explicitly named parameter, but this adds a warning during expansion because the parameter 2 is then passed twice (only the last value is taken into account).

For full substitution, simply use {{cnw|subst:}} or {{cnw|safesubst:}}. If the condition contains a parser function, template, or variable, that should be substituted too. Optionally the "then" or "else" part can also be substituted.

Error messages (examples):
* <code><nowiki>{{if|expr|1234>e3|1|0}}</nowiki></code> gives <code>{{if|expr|1234>e3|1|0}}</code>
* <code><nowiki>{{#ifexpr:1234>e3|1|0}}</nowiki></code> gives <code>{{#ifexpr:1234>e3|1|0}}</code>

== Internal technical details ==
For evaluating the condition the template uses the actual parser functions; however, not directly with p and q, because this strips spaces and newlines from them, but with index values 1 and 2. The result can be 1, 2, or, only in the case of #ifexpr, an error message. Using a switch these are converted to p1, p2, and if/errmsg, respectively. The template with the applicable name is called ([[Template:P1]], [[Template:P2]], or [[Template:If/errmsg]]), with as parameters p, q, and {{{2}}}. Templates p1 and p2 ignore {{{2}}}; template if/errmsg is only called in the case of #ifexpr, in the case of a wrong expression {{{2}}}; it ignores p and q and uses {{{2}}} for display in the error message.

== Expansion depth limit ==
Without the expansion depth limit, all these should return the same result <code>"a"</code>.

1 level:
* <code><nowiki>"{{if||x|a}}"</nowiki></code> gives <code>"{{if||x|a}}"</code>.
* <code><nowiki>"{{if||||a}}"</nowiki></code> gives <code>"{{if||||a}}"</code>.
2 levels:
* <code><nowiki>"{{if||x|{{if||x|a}}}}"</nowiki></code> gives <code>"{{if||x|{{if||x|a}}}}"</code>.
* <code><nowiki>"{{if||||{{if||||a}}}}"</nowiki></code> gives <code>"{{if||||{{if||||a}}}}"</code>.
3 levels:
* <code><nowiki>"{{if||x|{{if||x|{{if||x|a}}}}}}"</nowiki></code> gives <code>"{{if||x|{{if||x|{{if||x|a}}}}}}"</code>.
* <code><nowiki>"{{if||||{{if||||{{if||||a}}}}}}"</nowiki></code> gives <code>"{{if||||{{if||||{{if||||a}}}}}}"</code>.
6 levels:
* <code><nowiki>"{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|a}}}}}}}}}}}}"</nowiki></code> gives <code>"{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|a}}}}}}}}}}}}"</code>.
* <code><nowiki>"{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||a}}}}}}}}}}}}"</nowiki></code> gives <code>"{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||a}}}}}}}}}}}}"</code>.
9 levels:
* <code><nowiki>"{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|a}}}}}}}}}}}}}}}}}}"</nowiki></code> gives <code>"{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|a}}}}}}}}}}}}}}}}}}"</code>.
* <code><nowiki>"{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||a}}}}}}}}}}}}}}}}}}"</nowiki></code> gives <code>"{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||a}}}}}}}}}}}}}}}}}}"</code>.
10 levels:
* <code><nowiki>"{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|a}}}}}}}}}}}}}}}}}}}}"</nowiki></code> gives <code>"{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|a}}}}}}}}}}}}}}}}}}}}"</code>.
* <code><nowiki>"{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||a}}}}}}}}}}}}}}}}}}}}"</nowiki></code> gives <code>"{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||a}}}}}}}}}}}}}}}}}}}}"</code>.
11 levels:
* <code><nowiki>"{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|a}}}}}}}}}}}}}}}}}}}}}}"</nowiki></code> gives <code>"{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|{{if||x|a}}}}}}}}}}}}}}}}}}}}}}"</code>.
* <code><nowiki>"{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||a}}}}}}}}}}}}}}}}}}}}}}"</nowiki></code> gives <code>"{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||{{if||||a}}}}}}}}}}}}}}}}}}}}}}"</code>.

==Conditions==
===#if:===

Condition: string (after trimming leading and trailing spaces) not empty.

===#ifexist:===

Condition: page [[Help:Page existence|exists]] (applies also to special pages).

The usual case-sensitivity applies: if a page exists then also a non-canonical name for that page gives a positive result.

[[Template:Exists]] gives the same result, except that the result is positive for an interwiki link. You can also handle an interwiki link differently with [[Template:If interwiki link]].

The page A checking existence of page B is listed on Special:Whatlinkshere/B as a page which links to B.

On Wikimedia wikis there is a maximum for the number of distinct pages for which #ifexist is called on a page. A call of #ifexist after a transclusion of the same page does not require an extra database query and is therefore not counted. A call beyond the maximum returns "false". The html-source of each page shows the counted number of calls, as well as the maximum. The maximum is currently 500, see [[w:Wikipedia:Template limits#Expensive parser function calls]].

===#ifexpr:===
Condition: non-zero.<ref>[http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/ParserFunctions/Expr.php?view=markup Expr.php]</ref>

Empty gives false. Other strings which are not correct numerical or Boolean expressions give an error message<ref>[http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/ParserFunctions/ParserFunctions.i18n.php?view=markup ParserFunctions.i18n.php]</ref>:
<syntaxhighlight lang="php" line start="16">
 	'pfunc_expr_stack_exhausted' => 'Expression error: Stack exhausted',
 	'pfunc_expr_unexpected_number' => 'Expression error: Unexpected number',
 	'pfunc_expr_preg_match_failure' => 'Expression error: Unexpected preg_match failure',
 	'pfunc_expr_unrecognised_word' => 'Expression error: Unrecognised word "$1"',
 	'pfunc_expr_unexpected_operator' => 'Expression error: Unexpected $1 operator',
 	'pfunc_expr_missing_operand' => 'Expression error: Missing operand for $1',
 	'pfunc_expr_unexpected_closing_bracket' => 'Expression error: Unexpected closing bracket',
 	'pfunc_expr_unrecognised_punctuation' => 'Expression error: Unrecognised punctuation character "$1"',
 	'pfunc_expr_unclosed_bracket' => 'Expression error: Unclosed bracket',
 	'pfunc_expr_division_by_zero' => 'Division by zero',
 	'pfunc_expr_invalid_argument' => 'Invalid argument for $1: < -1 or > 1',
 	'pfunc_expr_invalid_argument_ln' => 'Invalid argument for ln: <= 0',
 	'pfunc_expr_unknown_error' => 'Expression error: Unknown error ($1)',
 	'pfunc_expr_not_a_number' => 'In $1: result is not a number',
</syntaxhighlight>

===#iferror:===

Condition: contains <code>class="error"</code> as attribute of <code><nowiki><strong></nowiki></code>, <code><nowiki><span></nowiki></code>, <code><nowiki><p></nowiki></code>, or <code><nowiki><div></nowiki></code> tags.<ref>[http://svn.wikimedia.org/viewvc/mediawiki/trunk/extensions/ParserFunctions/ParserFunctions_body.php?view=markup ParserFunctions_body.php]</ref>

These are generated by #expr, #ifexpr, #time, #rel2abs, some other MediaWiki situations (such as recursive depth and template loop checks), and this template.

If the error condition does not apply and there is no "else" part, the function gives the input wikitext.

===#ifeq:===
Condition: equal as strings (case-sensitive) or numbers.<ref>#ifeq: uses the PHP comparison operator ==.[http://www.php.net/manual/en/language.operators.comparison.php]</ref>

*<code><nowiki>{{if|eq| 1e3 | 1000 | 1 | 0 }}</nowiki></code> gives "{{if|eq| 1e3 | 1000 | 1 | 0 }}".
*<code><nowiki>{{#ifeq: 1e3 | 1000 | 1 | 0 }}</nowiki></code> gives "{{#ifeq: 1e3 | 1000 | 1 | 0 }}".

To force a string-based comparison, add a non-numerical character to both compared arguments.

*<code><nowiki>{{if|eq| x1e3 | x1000 | 1 | 0 }}</nowiki></code> gives "{{if|eq| x1e3 | x1000 | 1 | 0 }}".
*<code><nowiki>{{#ifeq: x1e3 | x1000 | 1 | 0 }}</nowiki></code> gives "{{#ifeq: x1e3 | x1000 | 1 | 0 }}".

If desired, trim the arguments before adding this non-numerical character, for example with <code><nowiki>x{{#if:1| 1000 }}</nowiki></code>.

Text between <code>&lt;nowiki&gt;</code> tags is temporarily replaced by a unique code. This affects comparisons:

*<code><nowiki>{{if|eq|&lt;nowiki&gt;abc&lt;/nowiki&gt; | &lt;nowiki&gt;abc&lt;/nowiki&gt; | 1 | 0 }}</nowiki></code> gives "{{if|eq|<nowiki>abc</nowiki> | <nowiki>abc</nowiki> | 1 | 0 }}".
*<code><nowiki>{{#ifeq:&lt;nowiki&gt;abc&lt;/nowiki&gt; | &lt;nowiki&gt;abc&lt;/nowiki&gt; | 1 | 0 }}</nowiki></code> gives "{{#ifeq:<nowiki>abc</nowiki> | <nowiki>abc</nowiki> | 1 | 0 }}".

==See also==
*[[Template:Sw]]
*[[Template:Iflenge]]
*[[w:Template:If]]
{{refs}}

<includeonly>[[Category:Branching templates]]</includeonly>