Редактирование: Модуль:Yesno/doc

{{СИШ}}
{{Docpage}}

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

== Синтаксис ==
{{LuaCode|Yesno(value, default)}}

<code>value</code> — проверяемая величина. Булевские и им подобные входные данные всегда приводят к {{LuaTrue}} или {{LuaFalse}}, {{LuaNil}} возвращает {{LuaNil}}. Остальным случаям соответствует <code>default</code>.

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

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

Некоторые значения всегда возвращают {{LuaTrue}}, некоторые другие — {{LuaFalse}}. {{LuaNil}} всегда возвращает {{LuaNil}}.

{{LuaCode|
-- Всегда возвращают 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)
}}

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

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

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

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

{{LuaCode|
-- возвращают 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')
}}

Обратите внимание на поведение при передаче пустой строки:
{{LuaCode|
Yesno('')        -- Returns nil.
Yesno('', true)  -- Returns true.
Yesno('', 'bar') -- Returns "bar".
}}

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

== См. также ==
* [[Шаблон:Yesno]] — шаблон с аналогичным функционалом, применяемый в других шаблонах, а не модулях; использует напрямую {{Mwmw|#switch}}
<includeonly>[[Категория:Модули:Базовые]]</includeonly>