Module:Yesno/doc

This is a documentation subpage for 'Module:Yesno'.

It contains usage information, categories, and other content that is not part of the original module page.

Module:Yesno is required by 9 modules.

Module:Astronomical object, Module:DependencyList, Module:Format link, Module:Hatnote, Module:Namespace detect, Module:Ordinal, Module:Pagetype, Module:Shortcut, and Module:Time ago

Module:Yesno provides a consistent interface for processing boolean or boolean-style string input. While Lua allows the true and false 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 nil values as nil, to allow for distinctions between nil and false. 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 nil, it is possible to specify a default value to return.