Permanently protected template

Template:Yesno

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Documentation icon Template documentation[view] [edit] [history] [purge]

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. {{Yesno|yEs}}
  2. No: Case-insensitive forms of "No", "n" 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.

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
(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, 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, 0* {{yesno|no}} no by definition "" "Neg" * Case-insensitive (N=n)
<blank> {{yesno|}} blank "" "Blank" "Neg" when blank=<omitted>
1=<blank> {{yesno|1=}} blank "" "Blank" "Neg" when blank=<omitted>
¬ {{yesno|¬}} ¬ "" "Undefined"
<omitted> {{yesno}} ¬ "" "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  =
}}

See also

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Yesno

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

Template parameters
Parameter Description Type Default Auto value Status
Input value 1 The value to be evaluated string empty empty required
Output on yes yes Specifies the output of the template when the input value is a case-insensitive forms of 'Yes', 'Y' or '1' string empty empty optional
Output on no no Specifies the output of the template when the input value is a case-insensitive forms of 'No', 'N' or '0' string empty empty 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 empty empty optional
Output on ¬ ¬ Specifies the output of the template when the input value is either '¬' or entirely missing (undefined) string empty empty 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 empty empty optional