Module:Yesno/doc

From RTGame Wiki
< Module:Yesno
Revision as of 16:52, 2 May 2021 by .jim (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This is the documentation page for Module:Yesno

Module:Yesno is required by Module:DependencyList.
Module:Yesno is required by Module:For.
Module:Yesno is required by Module:Hatnote.
Module:Yesno is required by Module:Namespace detect.
Module:Yesno is required by Module:Ordinal.
Module:Yesno is required by Module:Pagetype.
Module:Yesno is required by Module:Shortcut.
Module:Yesno is required by 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.