Module:Yesno/doc/cs
More actions
{{#ifeq:cs|doc||{{#ifeq:cs |doc
|
{{#ifeq:show |show
|
File:Edit-copy green.svg | Template:Strong for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original {{#if: |{{{text2}}} |{{#if: |{{{text1}}} |{{#ifeq:Module |User |module template page |{{#if:Module |module page|article}}}}}}}}. |
}}{{#if: | | {{#ifexist:Module:Yesno/doc | [[Category:{{#switch:Module |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]] | }} }} | }}}}{{#switch:
| =
Template:Shared Template Warning
Template:High-risk
Template:Used in system
Template:Module rating
Template:Module rating
Tento modul poskytuje logické rozhraní pro zpracování booleovských hodnot nebo zadávání řetězce v booleovském stylu.
Zatímco Lua povoluje logické hodnoty true
a false
, šablony wikikódu mohou vyjadřovat booleovské hodnoty pouze prostřednictvím řetězců, jako jsou "1", "0", "yes", "no" atd.
Tento modul zpracovává tyto druhy řetězců a převádí je na booleovský vstup, který Lua zpracuje.
Vrátí také hodnoty nil
jako nil
, aby bylo možné rozlišovat mezi nil
a false
.
Modul také přijímá další struktury Lua jako vstup, tj. booleovské hodnoty, čísla, tabulky a funkce.
Pokud je předán vstup, který není rozpoznán jako booleovský nebo nil
, je možné zadat výchozí hodnotu, která se má vrátit.
Kvalita modulu
Syntaxe
<syntaxhighlight lang="lua"> yesno(value, default) </syntaxhighlight>
value
je hodnota, která má být testována.
Booleovský vstup nebo vstup v booleovském stylu (viz níže) se vždy vyhodnotí jako true
nebo false
a nil
se vždy vyhodnotí jako nil
.
Ostatní hodnoty jsou vyhodnoceny jako default
.
Použití
Nejprve načtěte modul. Všimněte si, že jej lze načíst pouze z jiných modulů Lua, nikoli z normálních wiki stránek.
Pro normální wiki stránky můžete místo toho použít {{yesno}}
.
<syntaxhighlight lang="lua"> local yesno = require('Module:Yesno') </syntaxhighlight>
Některé vstupní hodnoty vždy vrátí true
a některé vždy vrátí false
.
Hodnoty nil
vždy vrátí nil
.
<syntaxhighlight lang="lua"> -- Tyto vždy vrátí true: yesno('yes') yesno('y') yesno('true') yesno('t') yesno('1') yesno(1) yesno(true)
-- Tyto vždy vrátí false: yesno('no') yesno('n') yesno('false') yesno('f') yesno('0') yesno(0) yesno(false)
-- Hodnoty nil vždy vrátí nil. yesno(nil) </syntaxhighlight> Hodnoty řetězce jsou před přiřazením převedeny na malá písmena: <syntaxhighlight lang="lua"> -- Tyto vždy vrátí true: yesno('Yes') yesno('YES') yesno('yEs') yesno('Y') yesno('tRuE')
-- Tyto vždy vrátí false: yesno('No') yesno('NO') yesno('nO') yesno('N') yesno('fALsE') </syntaxhighlight>
Můžete zadat výchozí hodnotu, pokud yesno
obdrží jiný vstup, než je uvedeno výše.
Pokud nezadáte výchozí hodnotu, modul za tyto vstupy vrátí nil
.
<syntaxhighlight lang="lua"> -- Tyto vrátí nil: yesno('foo') yesno({}) yesno(5) yesno(function() return 'This is a function.' end)
-- Tyto vrátí true: yesno('foo', true) yesno({}, true) yesno(5, true) yesno(function() return 'This is a function.' end, true)
-- Tyto vrátí "bar": yesno('foo', 'bar') yesno({}, 'bar') yesno(5, 'bar') yesno(function() return 'This is a function.' end, 'bar') </syntaxhighlight> Všimněte si, že prázdný řetězec také funguje tímto způsobem: <syntaxhighlight lang="lua"> yesno() -- Vrací nil. yesno(, true) -- Vrací true. yesno(, 'bar') -- Vrací "bar". </syntaxhighlight>
I když je prázdný řetězec ve wikitextu obvykle vyhodnocen jako false
, má v Lua hodnotu true
.
Tento modul preferuje chování Lua před chováním wikitextu.
Pokud je pro váš modul důležité zacházet s prázdným řetězcem jako false
, budete muset odstranit prázdné argumenty v dřívější fázi zpracování.
| #default=
{{#switch:
| =
Template:Languages
Template:Shared Template Warning
Template:High-risk
Template:Used in system
Template:Module rating
Template:Module rating
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 "1", "0", "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.
Module Quality
Syntax
<syntaxhighlight lang="lua"> yesno(value, default) </syntaxhighlight>
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.
<syntaxhighlight lang="lua"> local yesno = require('Module:Yesno') </syntaxhighlight>
Some input values always return true
, and some always return false
.
nil
values always return nil
.
<syntaxhighlight lang="lua"> -- 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) </syntaxhighlight> String values are converted to lower case before they are matched: <syntaxhighlight lang="lua"> -- 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') </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 nil
for these inputs.
<syntaxhighlight lang="lua"> -- 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') </syntaxhighlight> Note that the blank string also functions this way: <syntaxhighlight lang="lua"> yesno() -- Returns nil. yesno(, true) -- Returns true. 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.
{{safesubst:#if:{{safesubst:#ifeq:cs|sandbox|1}}{{safesubst:#ifeq:cs|doc|1}}||
}}
| #default=
Lua error: expandTemplate: template loop detected.
}} }}