Module:Yesno/doc/de

From Bonkipedia
< Module:Yesno‎ | doc
Revision as of 21:16, 28 May 2022 by [[mw:]]>ThisCarthing (Created page with "$1 ist der Wert, der getestet werden soll.")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
warning 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)

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.

Modul-Qualität

Syntax

yesno(value, default)

value ist der Wert, der getestet werden soll. 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.

Verwendung

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-Werte geben immer nil aus.

-- true-Werte geben immer true aus:
yesno('yes')
yesno('y')
yesno('true')
yesno('t')
yesno('1')
yesno(1)
yesno(true)

-- false-Werte geben immer false aus:
yesno('no')
yesno('n')
yesno('false')
yesno('f')
yesno('0')
yesno(0)
yesno(false)

-- Ein nil-Wert gibt immer nil aus:
yesno(nil)

String values are converted to lower case before they are matched:

-- true-Werte geben immer true aus:
yesno('Yes')
yesno('YES')
yesno('yEs')
yesno('Y')
yesno('tRuE')

-- false-Werte geben immer false aus:
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.

-- Diese geben nil aus:
yesno('foo')
yesno({})
yesno(5)
yesno(function() return 'This is a function.' end)

-- Diese geben true aus:
yesno('foo', true)
yesno({}, true)
yesno(5, true)
yesno(function() return 'This is a function.' end, true)

-- Diese geben "bar" aus:
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('')        -- Gibt nil aus:
yesno('', true)  -- Gibt true aus:
yesno('', 'bar') -- Gibt "bar" aus:

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.