Module:YesNo/doc

This module and the following documentation was imported from Module:Yesno at Wikipedia.

This module provides a consistent interface for processing boolean or boolean-style string input. While Lua allows the  and   boolean values, wikicode templates can only express boolean values through strings such as "yes", "no", etc. This module processes these kinds of strings and turns them into boolean input for Lua to process. It also returns  values as , to allow for distinctions between   and. The module also accepts other Lua structures as input, i.e. booleans, numbers, tables, and functions. If it is passed input that it does not recognise as boolean or, it is possible to specify a default value to return.

Syntax
is the value to be tested. Boolean input or boolean-style input (see below) always evaluates to either  or , and   always evaluates to. Other values evaluate to.

Usage
First, load the module. Note that it can only be loaded from other Lua modules, not from normal wiki pages. For normal wiki pages you can use yesno instead.

Some input values always return, and some always return. values always return.

String values are converted to lower case before they are matched:

Undefined input ('foo')
You can specify a default value if yesno receives input other than that listed above. If you don't supply a default, the module will return  for these inputs.

Note that the empty string also functions this way:

Although the empty string usually evaluates to false in wikitext, it evaluates to true in Lua. This module prefers the Lua behaviour over the wikitext behaviour. If treating the empty string as false is important for your module, you will need to convert empty strings to a value that evaluates to false before passing them to this module. In the case of arguments received from wikitext, this can be done by using Module:Arguments.

Handling nil results
By definition

To get the binary -only values, use code like: