Модуль:Yesno/doc

Данный модуль предоставляет единый интерфейс для обработки булевых или булевоподобных входных данных. Lua позволяет использовать логические значения Шаблон:Luatrue и false, в то время как шаблоны, написанные с помощью вики-разметки, часто используют обозначения, подобные «yes» и «no». Модуль преобразует подобные строки и выдаёт булевскую величину, пригодную для использования в Lua. Кроме того, возможно возвращаемое значение Шаблон:Luanil. В качестве входных данных могут использоваться другие структуры Lua, в том числе булевы переменные, числа, таблицы и функции. Кроме того, можно задать возвращаемое значение по умолчанию.

Синтаксис

Yesno(value, default)

value — проверяемая величина. Булевские и им подобные входные данные всегда приводят к Шаблон:Luatrue или false, Шаблон:Luanil возвращает Шаблон:Luanil. Остальным случаям соответствует default.

Использование

Для начала, загрузите модуль. Обратите внимание, что это можно сделать только из других модулей.

local yesno = require('Module:Yesno')

Некоторые значения всегда возвращают Шаблон:Luatrue, некоторые другие — false. Шаблон:Luanil всегда возвращает Шаблон:Luanil.

-- Всегда возвращают true:
Yesno('yes')
Yesno('y')
Yesno('true')
Yesno('t')
Yesno('да')
Yesno('д')
Yesno('+')
Yesno('1')
Yesno(1)
Yesno(true)

-- Всегда возвращают false:
Yesno('no')
Yesno('n')
Yesno('false')
Yesno('f')
Yesno('нет')
Yesno('н')
Yesno('-')
Yesno('0')
Yesno(0)
Yesno(false)

-- nil всегда возвращает nil:
Yesno(nil)

Строковые значения предварительно преобразуются к нижнему регистру:

-- Всегда возвращают true:
Yesno('Yes')
Yesno('YES')
Yesno('yEs')
Yesno('Y')
Yesno('tRuE')

-- Всегда возвращают false:
Yesno('No')
Yesno('NO')
Yesno('nO')
Yesno('N')
Yesno('fALsE')

Если yesno принимает аргумент, отличный от перечисленных выше, вы можете задать значение по умолчанию. Если оно не задано, для них будет возвращаться Шаблон:Luanil.

-- возвращают nil:
Yesno('foo')
Yesno({})
Yesno(5)
Yesno(function() return 'This is a function.' end)

-- возвращают  true:
Yesno('foo', true)
Yesno({}, true)
Yesno(5, true)
Yesno(function() return 'This is a function.' end, true)

-- возвращают "bar":
Yesno('foo', 'bar')
Yesno({}, 'bar')
Yesno(5, 'bar')
Yesno(function() return 'This is a function.' end, 'bar')

Обратите внимание на поведение при передаче пустой строки:

Yesno('')        -- Returns nil.
Yesno('', true)  -- Returns true.
Yesno('', 'bar') -- Returns "bar".

Хотя пустая строка в викитексте соответствует false, Lua ставит ей в соответствие Шаблон:Luatrue. Так же поступает и модуль. Поэтому для избежания подобных ошибок пустые строки должны отсеиваться до применения данного модуля.

См. также

• Шаблон:Yesno — шаблон с аналогичным функционалом, применяемый в других шаблонах, а не модулях; использует напрямую Шаблон:mwmw