Module:Yesno/doc

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:

You can specify a default value if yesno receives input other than that listed above. If you don't supply a default, the module yesno({}, true) yesno(5, true) yesno(function return 'This is a function.' end, true)

-- These return "bar": yesno('foo', 'bar') yesno({}, 'bar') yesno(5, 'bar') yesno(function return 'This is a function.' end, 'bar')

Note that the blank string also functions this way:

Although the blank string usually evaluates to false in wikitext, it evaluates to true in Lua. This module prefers the Lua behaviour over the wikitext behaviour. If