Template:Yesno

From Meta, a Wikimedia project coordination wiki
Jump to: navigation, search
Template documentation[view] [edit] [history] [purge]

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

Usage[edit]

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

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 ""

Full parameter list[edit]

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

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

Template parameters

Parameter Description Type Status
Input value 1

The value to be evaluated

Default
empty
Example
empty
Auto value
empty
String required
Output on yes yes

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

Default
empty
Example
empty
Auto value
empty
String optional
Output on no no

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

Default
empty
Example
empty
Auto value
empty
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)

Default
empty
Example
empty
Auto value
empty
String optional
Output on ¬ ¬

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

Default
empty
Example
empty
Auto value
empty
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

Default
empty
Example
empty
Auto value
empty
String optional