Хабадпедия:Луа
Расширение Scribunto, позволяющее писать модули на языке Lua и использовать их в шаблонах, было включено в ивритской Хабадпедии.
К сожалению, полезную документацию найти несколько трудно. Общая документация по языку Lua существует, но документацию, объясняющую использование в Хабадпедии, найти немного труднее.
Как это работает
В отличие от шаблонов, которые по сути являются «обычными» страницами и могут находиться в любом пространстве имён, модули обязаны находиться в новом пространстве имён, которое называется «Модуль» (по-английски module). Каждый модуль возвращает локальную переменную, разные поля которой — это функции, которыми могут пользоваться шаблоны.
Вот как выглядит модуль, который называется, скажем, M (то есть находится на странице Модуль:M) и экспортирует две функции: f1 и f2:
local m = {} -- you can use any name you want - it does not have to be identical to the module name
function m.f1(frame)
return "שלום לכולם"
end
-- these two ways to define the function are practically synonymous. the 2nd form below is more common.
m.f2 = function(frame)
return "להתראות"
end
-- this function cannot be called using #invoke, because it's not a member of m. it can be called from other functions in the module.
function f3(x)
return x * 2
end
-- however, we can expose a function, say, f4, by defining it first, and then adding it to m like so:
function something(frame)
-- do something
end
m.f4 = something
-- for Hebrew function names, use the following syntax:
m["עברית"] = function(frame)
return "שלום בעברית"
end
return m
Чтобы пользоваться модулем, есть новое «волшебное слово» под названием invoke. Этому слову нужно дать два параметра: название модуля и название функции. Кроме того, можно добавить дополнительные параметры по мере необходимости — эти дополнительные параметры будут переданы функции. Вот пример запуска функции f1 без параметров:
{{#invoke:M|f1}}
По-видимому, и у волшебного слова invoke будет перевод на иврит.
Передача параметров в функцию на Lua
Функция, вызываемая из invoke, всегда получает единственный параметр, который принято (хотя и не обязательно) называть frame. Этот параметр упаковывает в себе сведения, которые функция на lua может извлечь и использовать. Например, сведения о шаблоне, содержащем вызов invoke, упакованы в frame:getParent(). Подобным образом параметры, передаваемые из шаблона, упакованы в frame.args. Подобно параметрам шаблонов, параметры функции могут быть позиционными или именованными. Допустим, мы хотим передать функции king_wives три параметра: именной параметр под названием «מלך» и два позиционных параметра:
{{#invoke:m|king_wives|מלך=שלמה|40|25}}
Функция обращается к параметрам с помощью args:
function m.king_wives(frame)
local king = frame.args["מלך"]
local param1 = frame.args[1]
local param2 = frame.args[2]
-- do something with the parameters, e.g.:
return string.format("ל%s המלך היו %d נשים", king, param1 * param2)
end
Если вызвать функцию как в примере выше, получим на странице «У царя Шломо было 1000 жён».
В отличие от этого, вызов:
{{#invoke:m|king_wives|מלך=דוד|3|6}}
даст «У царя Давида было 18 жён».
Значение, возвращаемое функцией
Внутренние функции модуля могут возвращать значение какого угодно типа — ничего, число, строку, таблицу, булево значение или даже функцию. «Главная» функция, то есть такая, которая вызывается из вики-кода, должна возвращать строку. После вызова функции возвращённая строка передаётся парсеру (parser) для дальнейшей обработки. Смысл этого в том, что если функция хочет, например, нарисовать изображение, она не должна возвращать html-строку с тегом img, а строку в вики-коде, такую, какую вы поставили бы на странице — [[קובץ:שם הקובץ]]. Если функция хочет нарисовать таблицу, она возвращает вики-код таблицы. Подобным образом можно вернуть вызов шаблона и так далее.
Разработка и «песочница»
Расширение «Песочница для шаблонов» поддерживает и Scribunto. Иными словами, можно разрабатывать и проверять модули в пространстве участника до их переноса в пространство «Модуль»
Пояснение и пример
Участница משתמשת:אלמונית хочет разработать новый модуль под названием «אתגר» или проверить изменения, которые она хочет внести в существующий модуль с этим названием. Для этого она создаёт новую страницу под названием "משתמשת:אלמונית/ארגז חול/יחידה:אתגר". Обратите внимание на два тонких момента:
- Двоеточие в названии страницы, «выдающее себя» за обычное двоеточие, которое разделяет пространство имён и название страницы, — но в этом случае речь идёт не о странице в пространстве «Модуль», а о странице в пространстве участника, название которой содержит двоеточие.
- Когда название модуля используется латинскими буквами, название обязано начинаться с заглавной буквы, и вообще название чувствительно к регистру. При вызове модуля (то есть когда задействуется волшебное слово #invoke) система заменит первую букву в названии модуля, передаваемом в вызов, тем же символом, преобразованным в заглавную букву. В обычном модуле это же преобразование выполняется в названии самой страницы. При использовании «песочницы для шаблонов» первая буква в «названии модуля» на деле является буквой, стоящей в середине названия (то есть вместо названия страницы «אתגר» в пространстве «יחידה» название страницы на деле — יחידה:אתגר, в пространстве участника), и потому система не преобразует её автоматически в заглавную. Поскольку преобразование при вызове модуля всё же выполняется, ответственность за создание страницы с названием, начинающимся с заглавной буквы, лежит на участнице. Если название модуля на иврите, этой проблемы не существует.
Когда участница запрашивает отображение какой-либо страницы в Хабадпедии или вики-кода, введённого в соответствующее поле в «песочнице для шаблонов», отображаемая страница берётся не из кеш-памяти сервера, а вычисляется заново, причём для каждого используемого шаблона и модуля система проверяет, находится ли страница с подходящим названием под «префиксом песочницы». Если такие шаблон или модуль существуют, система воспользуется ими. Если нет — она воспользуется шаблоном или модулем, который существует под этим названием в пространстве шаблонов или модулей. В нашем примере «префикс песочницы» — это «משתמשת:אלמונית/ארגז חול», и потому, когда система встретит {{#invoke:אתגר|....}}, система запустит код, находящийся на странице «משתמשת:אלמונית/ארגז חול/יחידה:אתגר».
См. также
- Хабадпедия:Луа/Проверки
- Хабадпедия:Луа/Запросы на модули
- Список модулей см. в Служебная:Страницы, начинающиеся с/Модуль: