Template:Yesno/doc

From Blockgame Wiki
Revision as of 18:05, 31 July 2024 by Nelas (talk | contribs) (Created page with "{{doc/start}} <code><nowiki>{{Yesno}}</nowiki></code> evaluates any input and produces a normalized <samp>yes</samp> or <samp>no</samp>, based on the content of the input and several configurable options. It is not used in article prose, but in coding complex templates. Template taken from Wikipedia:Template:Yesno == Usage == The template distinguishes five different types of input, supplied on the first unnamed parameter: # '''Yes''': Case-insensitive forms of <co...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Documentation

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

Template taken from Wikipedia:Template:Yesno

Usage

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

  1. Yes: Case-insensitive forms of Yes, y, true, t, on, and 1; e.g. {{Yesno|yEs}}
  2. No: Case-insensitive forms of No, n, false, f, off, and 0; e.g. {{Yesno|nO}}
  3. Nothing: When the input is defined but either contains no value or consists of whitespace character(s) 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. No returns blank by default for easy use in an #if check.

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]

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


This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.