Module:Yesno
40px | This {{
|Module=Lua module
|#default=template
}} is used on {{#if:14,100,000+ pages, which is {{#expr:(1414355100/163) round 0}}% of all|14,100,000+ pages, which is {{#expr:(1,414,355,100/163) round 0}}% of all|a very large number of}} pages.
|Module=module |#default=template }} should first be tested in its [[{{
| doc | sandbox = Module:Yesno | #default = Module:Yesno }}/sandbox|/sandbox]] or [[{{
| doc | sandbox = Module:Yesno | #default = Module:Yesno }}/testcases|/testcases]] subpages{{
|Module=. |#default= or in your own user subpage. }} The tested changes can then be added to this page in one single edit. Please consider discussing any changes {{#if:|at [[{{{2}}}]]|on the [[{{
| doc | sandbox = Module talk:Yesno | #default = Module talk:Yesno }}|talk page]]}} before implementing them. |
{{#switch:
{{#if: | | {{#ifeq:Module|Module | module | other }} }}| module =
{{#switch: protected
| pre-alpha | prealpha | pa = 40x40px | alpha | a = 26x26px | beta | b = 40x40px | release | r | general | g = 40x40px | protected | protect | p = [[File:Padlock{{#switch:Lua error in Module:Effective_protection_level at line 14: attempt to index local 'title' (a nil value).|autoconfirmed=-silver|accountcreator|templateeditor=-pink|}}.svg|40x40px|link=]]}} | {{#switch: protected
| pre-alpha | prealpha | pa = This module is rated as pre-alpha. It is unfinished, and may or may not be in active development. It should not be used from article namespace pages. Modules remain pre-alpha until the original editor (or someone who takes one over if it is abandoned for some time) is satisfied with the basic structure.{{#switch: Yesno|doc|sandbox= | {{#ifeq: | true | | }} }} | alpha | a = This module is rated as alpha. It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome.{{#switch: Yesno|doc|sandbox= | {{#ifeq: | true | | }} }} | beta | b = This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.{{#switch: Yesno|doc|sandbox= | {{#ifeq: | true | | }} }} | release | r | general | g = This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.{{#switch: Yesno|doc|sandbox= | {{#ifeq: | true | | }} }} | protected | protect | p = This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.{{#switch: Yesno|doc|sandbox= | {{#ifeq: | true | | }} }} | #default = Template:Error}} |
| other
| #default = Template:Error
}}
This module 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.
Syntax
<source lang="lua">yesno(value, default)</source>
value
is the value to be tested. Boolean input or boolean-style input (see below) always evaluates to either true
or false
, and nil
always evaluates to nil
. Other values evaluate to default
.
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.
<source lang="lua"> local yesno = require('Module:Yesno') </source>
Some input values always return true
, and some always return false
. nil
values always return nil
.
<source lang="lua"> -- These always return true: yesno('yes') yesno('y') yesno('true') yesno('t') yesno('1') yesno(1) yesno(true)
-- These always return false: yesno('no') yesno('n') yesno('false') yesno('f') yesno('0') yesno(0) yesno(false)
-- A nil value always returns nil: yesno(nil) </source>
String values are converted to lower case before they are matched:
<source lang="lua"> -- These always return true: yesno('Yes') yesno('YES') yesno('yEs') yesno('Y') yesno('tRuE')
-- These always return false: yesno('No') yesno('NO') yesno('nO') yesno('N') yesno('fALsE') </source>
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 nil
for these inputs.
<source lang="lua"> -- These return nil: yesno('foo') yesno({}) yesno(5) yesno(function() return 'This is a function.' end)
-- These return true: yesno('foo', true) 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') </source>
Note that the blank string also functions this way: <source lang="lua"> yesno() -- Returns nil. yesno(, true) -- Returns true. yesno(, 'bar') -- Returns "bar". </source>
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 treating the blank string as false is important for your module, you will need to remove blank arguments at an earlier stage of processing.{{#ifeq:Yesno|sandbox|| }}
-- Function allowing for consistent treatment of boolean-like wikitext input. -- It works similarly to the template {{yesno}}. return function (val, default) -- If your wiki uses non-ascii characters for any of "yes", "no", etc., you -- should replace "val:lower()" with "mw.ustring.lower(val)" in the -- following line. val = type(val) == 'string' and val:lower() or val if val == nil then return nil elseif val == true or val == 'yes' or val == 'y' or val == 'true' or val == 't' or tonumber(val) == 1 then return true elseif val == false or val == 'no' or val == 'n' or val == 'false' or val == 'f' or tonumber(val) == 0 then return false else return default end end