Jump to content

Template:Yesno

Kusuka e Wikipedia
Template documentation[view] [edit] [history] [purge]

Template:High-risk

{{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.

The template distinguishes five different types of input, supplied on the first unnamed parameter:

  1. Yes: Case-insensitive forms of Yes, y, true, and 1; e.g. {{Yesno|yEs}}
  2. No: Case-insensitive forms of No, n, false, and 0; e.g. {{Yesno|nO}}
  3. Nothing: When the input is defined but either contains no value or consists of whitespace character only; i.e. {{Yesno|}} or {{Yesno| }}
  4. Negation: When the input is either ¬ or entirely missing; i.e. {{Yesno|¬}} or {{Yesno}}
  5. 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

[edit source]

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:

  1. Yes: Template returns the contents of |yes=, otherwise returns "yes". For example:
    • {{yesno|y|yes=Yeah}} results in "Yeah"
    • {{yesno|y|yes=bacon}} results in "bacon"
  2. No: Template returns the contents of |no=, otherwise returns blank. For example:
    • {{yesno|n|no=Nay}} results in "Nay"
    • {{yesno|n|no=ham}} results in "ham"
  3. Nothing: Template returns the contents of |blank=, or of |no= in absence of the former; otherwise, returns blank.
    • {{yesno|blank=eggs}} results in "eggs"
    • {{yesno|no=ham}} results in "ham"
    • {{yesno|blank=eggs|no=ham}} results in "eggs"
  4. Negation: Template returns the contents of |¬=, otherwise returns blank. For example:
    • {{yesno|¬|¬=sausage}} results in "sausage"
  5. Anything else: Template returns the contents of |def=, or of |yes= in absence of the former; otherwise, returns "yes".
    • {{yesno|purple monkey dish washer|def=cup of tea}} results in "cup of tea"
    • {{yesno|purple monkey dish washer|yes=bacon}} results in "bacon"
    • {{yesno|purple monkey dish washer|def=cup of tea|yes=bacon}} results in "cup of tea"

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 "" Template:Var

Logical distinctions

[edit source]
Overview of {{yesno}} logical values and their associated texts
Input
parameter 1
(Template:Code)
In code Logical return value Default
return text
Return text when set:
Template:Code
Template:Code
Template:Code
Template:Code
Template:Code
Note
yes, y, true, 1* Template:Code Template:Code "yes" "Pos" * Case-insensitive (Y=y)
Some Text Template:Code Template:Code "yes" "Def" "Pos" when def=Template:Var
no, n, false, 0* Template:Code Template:Code "" Template:Var "Neg" * Case-insensitive (N=n)
Template:Var Template:Code Template:Code "" Template:Var "Blank" "Neg" when blank=Template:Var
1=Template:Var Template:Code Template:Code "" Template:Var "Blank" "Neg" when blank=Template:Var
¬ Template:Code Template:Code "" Template:Var "Undefined"
Template:Var Template:Code Template:Code "" Template:Var "Undefined"
Comparison with related templates
Input parameter 1 (Template:Code) {{Subst:PAGENAME}} i tiko ra yesno.

{{{2}}}


Mintsaho

[edit source]
{{Subst:PAGENAME}} i tiko ra yesno-yes.

{{{2}}}

Template:Yesno-yes

Mintsaho

[edit source]
{{Subst:PAGENAME}} i tiko ra yesno-no.

{{{2}}}

no

Mintsaho

[edit source]
yes, y, true, 1* "yes" "Template:Yesno-yes" "yes"
Some Text "yes" "Template:Yesno-yes" "no"
no, n, false, 0* "" Template:Var "Template:Yesno-yes" "no"
Template:Var "" Template:Var "Template:Yesno-yes" "no"
1=Template:Var "" Template:Var "Template:Yesno-yes" "no"
¬ "" Template:Var "Template:Yesno-yes" "no"
Template:Var "" Template:Var "Template:Yesno-yes" "no"

Full parameter list

[edit source]

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

[edit source]
  • 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

TemplateData

[edit source]
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Yesno

This template normalises an input to be a yes/no output.

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Input value1

The value to be evaluated

Stringrequired
Output on yesyes

Specifies the output of the template when the input value is a case-insensitive forms of 'Yes', 'Y', 'True' or '1'

Stringoptional
Output on nono

Specifies the output of the template when the input value is a case-insensitive forms of 'No', 'N', 'False, or '0'

Stringoptional
Output on blank inputblank

Specifies the output of the template when the input value is defined but is either empty or contains nothing but whitespace character(s)

Stringoptional
Output on ¬¬

Specifies the output of the template when the input value is either '¬' or entirely missing (undefined)

Stringoptional
Definite outputdef

Specifies the output of the template when the input value is defined but not a form of 'yes', 'no', '1', '0', '¬' or blank

Stringoptional