Module:Yesno/doc/cs

Warning:

Do not edit. This page is maintained by an automated tool. All edits should be done at [[mw:{{{1}}}|mediawiki.org]]. (translate this warning)

Tento modul poskytuje konzistentní 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

• Diff sandbox code

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.