Модуль:Yesno/doc

Материал из wikixw
Перейти к навигации Перейти к поиску

Это страница документации Модуль:Yesno.


doc

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

и

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

Синтаксис[править код]

КатегорияШаблоны:Языки программирования

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

или

, Шаблон:Luanil возвращает Шаблон:Luanil. Остальным случаям соответствует default.

Использование[править код]

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

local yesno = require('Module:Yesno')

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

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

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

Обратите внимание на поведение при передаче пустой строки: КатегорияШаблоны:Языки программирования

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

См. также[править код]

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