Модуль:Yesno/doc
Это страница документации Модуль:Yesno.
Внимание! Это один из самых используемых шаблонов. Каждое его изменение создаёт дополнительную нагрузку на серверы проекта. Пожалуйста, убедитесь в адекватности и правильности ваших изменений, проверьте их на тестовых страницах.
|
Данный модуль предоставляет единый интерфейс для обработки булевых или булевоподобных входных данных. Lua позволяет использовать логические значения Шаблон:Luatrue и Шаблон:Luafalse, в то время как шаблоны, написанные с помощью вики-разметки, часто используют обозначения, подобные «yes» и «no». Модуль преобразует подобные строки и выдаёт булевскую величину, пригодную для использования в Lua. Кроме того, возможно возвращаемое значение Шаблон:Luanil. В качестве входных данных могут использоваться другие структуры Lua, в том числе булевы переменные, числа, таблицы и функции. Кроме того, можно задать возвращаемое значение по умолчанию.
Синтаксис
value
— проверяемая величина. Булевские и им подобные входные данные всегда приводят к Шаблон:Luatrue или Шаблон:Luafalse, Шаблон:Luanil возвращает Шаблон:Luanil. Остальным случаям соответствует default
.
Использование
Для начала, загрузите модуль. Обратите внимание, что это можно сделать только из других модулей.
local yesno = require('Module:Yesno')
Некоторые значения всегда возвращают Шаблон:Luatrue, некоторые другие — Шаблон:Luafalse. Шаблон:Luanil всегда возвращает Шаблон:Luanil.
Строковые значения предварительно преобразуются к нижнему регистру:
Если yesno принимает аргумент, отличный от перечисленных выше, вы можете задать значение по умолчанию. Если оно не задано, для них будет возвращаться Шаблон:Luanil.
Обратите внимание на поведение при передаче пустой строки: Шаблон:LuaCode
Хотя пустая строка в викитексте соответствует Шаблон:Luafalse, Lua ставит ей в соответствие Шаблон:Luatrue. Так же поступает и модуль. Поэтому для избежания подобных ошибок пустые строки должны отсеиваться до применения данного модуля.
См. также
- Шаблон:Yesno — шаблон с аналогичным функционалом, применяемый в других шаблонах, а не модулях; использует напрямую Шаблон:Mwmw