View source for Template:Ifequal/doc

{{Documentation subpage}}

This template is used to extend the [[mw:Help:Extension:ParserFunctions|parser function]] [[Wikipedia:Help:Conditional expressions|<code>#ifeq:</code>]] to multiple tests.

The template takes up to eight pairs of arguments (i.e., 16 [[Wikipedia:Help:Template#Handling parameters|unnamed parameters]]), tests the odd versus the even parameter values, and returns a TRUE value (a string of characters) if '''any''' pair matches using the parser function <code>#ifeq:</code>, otherwise it returns a FALSE value (an [[Wikipedia:empty string|empty string]]).

* <code><nowiki>{{ifequal|foo|foo}}</nowiki></code> → {{ifequal|foo|foo}}
* <code><nowiki>{{ifequal|foo|bar}}</nowiki></code> → {{ifequal|foo|bar}}
* <code><nowiki>{{ifequal|foo|foo|bar|bar}}</nowiki></code> → {{ifequal|foo|foo|bar|bar}}
* <code><nowiki>{{ifequal|foo|foo|bar|buzz}}</nowiki></code> → {{ifequal|foo|foo|bar|buzz}}
* <code><nowiki>{{ifequal|foo|bar|buzz|buzz}}</nowiki></code> → {{ifequal|foo|bar|buzz|buzz}}
* <code><nowiki>{{ifequal|foo|bar|buzz|bat}}</nowiki></code> → {{ifequal|foo|bar|buzz|bat}}

The returned values are suitable for testing within simple if-then-else conditionals inside the calling template.

===Typical example===

 <nowiki>{{#if:</nowiki> '''<nowiki>{{ifequal</nowiki>'''|{{{1}}}|one|{{{2}}}|two|{{{3}}}|three'''<nowiki>}}</nowiki>''' | Yes, we | No, we don't <nowiki>}}</nowiki> have a match.

Assuming this code is inside of a template that can be called with three unnamed parameter values:
* The <code><nowiki>{{ifequal}}</nowiki></code> call returns TRUE if the first unnamed parameter has the value "one" OR the second has the value "two" OR the third has the value "three", in which case the code will build the string: "Yes, we have a match."
* The <code><nowiki>{{ifequal}}</nowiki></code> call returns FALSE if none match, in which case it will build the string: "No, we don't have a match."

===OR detection ===
#An equality: <nowiki> {{#if:{{ifequal|1|2|3|4|6|6}}|True|False}} </nowiki> -- '''[{{#if:{{ifequal|1|2|3|4|6|6}}|True|False}}]'''
#An equality, where <nowiki>{{{1}}}</nowiki> is an example variable: <nowiki> {{#if:{{ifequal|{{{1}}}|1|{{{1}}}|2|{{{1}}}3|{{{1}}}|4|{{{1}}}|5}}|True|False}} </nowiki> -- '''[True]''' when the variable value is 1, 2, 3, 4 or 5. '''[False]''' when is any another value.
#Inequality: <nowiki> {{{{#if:ifequal|1|2|3|4|5|6}}|True|False}} </nowiki> -- '''[{{#if:{{ifequal|1|2|3|4|5|6}}|True|False}}]'''

===Behavior with empty strings (unset parameter values)===

Assuming the parameter values referred to here have '''not been set''' in the calling template:
* <code><nowiki>{{ifequal||}}</nowiki></code> → {{ifequal||}}
* <code><nowiki>{{ifequal|{{{foo|}}}|}}</nowiki></code> → {{ifequal|{{{foo|}}}|}}
* <code><nowiki>{{ifequal|{{{foo|}}}|{{{bar|}}}}}</nowiki></code> → {{ifequal|{{{foo|}}}|{{{bar|}}}}}
Note how empty strings are not considered equal in any of these cases.

But beware: in the following two examples, if the parameters have not been set, the ''literal strings'' "<nowiki>{{{foo}}}</nowiki>" and "<nowiki>{{{bar}}}</nowiki>" are used in their place.
* <code><nowiki>{{ifequal|{{{foo}}}|}}</nowiki></code> → {{ifequal|{{{foo}}}|}}
* <code><nowiki>{{ifequal|{{{foo}}}|{{{bar}}}}}</nowiki></code> → {{ifequal|{{{foo}}}|{{{bar}}}}}
The difference is the presence or absence of a vertical-bar character (<code>{{!}}</code>) following "foo" and "bar". See [[Help:Template#Handling parameters]] for more information about this.

To detect whether parameter values are set or unset, use the [[mw:Help:Extension:ParserFunctions##if|{{mono|#if:}} parser function]] instead of this template.

===See also===

*{{tlx|ifeqall}} — Compares one ''comparison string'' against up to 10 ''case strings'' with optional ''result string'' and ''default result string'' outputs.
*{{tlx|ifeqany}} — Compares up to 24 ''case strings'' against each other with ''result string'' and ''default result string'' outputs.
*{{tlx|ifor}} — Compares up to 30 ''comparison strings'' against an equal number of ''case strings'' with optional ''result string'' and ''default result string'' outputs.
*{{tlx|{{=}}}} — Returns an equal sign.
*[[Wikipedia:Advanced template coding]]
<includeonly>{{Sandbox other||<!--
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
[[Category:If-then-else templates|{{PAGENAME}}]]
}}</includeonly>