imported>Oetterer |
|||
| Zeile 5: | Zeile 5: | ||
== Syntax == | == Syntax == | ||
| − | < | + | <syntaxhighlight lang="lua">yesno(value, default)</syntaxhighlight> |
<code>value</code> is the value to be tested. Boolean input or boolean-style input (see below) always evaluates to either <code>true</code> or <code>false</code>, and <code>nil</code> always evaluates to <code>nil</code>. Other values evaluate to <code>default</code>. | <code>value</code> is the value to be tested. Boolean input or boolean-style input (see below) always evaluates to either <code>true</code> or <code>false</code>, and <code>nil</code> always evaluates to <code>nil</code>. Other values evaluate to <code>default</code>. | ||
| Zeile 13: | Zeile 13: | ||
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 {{tl|yesno}} instead. | 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 {{tl|yesno}} instead. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local yesno = require('Module:Yesno') | local yesno = require('Module:Yesno') | ||
| − | </ | + | </syntaxhighlight> |
Some input values always return <code>true</code>, and some always return <code>false</code>. <code>nil</code> values always return <code>nil</code>. | Some input values always return <code>true</code>, and some always return <code>false</code>. <code>nil</code> values always return <code>nil</code>. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
-- These always return true: | -- These always return true: | ||
yesno('yes') | yesno('yes') | ||
| Zeile 28: | Zeile 28: | ||
yesno('wahr') | yesno('wahr') | ||
yesno('w') | yesno('w') | ||
| + | yesno('t') | ||
| + | yesno('on') | ||
yesno('1') | yesno('1') | ||
yesno(1) | yesno(1) | ||
| Zeile 39: | Zeile 41: | ||
yesno('falsch') | yesno('falsch') | ||
yesno('f') | yesno('f') | ||
| + | yesno('off') | ||
yesno('0') | yesno('0') | ||
yesno(0) | yesno(0) | ||
| Zeile 45: | Zeile 48: | ||
-- A nil value always returns nil: | -- A nil value always returns nil: | ||
yesno(nil) | yesno(nil) | ||
| − | </ | + | </syntaxhighlight> |
String values are converted to lower case before they are matched: | String values are converted to lower case before they are matched: | ||
| − | < | + | <syntaxhighlight lang="lua"> |
-- These always return true: | -- These always return true: | ||
yesno('Yes') | yesno('Yes') | ||
| Zeile 63: | Zeile 66: | ||
yesno('N') | yesno('N') | ||
yesno('fALsE') | yesno('fALsE') | ||
| − | </ | + | </syntaxhighlight> |
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 <code>nil</code> for these inputs. | 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 <code>nil</code> for these inputs. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
-- These return nil: | -- These return nil: | ||
yesno('foo') | yesno('foo') | ||
| Zeile 85: | Zeile 88: | ||
yesno(5, 'bar') | yesno(5, 'bar') | ||
yesno(function() return 'This is a function.' end, 'bar') | yesno(function() return 'This is a function.' end, 'bar') | ||
| − | </ | + | </syntaxhighlight> |
Note that the blank string also functions this way: | Note that the blank string also functions this way: | ||
| − | < | + | <syntaxhighlight lang="lua"> |
yesno('') -- Returns nil. | yesno('') -- Returns nil. | ||
yesno('', true) -- Returns true. | yesno('', true) -- Returns true. | ||
yesno('', 'bar') -- Returns "bar". | yesno('', 'bar') -- Returns "bar". | ||
| − | </ | + | </syntaxhighlight> |
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. | 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. | ||
| Zeile 100: | Zeile 103: | ||
<!-- Categories go here if not set by {{module rating}} above (in which case you can use default [[Category:modules]]. --> | <!-- Categories go here if not set by {{module rating}} above (in which case you can use default [[Category:modules]]. --> | ||
[[Category:Lua metamodules]] | [[Category:Lua metamodules]] | ||
| − | }}</includeonly> | + | }}</includeonly><!-- null edit comment; remove --> |
Aktuelle Version vom 5. Oktober 2022, 15:08 Uhr
 | This is a documentation subpage for Modul:Yesno. It contains usage information, categories and other content that is not part of the original modul page. |
 | 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. |
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[Quelltext bearbeiten]
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[Quelltext bearbeiten]
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('ja')
yesno('j')
yesno('wahr')
yesno('w')
yesno('t')
yesno('on')
yesno('1')
yesno(1)
yesno(true)
-- These always return false:
yesno('no')
yesno('n')
yesno('nein')
yesno('false')
yesno('falsch')
yesno('f')
yesno('off')
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.