Template:Yesno/doc

Template:Cascade-protected template

Template:Template shortcut Template:Tlx (or {{YesNo}}) evaluates any input and produces a normalized yes or nil output, 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:

1. Yes: Case-insensitive forms of Yes, y, true, on, and 1; e.g. Template:Tlx → Template:Yesno
2. No: Case-insensitive forms of No, n, false, off, and 0; e.g. Template:Tlx → Template:Yesno
3. Nothing: When the input is defined but either contains no value or consists of whitespace character only; i.e. {{Yesno|}} or Template:Tlx → Template:Yesno
4. Negation: When the input is either ¬ (alt code 170) or entirely missing; i.e. Template:Tlx or Template:Tlx → Template:Yesno
5. Anything else: e.g. Template:Tlx → Template:Yesno

By default, the template returns "yes" in the first and last case but returns nil (blank, empty string) in the other cases.

Two short-hand templates for the most common uses that override the default behavior:

• Template:Tlx or {{YesNo-Yes}} – always returns "yes" (or the specified replacement result in Template:Para) unless an explicit negative value is given; i.e., it evaluates to "yes" even when the value is empty or missing.
• Template:Tlx or {{YesNo-No}} – always returns "no" (or the specified replacement result in Template:Para) 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: Template:Para, Template:Para, Template:Para, Template:Para and Template:Para. If these parameters are specified, the template response is as follows:

1. Yes: Template returns the contents of Template:Para, otherwise returns "yes". For example:
   • Template:Tlx results in "Template:Yesno"
   • Template:Tlx results in "Template:Yesno"
2. No: Template returns the contents of Template:Para, otherwise returns blank. For example:
   • Template:Tlx results in "Template:Yesno"
   • Template:Tlx results in "Template:Yesno"
3. Nothing: Template returns the contents of Template:Para, or of Template:Para in absence of the former; otherwise, returns blank.
   • Template:Tlx results in "Template:Yesno"
   • Template:Tlx results in "Template:Yesno"
   • Template:Tlx results in "Template:Yesno"
4. Negation: Template returns the contents of Template:Para, otherwise returns blank. For example:
   • Template:Tlx results in "Template:Yesno"
5. Anything else: Template returns the contents of Template:Para, or of Template:Para in absence of the former; otherwise, returns "yes".
   • Template:Tlx results in "Template:Yesno"
   • Template:Tlx results in "Template:Yesno"
   • Template:Tlx results in "Template:Yesno"

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:

• Template:Tlx results in "Template:Yesno"
• Template:Tlx results in "Template:Yesno" [blank]

Logical distinctions

Overview of Template:Tlx logical values and their associated texts
Input parameter 1 (<syntaxhighlight lang="text" class="" style="" inline="1">1=</syntaxhighlight>)	In code	Logical return value	Default return text		Return text when set: <syntaxhighlight lang="text" class="" style="" inline="1">yes=Pos</syntaxhighlight> <syntaxhighlight lang="text" class="" style="" inline="1">no=Neg</syntaxhighlight> <syntaxhighlight lang="text" class="" style="" inline="1">blank=Blank</syntaxhighlight> <syntaxhighlight lang="text" class="" style="" inline="1">¬=Undefined</syntaxhighlight> <syntaxhighlight lang="text" class="" style="" inline="1">def=Def</syntaxhighlight>	Note
yes, y, true, 1*	<syntaxhighlight lang="text" class="" style="" inline="1">{{yesno|yes}}</syntaxhighlight>	Template:Nowrap	"Template:Yesno"		"Template:Yesno"	* Case-insensitive (Y=y)
Template:Nowrap	Template:Nowrap	<syntaxhighlight lang="text" class="" style="" inline="1">yes by default</syntaxhighlight>	"Template:Yesno"		"Template:Yesno"	"Template:Yesno" when Template:Nowrap
no, n, false, 0*	<syntaxhighlight lang="text" class="" style="" inline="1">{{yesno|no}}</syntaxhighlight>	<syntaxhighlight lang="text" class="" style="" inline="1">no by definition</syntaxhighlight>	"Template:Yesno" [blank]		"Template:Yesno"	* Case-insensitive (N=n)
[blank]	<syntaxhighlight lang="text" class="" style="" inline="1">{{yesno|}}</syntaxhighlight>	<syntaxhighlight lang="text" class="" style="" inline="1">blank</syntaxhighlight>	"Template:Yesno" [blank]		"Template:Yesno"	"Template:Yesno" when Template:Nowrap
1=[blank]	<syntaxhighlight lang="text" class="" style="" inline="1">{{yesno|1=}}</syntaxhighlight>	<syntaxhighlight lang="text" class="" style="" inline="1">blank</syntaxhighlight>	"Template:Yesno" [blank]		"Template:Yesno"	"Template:Yesno" when Template:Nowrap
¬	<syntaxhighlight lang="text" class="" style="" inline="1">{{yesno|¬}}</syntaxhighlight>	<syntaxhighlight lang="text" class="" style="" inline="1">¬</syntaxhighlight>	"Template:Yesno" [blank]		"Template:Yesno"
[omitted]	<syntaxhighlight lang="text" class="" style="" inline="1">{{yesno}}</syntaxhighlight>	<syntaxhighlight lang="text" class="" style="" inline="1">¬</syntaxhighlight>	"Template:Yesno" [blank]		"Template:Yesno"

Comparison with related templates
Input parameter 1 (<syntaxhighlight lang="text" class="" style="" inline="1">1=</syntaxhighlight>)	Template:Tl	Template:Tl	Template:Tl
yes, y, true, 1*	"Template:Yesno"	"Template:Yesno-yes"	"Template:Yesno-no"
Template:Nowrap	"Template:Yesno"	"Template:Yesno-yes"	"Template:Yesno-no"
no, n, false, 0*	"Template:Yesno" [blank]	"Template:Yesno-yes"	"Template:Yesno-no"
[blank]	"Template:Yesno" [blank]	"Template:Yesno-yes"	"Template:Yesno-no"
1=[blank]	"Template:Yesno" [blank]	"Template:Yesno-yes"	"Template:Yesno-no"
¬	"Template:Yesno" [blank]	"Template:Yesno-yes"	"Template:Yesno-no"
[omitted]	"Template:Yesno" [blank]	"Template:Yesno-yes"	"Template:Yesno-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.

1. REDIRECT Template:Template journal

See also

• Template:Nowrap¬ NOT SIGN (¬)
• Module:yesno
• Template:Tlx – variant of Yesno that defaults to "yes" if value is not explicitly negative
• Template:Tlx – variant of Yesno that defaults to "no" if value is not explicitly positive

TemplateData

Template:TemplateData header <templatedata> { "description": "This template normalises an input to be a yes or nil output.", "params": { "1": { "label": "Input value", "description": "The value to be evaluated", "type": "string", "suggested": true }, "yes": { "label": "Output on yes", "description": "Specifies the output of the template when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1'", "type": "string", "required": false }, "no": { "label": "Output on no", "description": "Specifies the output of the template when the input value is a case-insensitive forms of 'No', 'N', 'False, or '0'", "type": "string", "required": false }, "blank": { "label": "Output on blank input", "description": "Specifies the output of the template when the input value is defined but is either empty or contains nothing but whitespace character(s)", "type": "string", "required": false }, "¬": { "label": "Output on ¬", "description": "Specifies the output of the template when the input value is either '¬' (negation) or entirely missing (undefined)", "type": "string", "required": false }, "def": { "label": "Definite output", "description": "Specifies the output of the template when the input value is defined but not a form of 'yes', 'no', '1', '0', '¬' or blank", "type": "string", "required": false } } } </templatedata>