Munurin millum rættingarnar hjá "Module:Yesno/doc"
EileenSanda (kjak | íkøst) Stovnaði síðu við "{{High-risk|nógvum}} This module provides a consistent interface for processing boolean or boolean-style string input. While Lua allows the <code>true</code> and <code>fa..." |
s Bot: Erstatt forældet <source> -tag og parameteren "enclose" [https://lists.wikimedia.org/pipermail/wikitech-ambassadors/2020-April/002284.html] |
||
Linja 4: | Linja 4: | ||
== 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>. |
||
Linja 12: | Linja 12: | ||
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> |
|||
</source> |
|||
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') |
||
Linja 39: | Linja 39: | ||
-- A nil value always returns nil: |
-- A nil value always returns nil: |
||
yesno(nil) |
yesno(nil) |
||
</syntaxhighlight> |
|||
</source> |
|||
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') |
||
Linja 57: | Linja 57: | ||
yesno('N') |
yesno('N') |
||
yesno('fALsE') |
yesno('fALsE') |
||
</syntaxhighlight> |
|||
</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 <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') |
||
Linja 79: | Linja 79: | ||
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> |
|||
</source> |
|||
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> |
|||
</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.<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
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.<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| |
Seinasta endurskoðan sum var 22. apr 2020 kl. 16:39
|
Henda Lua module verður nýtt á nógvum síðum. Fyri at sleppa undan stórum órógvi og óneyðugum server load, so eiga allar broytingar til hesa module fyrst at verða royndar í /sandbox ella /testcases subpages. Tá ið tú hevur sæð, hvussu broytingar tínar síggja út á einari royndarsíðu, so kunnu broytingarnar goymast á hesi síðu við bert einari rætting. Vinarliga umhugsa at kjakast um ætlaðar broytingar á kjaksíðuni áðrenn tú gert broytingar her. |
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
[rætta wikitekst]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
[rætta wikitekst]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.