Template:Yesno/doc

From UBC Wiki

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

Usage

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

  1. Yes: Case-insensitive forms of "Yes", "y" and "1"; e.g. Script error: No such module "Tlg".
  2. No: Case-insensitive forms of "No", "n" and "0"; e.g. Script error: No such module "Tlg".
  3. Nothing: When the input is defined but either contains no value or consists of whitespace character only; i.e. Script error: No such module "Tlg". or Script error: No such module "Tlg".
  4. Negation: When the input is either "¬" or entirely missing; i.e. Script error: No such module "Tlg". or Script error: No such module "Tlg".
  5. Anything else: e.g. Script error: No such module "Tlg".

By default, the template returns "yes" in the first and last case but returns blank in the other cases.

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:

  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 |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 |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. Blank named parameters 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 ""

Logical distinctions

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

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  =
}}

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Yesno

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

Template parameters

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' or '1'

Stringoptional
Output on nono

Specifies the output of the template when the input value is a case-insensitive forms of 'No', 'N' 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