Template:Yesno-yes
yes
This template is being considered for merging with Template:If affirmed. Please discuss this matter at this template's entry at templates for discussion to help reach a consensus.
Maintenance use only: 1. Edit the TfD log to create the discussion entry. 2. Please consider notifying the author(s) by placing {{subst:Tfmnotice|Yesno|If affirmed}} ~~~~ on their talk page(s). |
This template is used on approximately 70,000 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
{{Yesno}}
(or {{YesNo}}
) evaluates any input and produces a normalized yes or no, based on the content of the input and several configurable options. It is not used in article prose, but in coding complex templates.
Usage
The template distinguishes five different types of input, supplied on the first unnamed parameter:
- Yes: Case-insensitive forms of
Yes
,y
,true
, and1
; e.g.{{Yesno|yEs}}
- No: Case-insensitive forms of
No
,n
,false
, and0
; e.g.{{Yesno|nO}}
- Nothing: When the input is defined but either contains no value or consists of whitespace character only; i.e.
{{Yesno|}}
or{{Yesno| }}
- Negation: When the input is either
¬
or entirely missing; i.e.{{Yesno|¬}}
or{{Yesno}}
- Anything else: e.g.
{{Yesno|Purple monkey dish washer}}
By default, the template returns "yes" in the first and last case but returns blank in the other cases.
Two short-hand templates for the most common uses that override the default behavior:
{{yesno-yes}}
or{{YesNo-Yes}}
– always returns "yes" (or the specified replacement result in|yes=
) unless an explicit negative value is given; i.e., it evaluates to "yes" even when the value is empty or missing.{{yesno-no}}
or{{YesNo-No}}
– always returns "no" (or the specified replacement result in|no=
) unless an explicit positive value is given; i.e., it evaluates to "no" even when the value is present, as long as it does not contain anything that resolves to "yes".
Customizing the output
Template's default output can be customized with five named parameters, respectively: |yes=
, |no=
, |blank=
, |¬=
and |def=
. If these parameters are specified, the template response is as follows:
- Yes: Template returns the contents of
|yes=
, otherwise returns "yes". For example: - No: Template returns the contents of
|no=
, otherwise returns blank. For example: - Nothing: Template returns the contents of
|blank=
, or of|no=
in absence of the former; otherwise, returns blank. - Negation: Template returns the contents of
|¬=
, otherwise returns blank. For example:{{yesno|¬|¬=sausage}}
results in "sausage"
- Anything else: Template returns the contents of
|def=
, or of|yes=
in absence of the former; otherwise, returns "yes".
For the named parameters, use of a blank value is not the same as omitting the parameter. A blank named parameter tells the template that the customized return value is blank. For example:
{{yesno|purple monkey dish washer}}
results in "yes"{{yesno|purple monkey dish washer|def=}}
results in "" [blank]
Logical distinctions
Overview of {{yesno}} logical values and their associated texts
| ||||||
---|---|---|---|---|---|---|
Input parameter 1 ( 1= )
|
In code | Logical return value | Default return text |
Return text when set:yes=Pos no=Neg blank=Blank ¬=Undefined def=Def
|
Note | |
yes, y, true, 1* | {{yesno|yes}}
|
yes by definition
|
"yes" | "Pos" | * Case-insensitive (Y=y) | |
Some Text | {{yesno|Some Text}}
|
yes by default
|
"yes" | "Def" | "Pos" when def=[omitted]
| |
no, n, false, 0* | {{yesno|no}}
|
no by definition
|
"" [blank] | "Neg" | * Case-insensitive (N=n) | |
[blank] | {{yesno|}}
|
blank
|
"" [blank] | "Blank" | "Neg" when blank=[omitted]
| |
1=[blank] | {{yesno|1=}}
|
blank
|
"" [blank] | "Blank" | "Neg" when blank=[omitted]
| |
¬ | {{yesno|¬}}
|
¬
|
"" [blank] | "Undefined" | ||
[omitted] | {{yesno}}
|
¬
|
"" [blank] | "Undefined" |
Comparison with related templates | |||
---|---|---|---|
Input parameter 1 (1= )
|
{{yesno}} | {{yesno-yes}} | {{yesno-no}} |
yes, y, true, 1* | "yes" | "yes" | "yes" |
Some Text | "yes" | "yes" | "no" |
no, n, false, 0* | "" [blank] | "no" | "no" |
[blank] | "" [blank] | "yes" | "no" |
1=[blank] | "" [blank] | "yes" | "no" |
¬ | "" [blank] | "yes" | "no" |
[omitted] | "" [blank] | "yes" | "no" |
Full parameter list
Unnamed parameter 1= the input value to be evaluated. The other parameters (all named, all optional), are the return values for their respective logical outcome. When set, each one overrules their default return value.
{{yesno | | yes = | no = | blank= | ¬ = | def = }}
See also
- Module:yesno
{{Yesno2}}
– slower than Yesno, but can properly handle ref tags inside the parameters{{Yesno-yes}}
– variant of Yesno that defaults to "yes" if value is not explicitly negative{{Yesno-no}}
– variant of Yesno that defaults to "no" if value is not explicitly positive{{If affirmed}}
– also known as{{Ifyes}}
{{If declined}}
– also known as{{Ifno}}
TemplateData
TemplateData for Yesno-yes
This template normalises an input to be a yes/no output.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Input value | 1 | The value to be evaluated | String | required |
Output on yes | yes | Specifies the output of the template when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1' | String | optional |
Output on no | no | Specifies the output of the template when the input value is a case-insensitive forms of 'No', 'N', 'False, or '0' | String | optional |
Output on blank input | blank | Specifies the output of the template when the input value is defined but is either empty or contains nothing but whitespace character(s) | String | optional |
Output on ¬ | ¬ | Specifies the output of the template when the input value is either '¬' or entirely missing (undefined) | String | optional |
Definite output | def | Specifies the output of the template when the input value is defined but not a form of 'yes', 'no', '1', '0', '¬' or blank | String | optional |
The above documentation is transcluded from Template:Yesno/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Subpages of this template. |