模組:Yesno/doc

本模块提供用于处理布尔值或形如布尔值的字符串输入的一致接口。Lua允许布尔值true和false，wiki代码则只能用像yes、no这样的词语来表达布尔值。本模块处理这些字符串并将其转化为布尔值，以供Lua处理。对于nil值依旧返回nil，以允许区分nil和false。本模块同样接受其他的Lua结构输入，如布尔值、数字、表、函数。如果传入的值不能被理解为布尔值或nil，可以指定一个要返回的默认值。

语法

yesno(value, default)

value是需要测试的值。布尔值输入或类似于布尔值的输入（见下方）总是视为true或false，nil总是视为nil。其他的值一律取default。

用法

首先加载模块。注意只能由其他Lua模块加载，而不是一般的wiki页面。对于一般的wiki页面可以使用{{yesno}}。

local yesno = require('Module:Yesno')

一些输入总是返回true，一些则是返回false。nil值总是返回nil。

-- 这些总是返回true：
yesno('yes')
yesno('y')
yesno('true')
yesno('1')
yesno(1)
yesno(true)
yesno('是')
yesno('开')
yesno('開')

-- 这些总是返回false：
yesno('no')
yesno('n')
yesno('false')
yesno('0')
yesno(0)
yesno(false)
yesno('否')
yesno('关')
yesno('關')

-- nil值总是返回nil：
yesno(nil)

一些值在匹配之前转化为小写：

-- 这些总是返回true：
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')

-- 这些总是返回false：
yesno('No')
yesno('NO')
yesno('nO')
yesno('N')
yesno('fALsE')

未定义值

如果yesno收到一个上面没有列出的输入值，你可以指定一个默认值。如果不提供默认值，则这些输入会返回nil。

-- 这些会返回nil：
yesno('foo')
yesno({})
yesno(5)
yesno(function() return '这是函数' end)

-- 这些会返回true：
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return '这是函数' end, true)

-- 这些返回字符串"bar"：
yesno('foo', 'bar')
yesno({}, 'bar')
yesno(5, 'bar')
yesno(function() return '这是函数' end, 'bar')

注意空白字符串也是如此：

yesno('')        -- Returns nil.
yesno('', true)  -- Returns true.
yesno('', 'bar') -- Returns "bar".

尽管空字符串在维基文本中的计算结果通常为false，但在Lua中的仍是视为true。该模块倾向于Lua行为而不是维基文本行为。如果将空白字符串视为false 对您的模块很重要，则您需要在处理的早期阶段删除空白参数，例如Module:Arguments就会默认移除空白参数。

处理nil

根据定义，

yesno(nil)         -- Returns nil.
yesno('foo')       -- Returns nil.
yesno(nil, true)   -- Returns nil.
yesno(nil, false)  -- Returns nil.
yesno('foo', true) -- Returns true.

要返回仅有true/false的二元值，使用这样的代码：

myvariable = yesno(value) or false -- 若value为nil，则结果为false。
myvariable = yesno(value) or true  -- 若value为nil，则结果为true。
myvariable = yesno('foo') or false  -- 未知字符串返回nil，结果为false。
myvariable = yesno('foo', true) or false  -- 应用默认值（此处为true），结果为true。