Модуль:Yesno/doc

Данный модуль предоставляет единый интерфейс для обработки булевых или булевоподобных входных данных. Lua позволяет использовать логические значения

<syntaxhighlight lang="lua" inline="1">true</syntaxhighlight> и

<syntaxhighlight lang="lua" inline="1">false</syntaxhighlight>, в то время как шаблоны, написанные с помощью вики-разметки, часто используют обозначения, подобные «yes» и «no». Модуль преобразует подобные строки и выдаёт булевскую величину, пригодную для использования в Lua. Кроме того, возможно возвращаемое значение <syntaxhighlight lang="lua" inline="1">nil</syntaxhighlight>. В качестве входных данных могут использоваться другие структуры Lua, в том числе булевы переменные, числа, таблицы и функции. Кроме того, можно задать возвращаемое значение по умолчанию.

Синтаксис

<syntaxhighlight lang="lua">yesno(value, default)</syntaxhighlight>

value — проверяемая величина. Булевские и им подобные входные данные всегда приводят к

<syntaxhighlight lang="lua" inline="1">true</syntaxhighlight> или

<syntaxhighlight lang="lua" inline="1">false</syntaxhighlight>, <syntaxhighlight lang="lua" inline="1">nil</syntaxhighlight> возвращает <syntaxhighlight lang="lua" inline="1">nil</syntaxhighlight>. Остальным случаям соответствует default.

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

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

<syntaxhighlight lang="lua"> local yesno = require('Module:Yesno') </syntaxhighlight>

Некоторые значения всегда возвращают

<syntaxhighlight lang="lua" inline="1">true</syntaxhighlight>, некоторые другие —

<syntaxhighlight lang="lua" inline="1">false</syntaxhighlight>. <syntaxhighlight lang="lua" inline="1">nil</syntaxhighlight> всегда возвращает <syntaxhighlight lang="lua" inline="1">nil</syntaxhighlight>.

<syntaxhighlight lang="lua"> -- Всегда возвращают 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) </syntaxhighlight>

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

<syntaxhighlight lang="lua"> -- Всегда возвращают true: yesno('Yes') yesno('YES') yesno('yEs') yesno('Y') yesno('tRuE')

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

Если yesno принимает аргумент, отличный от перечисленных выше, вы можете задать значение по умолчанию. Если оно не задано, для них будет возвращаться <syntaxhighlight lang="lua" inline="1">nil</syntaxhighlight>.

<syntaxhighlight lang="lua"> -- возвращают 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') </syntaxhighlight>

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

<syntaxhighlight lang="lua"> yesno() -- Returns nil. yesno(, true) -- Returns true. yesno(, 'bar') -- Returns "bar". </syntaxhighlight>

Хотя пустая строка в викитексте соответствует

<syntaxhighlight lang="lua" inline="1">false</syntaxhighlight>, Lua ставит ей в соответствие

<syntaxhighlight lang="lua" inline="1">true</syntaxhighlight>. Так же поступает и модуль. Поэтому для избежания подобных ошибок пустые строки должны отсеиваться до применения данного модуля.

См. также

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