模組:Yesno/doc

本模塊提供用於處理布爾值或形如布爾值的字符串輸入的一致接口。Lua允許布爾值true和false，wiki代碼則只能用像yes、no這樣的詞語來表達布爾值。本模塊處理這些字符串並將其轉化為布爾值，以供Lua處理。對於nil值依舊返回nil，以允許區分nil和false。本模塊同樣接受其他的Lua結構輸入，如布爾值、數字、表、函數。如果傳入的值不能被理解為布爾值或nil，可以指定一個要返回的默認值。

語法

<syntaxhighlight lang="lua">yesno(value, default)</syntaxhighlight>

value是需要測試的值。布爾值輸入或類似於布爾值的輸入（見下方）總是視為true或false，nil總是視為nil。其他的值一律取default。

用法

首先加載模塊。注意只能由其他Lua模塊加載，而不是一般的wiki頁面。對於一般的wiki頁面可以使用{{yesno}}。

<syntaxhighlight lang="lua"> local yesno = require('Module:Yesno') </syntaxhighlight>

一些輸入總是返回true，一些則是返回false。nil值總是返回nil。

<syntaxhighlight lang="lua"> -- 這些總是返回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) </syntaxhighlight>

一些值在匹配之前轉化為小寫：

<syntaxhighlight lang="lua"> -- 這些總是返回true： yesno('Yes') yesno('YES') yesno('yEs') yesno('Y') yesno('tRuE')

-- 這些總是返回false： yesno('No') yesno('NO') yesno('nO') yesno('N') yesno('fALsE') </syntaxhighlight>

未定義值

如果yesno收到一個上面沒有列出的輸入值，你可以指定一個默認值。如果不提供默認值，則這些輸入會返回nil。

<syntaxhighlight lang="lua"> -- 這些會返回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') </syntaxhighlight>

注意空白字符串也是如此： <syntaxhighlight lang="lua"> yesno() -- Returns nil. yesno(, true) -- Returns true. yesno(, 'bar') -- Returns "bar". </syntaxhighlight>

儘管空字符串在維基文本中的計算結果通常為false，但在Lua中的仍是視為true。該模塊傾向於Lua行為而不是維基文本行為。如果將空白字符串視為false 對您的模塊很重要，則您需要在處理的早期階段刪除空白參數，例如Module:Arguments就會默認移除空白參數。

處理nil

根據定義，

<syntaxhighlight lang="lua">

yesno(nil) -- Returns nil. yesno('foo') -- Returns nil. yesno(nil, true) -- Returns nil. yesno(nil, false) -- Returns nil. yesno('foo', true) -- Returns true. </syntaxhighlight>

要返回僅有<syntaxhighlight lang="lua" inline>true/false</syntaxhighlight>的二元值，使用這樣的代碼： <syntaxhighlight lang="lua"> 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。 </syntaxhighlight>