模組:Yesno/doc檢視原始碼檢視歷史
此頁面為 模块:Yesno 的說明文件
40px | 此Luazh-cn:模块; zh-tw:模組;在約16,000,000個頁面中使用。 為了避免困擾和不必要的服務器負載,所有變更都應該經過測試。請先在zh-cn:模块; zh-tw:模組;的/sandbox或者/testcases子頁面測試。測試過的內容可以一次更改。修改前請考慮至討論頁討論變更。 |
40x40px | This 模塊 is used in system messages. Changes to it can cause immediate changes to the 求真百科 user interface. To avoid large-scale disruption, any changes should first be tested in this 模塊's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this 模塊. Please discuss any changes on the talk page before implementing them. |
本模組已被保護。此為高度可見模組,其已用於大量條目或被頻繁替換引用。由於破壞或失誤會影響諸多頁面,即便細小的改動也可能導致大量服務器負載,因此已被保護,不可編輯。 |
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
yesno(value, default)
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.
local yesno = require('Module:Yesno')
Some input values always return true
, and some always return false
. nil
values always return nil
.
-- 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)
String values are converted to lower case before they are matched:
-- 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')
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.
-- 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')
Note that the blank string also functions this way:
yesno('') -- Returns nil.
yesno('', true) -- Returns true.
yesno('', 'bar') -- Returns "bar".
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.