Template:Yesno-no

From GodWiki
Revision as of 04:00, 25 August 2018 by FeRDNYC (talk | contribs) (Another loaner from The Other Wiki)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

no

[view] [edit] [history] [refresh]
Documentation  Documentation

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

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

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

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 "" [blank]