Хабадпедія:Луа
Розширення 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:אתגר|....}}, система запустить код, що міститься на сторінці «משתמשת:אלמונית/ארגז חול/יחידה:אתגר».
Див. також
- Хабадпедія:Луа/Перевірки
- Хабадпедія:Луа/Запити на модулі
- Список модулів див. у Спеціальна:Сторінки, що починаються з/Модуль: