Extension:Scribunto/Lua reference manual/uk

Ця довідка документує мову такою, якою вона використовується на MediaWiki з розширенням. Деякі частини були взяті з документації Lua 5.1, яка поширюється під ліцензією MIT.



Як розпочати
Створіть сторінку, яка починається із "Module:" (або "Модуль:" в україномовних проектах) в будь-якому вікіпроекті, який використовує рушій MediaWiki, і в якому включене розширення Scribunto, наприклад "Module:Bananas". Скопіюйте цей текст в цю сторінку:

Збережіть сторінку. Далі відкрийте будь-яку іншу сторінку (спрацює на будь-якій, але рекомендується на сторінці, яка починається із "Template:" або "Шаблон:") і скопіюйте туди такий текст:

при чому замість "Bananas" ви маєте написати назву тільки що створеного вами модуля. Цей текст викликає функцію "hello" з вашого модуля. Після збереження замість на екрані буде показуватись текст, який повернула функція, в даному випадку вона поверне текст "Hello, world!".

Вставляти виклики функцій Lua краще у шаблонах. В такому випадку зі сторінки викликається саме шаблон і сторінка не залежить від того чи реалізований шаблон на вікітексті чи за допомогою Lua. Також це дозволяє уникнути складного синтаксису в тексті сторінок основного простору.

Структура модуля
Сам модуль має повертати таблицю функцій, які можуть бути викликані через. Зазвичай, як це показано вище, оголошується локальна змінна в якій зберігається таблиця функцій. До цієї таблиці додаються функції і самому кінці коду модуля ця таблиця повертається.

Будь-які функції, які не були додані до таблиці, не залежно від того чи це локальні чи глобальні функції, не будуть доступними через, але глобальні функції можуть бути доступними в інших модулях при використанні функції. Оголошення всіх функцій та змінних локальними вважається гарним стилем написання коду.

Доступ до параметрів з вікітексту
Функціям, які викликаються за допомогою, передається єдиний параметр який є об'єктом фрейму. Щоб отримати доступ до параметрів переданих до , зазвичай використовується таблиця   цього об'єкта фрейма. Також можна отримати доступ до параметрів переданих шаблону, який містить, за допомогою методу  frame:getParent.

Також за допомогою об'єкта фрейма можна скористатися функціями вікітекстового парсеру, наприклад викликати функцію парсера, викликати шаблон або обробити рядок вікітексту.

Повернення тексту
Функції модуля зазвичай повертають один текстовий рядок. У випадку, якщо функція повертає не текстовий рядок або не одне значення, всі повернуті значення перетворюються на текст за допомогою функції tostring після чого об'єднуються (конкатенуються) в один рядок без символів розділення. Результуючий рядок включається до вікітексту як результат.

На цей момент всі шаблони вже мають бути викликаними, всі парсерні функції обробленими, всі перетворення (наприклад перетворення тильд на підпис) виконаними. Модуль не повинен повертати текст, який містить перелічене вище. Наприклад, якщо модуль повертає текст, то і на сторінці він відобразиться як ""Hello, world! ", а шаблон "welcome" викликаний не буде.

Окрім того, підстановки виконуються на ранній стадії обробки тексту, тому код  не спрацює одразу, а тільки після наступного редагування сторінки де він написаний.

Документація модулів
Scribunto дозволяє документувати модулі, автоматично асоціюючи модуль зі сторінкою документації написаною на вікітексті яка за замовчуванням має назву модуля із доданим "/doc" на кінці, наприклад для "Module:Bananas" сторінка документації буде називатися "Module:Bananas/doc". При перегляді сторінки модуля, його документація автоматично показується перед кодом модуля.

Відображення сторінки документації може бути налаштоване за допомогою повідомлень MediaWiki-простору:


 * scribunto-doc-page-name: встановлює сторінку, яка буде використовуватись як сторінка документації. Назву модуля (без префікса "Module:" або "Модуль:") можна отримати за допомогою кода . Якщо вказана сторінка документації знаходиться в просторі назв "Модуль:", то її вміст інтерпритуватиметься як вікітекст, а не код на Lua. Також на сторінці документації не має бути  . Значенням за замовчуванням є "Module:$1/doc", тобто підстрінка "/doc" модуля. При вказанні назви сторінки документації не можна використовувати шаблони або парсерні функції.
 * scribunto-doc-page-does-not-exist: повідомлення, яке буде показуватись, якщо сторінка документації не існує. Назву модуля (без префікса "Module:" або "Модуль:") можна отримати за допомогою кода . Значенням за замовчуванням є порожній рядок.
 * scribunto-doc-page-show: повідомлення, яке буде показуватись, якщо сторінка документації існує. Назву модуля (без префікса "Module:" або "Модуль:") можна отримати за допомогою кода . За замовчуванням текст сторінки документації включається до сторінки модуля.
 * scribunto-doc-page-header: заголовок, який показується тільки на самій сторінці документації. Назву модуля (з префіксом "Module:" або "Модуль:") можна отримати за допомогою кода . За замовчуванням показується невеличкий опис курсивним шрифтом.

Зверніть увагу, що модулі не можуть бути напряму категоризовані і не можуть мати інтервікі-посилання вказані прямо на сторінці. Категорії та інтервікі-посилання краще вставляти на сторінку документації всередині тегів. Тоді вони застосуються до модуля коли сторінка документації буде включена до сторінки модуля.

Назви змінних та ключові слова
Назви (їх також називають ідентифікаторами) в Lua можуть бути будь-яким текстовим рядком, який складається з літер, цифр або знаків підкреслювання і не починається з цифри. Назви є чутливими до регістру, тому "foo", "Foo" та "FOO" є різними назвами.

Ключові слова, які є зарезервованими і не можуть використовуватись як назви:



Назви, які починаються із знаку підкреслення та великої літери зарезервовані для внутрішніх змінних Lua.

Операторами в мові Lua є:



Коментарі
Коментар в коді на мові Lua починається з  будь-де, окрім всередині текстового рядка, і продовжується до кінця рядка. Якщо після  одразу йде довга відкриваюча дужка, то коментар продовжується до відповідної довгої закриваючої дужки.

Типи даних
Lua є мовою програмування із динамічною типізацією. Це означає що змінні та аргументи функцій не мають типу, тільки їх значення мають тип. Кожне значення має тип.

Lua має вісім типів даних, але тільки шість із них доречно використовувати в розширенні Scribunto. Функція  повертає тип переданого їй аргумента.

Функція  перетворює переданий їй аргумент в текстовий рядок. Функція  перетворює переданий їй аргумент в число якщо це можливо, в іншому випадку повертає nil.

Число автоматично перетворюється на текстовий рядок коли це число використовується там, де очікується текстовий рядок, наприклад при використанні оператора об'єднання рядків. Рядки, які можуть бути оброблені функцією, автоматично перетворюються в числа коли до них застосовуються математичні оператори. Коли очікується логічне значення, всі значення окрім nil та false вважаються правдивими.

nil
nil є спеціальним типом даних який позначає відсутність значення.

Його не можна використовувати як ключ в таблиці тому що не існує різниці між непозначеним ключем та ключем позначеним значенням nil.

Якщо nil перетворити на текстовий рядоку, то вийде "nil". Якщо його перетворити на логічне значення, то він вважається неправдивим.

Логічні значення
Існує тільки два логічних значення:  (правда) та   (неправда).

Якщо їх перетворити на текстовий рядок, то вийде відповідно "true" або "false".

На відміну від більшості інших мов програмування, логічні значення не можуть бути перетворені у числа. Також, на відміну від більшості інших мов програмування, тільки false та nil вважаються неправдивими, а всі інші значення, включаючи 0 та порожній текстовий рядок, вважаються правдивими.

Текстові рядки
Текстові рядки в Lua вважаються послідовностями байтів, які інтерпритуються як текст відповідно до певної системи кодування.

Значення рядків починаються і закінчуються одинарними або подвійними лапками ( or  ). Подібно до JavaScript і на відміну від PHP, між цима двома варіантами лапок немає різниці. Всередині текстового рядка розпізнаються такі керуючі послідовності:


 * (звуковий сигнал, байтове значення 7)
 * (повернення на крок або backspace, байтове значення 8)
 * (горизонтальна табуляція, байтове значення 9)
 * (зміна рядка, байтове значення 10)
 * (вертикальна табуляція, байтове значення 11)
 * (зміна сторінки, байтове значення 12)
 * (повернення каретки, байтове значення 13)
 * (подвійні лапки, байтове значення 34)
 * (одинарні лапки, байтове значення 39)
 * (обернений слеш, байтове значення 92)

Також зміну рядка можна включити до текстового рядка за допомогою обернененого слеша та власне зміни рядка. Байти також можуть бути вказані через їх числові значення за допомогою керуючих послідовностей виду "\ddd", де "ddd" є десятковим значенням байту в межах 0-255. Щоб за допомогою керуючих послідовностей включити до текстового рядка символи Unicode, треба вказувати окремі байти UTF-8, тому легше включити символи Unicode до текстового рядка прямо написавши їх.

Текстові рядки окрім лапок можуть також починатись і закінчуватись довгими дужками. Довга відкриваюча дужка складається з відкриваючої квадратної дужки, після якої йде нуль або більше пробілів, після яких йде ще одна відкриваюча квадратна дужка, наприклад,   або. Якщо текстовий рядок почався із довгої відкриваючої дужки, то він має закінчуватись відповідною довгою закриваючою дужкою, наприклад,   або. Якщо після довгої відкриваючої дужки одразу йде зміна рядка, то ця зміна рядка не включається до текстового рядка. Якщо ж зміна рядка йде одразу перед довгою закриваючою дужкою, то зміна рядка включається до текстового рядка. В текстових рядках на кінцях яких стоять довгі дужки, на відміну від лапок, не інтерпритуються керуючі послідовності.

Зверніть увагу що всі текстові рядки вважаються правдивими якщо їх перевести в логічне значення, на відміну від більшості інших мов програмування, де порожній текстовий рядок вважається неправдивим.

Числа
В Lua є тільки один числовий тип, який внутрішньо представлений числом з рухомою десятичною точкою із подвійною точністю. В цьому форматі цілі числа від -9007199254740992 до 9007199254740992 представлені точно, але числа поза цим діапазоном та дробові числа можуть бути викривлені через помилки округлення.

Числові значення можуть бути задані використовуючи точку в якості розділового знаку між цілою та дробною частинами, наприклад. Також числові значення можна задати використовуючи експоненціальний запис без пробілів, наприклад,   або. Цілі значення можна також задати в шістнадцятковій системі числення використовуючи префікс, наприклад.

Значення NaN разом із негативною та позитивною нескінченностями коректно зберігаються та обробляються. Константа  дорівнює позитивній нескінченності, яка також може бути отримана за допомогою , а за допомогою   можна отримати значення NaN.

Зверніть увагу, що всі числа вважаються правдивими якщо їх перевести в логічне значення, на відміну від більшості інших мов програмування, де 0 вважається неправдивим. Якщо переводити число в текстовий рядок, то всі кінцеві числа переводяться в їх десяткове представлення, можливо із використанням експоненціального запису, NaN переводиться в "nan" або "-nan", нескінченності переводяться в "inf" або "-inf".

Таблиці
Таблиці в Lua є асоціативними масивами (хешами) подібно до об'єктів в JavaScript та масивів в PHP.

Таблиці задаються за допомогою фігурних дужок. Порожню таблицю можна задати за допомогою коду. Щоб задати поля таблиці при її створенні, треба їх записати всередині фігурних дужок розділяючи їх комами або крапками з комами. Це можна зробити такими способами:


 * використовує (перше або єдине) значення "вираз1" як ключ та (перше або єдине) значення "вираз2" як значення.
 * є еквівалентним до.
 * є еквівалентним до, де "i" це ціле число яке починається з 1 та збільшується із кожним значенням заданим цим способом. Якщо це останнє поле таблиці та вираз має багато значень, то всі вони включаються до таблиці. В інакшому випадку включається тільки перше значення виразу.

Доступ до полів таблиці можна отримати за допомогою синтаксису квадратних дужок, наприклад. Якщо ключ є текстовим рядком який відповідає критеріям назви, то значення також можна отримати через синтаксис точки, наприклад, що є еквівалентним до. Виклик функції, яка є значенням в таблиці, можна виконати за допомогою синтаксису двокрапки, наприклад, що є еквівалентним до   або.

Послідовністю називають таблицю в якій задані значення (не nil) для всіх цілих чисел від 1 до N, а значення для чисел більших за N не задані або дорівнюють nil. Багато функцій Lua працює тільки із послідовностями та ігнорує ключі в таблицях, які не є додатніми цілими числами.

На відміну від більшості інших мов програмування, будь-яке значення окрім nil та NaN може бути використане як ключ таблиці. Значення не змінюють свій тип при використанні їх в якості ключів. Всі перелічені нижче способи задання значень в таблиці є правильними:

Подібно до ключів, будь-яке значення окрім nil може зберігатись в таблиці як значення. Присвоєння ключу таблиці значення nil еквівалентне видаленню цього ключа з таблиці. Також спроба звернутися до значення ключа, якому не було присвоєне значення, повертає nil.

Зверніть увагу, що в мові Lua не відбувається неявне копіювання таблиць. Якщо таблиця передається функції як аргумент і функція змінює цю таблицю, то зміни залишаються навіть після завершення роботи функції.

Якщо перевести таблицю в текстовий рядок, то результатом буде "table", хоча це може бути змінене перевизначенням метаметоду. Навіть порожня таблиця при переведенні в логічне значення вважається правдивою.

Функції
Функції в Lua є повноправними значеннями. Їх можна створювати анонімними, передавати як аргументи, присвоювати змінним і так далі.

Функції створюються за допомогою ключового слова  та викликаються за допомогою назви і дужок в кінці неї. Синтаксичний цукор доступний для іменованих функцій, локальних функцій та функцій які є значеннями в таблиці. Дивіться розділи "Оголошення функції" та "Виклик функцій" нижче.

Функції в Lua є замиканнями. Це означає що вони містять посилання на область видимості в якій вони були оголошені та можуть отримувати доступ і змінювати змінні в цій області видимості.

Подібно до таблиць, якщо функція присвоюється іншій змінній або передається іншій функції, то копія функції не створюється, а використовується той самий "об'єкт" функції.

Якщо перевести функцію в текстовий рядок, то результатом буде "function".

Типи, що не підтримуються
Тип даних "користувацькі дані" використовується щоб зберігати інформацію для розширень до Lua написаних на інших мовах програмування, наприклад цей тип даних може використовуватись щоб зберігати вказівник чи структуру з мови C. Розширення Scribunto використовується в середовищі, яке не дозволяє використання компільованого коду, тому в цьому типі даних немає потреби.

Тип даних "поток" призначений для паралельних обчислень, які не підтримуються в Scribunto.

Метатаблиці
Кожна таблиця може мати асоційовану з нею іншу таблицю яку називають "метатаблиця". Поля в метатаблицях використовуються деякими операторами і функціями та визначають поведінку таблиці, яка може відрізнятись від такої в інших таблиць. Метатаблиця певної таблиці може бути отримана за допомогою функції getmetatable, а встановлена за допомогою функції setmetatable.

При зверненні до метафункцій метатаблиці, вони повертаються так, ніби до них звернулись за допомогою функції rawget.

Поля метатаблиці, які впливають на саму таблицю:
 * __index
 * Використовується коли звернення до поля таблиці  повертає nil. Якщо значенням поля таблиці є інша таблиця, то буде повернуте значення цієї іншої таблиці за тим cамим ключем, тобто   (що може включати поле __index метатаблиці цієї таблиці). Якщо значенням поля таблиці є функція, вона буде викликана як через  . Функція rawget дозволяє обійти цей метаметод.


 * __newindex
 * Використовується при присвоєнні значення ключу таблиці коли   повернуло би nil. Якщо значенням поля таблиці є інша таблиця, то присвоєння повториться і в цій іншій таблиці, тобто   (що може включати поле __newindex метатаблиці цієї таблиці). Якщо значенням поля є функція, то вона буде викликана як через  . Функція rawset дозволяє обійти цей метаметод.


 * __call
 * Використовується коли до таблиці звертаються як до функції . Значенням поля __call має бути функція, яка викликається як через.


 * __mode
 * Використовується щоб створювати таблиці із слабкими посиланнями (такими, які ігноруються збирачем сміття). Значенням цього поля має бути текстовий рядок. За замовчуванням, жодне значення, яке використовується в таблиці як ключ або значення, не буде видалене збирачем сміття. Якщо текстовий рядок, який є значенням поля __mode, містить літеру 'k', то ключі таблиці можуть бути видалені якщо в таблиці немає сильних посилань. Якщо текстовий рядок містить літеру 'v', то те саме відбувається із значеннями. В обох випадках з таблиці видаляються ключ і значення, яке йому відповідає. Зверніть увагу, що ця поведінка стає невизначеною, якщо це поле змінюється після того, як таблиця була використана як метатаблиця.

Іншими полями метатаблиць є:


 * __add†
 * __sub†
 * __mul†
 * __div†
 * __mod†
 * __pow†
 * __unm
 * __concat†
 * __eq‡
 * __lt‡
 * __le‡
 * __pairs
 * __ipairs
 * __metatable*
 * __tostring

† Для бінарних операторів для пошуку метаметоду який треба використати, Lua спершу дивиться на метатаблицю першого аргумента, потім на метатаблицю другого. ‡ Для операторів відношення метаметод використовується тільки якщо одна і та сама функція задана в метатаблицях обох аргументів. Анонімні функції, навіть з однаковим тілом функції, можуть вважатися різними. * __metatable впливає як на getmetatable, так і на setmetatable.

Зверніть увагу, що в Lua всі текстові рядки мають спільну метатаблицю, в якій __index посилається на таблицю string. Ця метатаблиця недоступна в Scribunto, так само як і таблиця string. Таблиця string, яка доступна в модулях, є лише копією оригінальної таблиці.

Змінні
Змінною є область пам'яті де зберігається значення. В Lua існує три типи змінних: глобальні змінні, локальні змінні та поля таблиці.

Глобальні та локальні змінні представлені назвами (так само як і аргументи функції, які є одним із видів локальних змінних). Змінні вважаються глобальними якщо прямо не вказано що вони локальні використанням ключового слова. Будь-яка змінна, якій не присвоєно значення, вважається рівною nil.

Глобальні змінні зберігаються в стандартній таблиці Lua під назвою "environment". Ця таблиця також часто доступна як глобальна змінна. Можна встановити метатаблицю для цієї таблиці. Тоді метаметоди __index та __newindex будуть викликатися при кожному зверненні і зміненні глобальної змінної, так само як і для полів будь-якої таблиці.

Оточення функції може бути отримане за допомогою функції getfenv та змінене за допомогою setfenv. В Scribunto ці функції є значно обмеженими якщо вони взагалі доступні.

Локальні змінні мають власні області видимості. Дивіться Оголошення локальних змінних.

Вирази
Виразом є щось, що містить значення: літерали (числа, текстові рядки, true, false, nil), оголошення анонімних функцій, конструктори таблиць, посилання на змінні, виклики функцій, вираз для змінної кількості аргументів, вирази в дужках, унарні оператори застосовані до виразів та вирази поєднані із бінарними операторами.

Більшість виразів має лише одне значення. Виклики функцій та вирази для змінної кількості аргументів можуть мати будь-яку кількість значень. Зверніть увагу, що розміщення виклику функції або виразу для змінної кількості аргументів всередині дужок відкидує всі значення крім першого.

Списком виразів є список виразів розділений комами. Всі вирази в списку, окрім останнього, можуть мати лише одне значення, тобто всі інші значення відкидаються або вираз дорівнює nil якщо значень немає. Всі значення останнього виразу в списку стають значеннями списку виразів.

Арифметичні оператори
Lua підтримує звичайні математичні оператори: додавання, віднімання, множення, ділення, остача від ділення, зведення до степені та унарний мінус.

Коли всі операнди є числами або текстовими рядками, які функція tonumber може перетворити на числа, оператори матимуть своє звичайне математичне значення.

Якщо хоч один операнд є таблицею із відповідним метаметодом, то викликається цей метаметод.

Оператори відношення
Операторами відношення в Lua є,  ,  ,  ,   та. Результатом, який повертає оператор відношення, завжди є логічне значення.

Оператор рівності спершу порівнює типи свої операндів. Якщо вони різні, то повертається false. Якщо ні, то далі порівнюються значення. Функції вважаються рівними тільки якщо вони відсилаються до одного і того самого об'єкта функції. Наприклад  поверне false, оскільки порівнюються дві різні анонімні функції. Таблиці за замовчуванням порівнюються в той самий спосіб, але це можна змінити за допомогою метаметоду __eq.

Оператор нерівності є просто логічним запереченням до рівності.

Для операторів порядку якщо обидва операнди є числами або строками, вони порівнюються напряму. Якщо ні, то використовуються такі метаметоди:


 * використовує.
 * використовує  якщо він існує, або   якщо він існує (тоді вираз вважається рівним  ).
 * вважається рівним
 * вважається рівним

Якщо потрібні метаметоди не існують, то виникає помилка.

Логічні оператори
Логічними операторами є,   та. Всі вони використовують стандартну інтерпритацію, в якій nil та false вважаються неправдивими, а все інше правдивим.

Оператор  спочатку дивиться на лівий операнд. Якщо він є неправдивим, то оператор повертає false і другий операнд не обчислюється. В іншому випадку повертається значення другого операнда.

Оператор  теж спочатку дивиться на лівий операнд. Якщо він є правдивим, то оператор повертає true і другий операнд не обчислюється. В іншому випадку повертається значення другого операнда.

Оператор  повертає протилежне значення до значення свого операнда.

Зверніть увагу, що оператори  та   є скороченими. Наприклад, код  викличе функцію   тільки якщо   поверне неправдиве значення.

Оператор об'єднання текстових рядків
Оператор об'єднання текстових рядків представлений двома точками і має вигляд. Якщо обидва оператори є числами, то вони перетворюються на текстові рядки та об'єднуються. Якщо оператори не є ні текстовими рядками, ні числами, то для них викликається метаметод __concat. Якщо він не існує, то виникає помилка.

Зверніть увагу, що текстові рядки в Lua є незмінними, тому цикл, на кожній ітерації якого відбувається об'єднання текстових рядків, буде створювати новий текстовий рядок на кожній ітерації, а попередні рядки будуть видалені збирачем сміття. Якщо потрібно об'єднати одразу багато текстових рядків, то краще скористатися методом string.format або створити послідовність з текстових рядків та викликати метод table.concat для неї.

Оператор довжини
Оператор довжини представлений символом  і використовується в вигляді. Якщо  є текстовим рядком, то оператор повертає його довжину в байтах. Якщо  є послідовністю, то оператор повертає кількість полів в ній.

Якщо  є таблицею, але не послідовністю, то оператор може повернути будь-яке N таке, що   не дорівнює nil, а   дорівнює nil, навіть якщо існують поля з більшим ключем, значення яких не дорівнює nil. Наприклад:

Пріоритети операторів
Пріоритети операцій або черговість операцій в Lua від найвищого до найнижчого:


 * 1) not # - унарний мінус
 * 2) + - віднімання
 * 3) and
 * or
 * 1) and
 * or
 * 1) and
 * or

Всередині рівнів пріоритетності більшість бінарних операторів є ліво-асоціативними, тобто  трактується як. Зведення до степені та об'єднання текстових рядків є право-асоціативними, тобто  трактується як.

Виклик функції
Виклик функції в Lua виглядає так само, як і в більшості інших мов програмування, а саме назва функції після якої йде список параметрів в дужках.

func( список параметрів )

Аргументи функції є списком виразів, тому тільки останній вираз може мати більше одного значення.

Якщо функція викликається із меншою кількістю параметрів, ніж це зазначено в оголошенні функції, то зайві аргументи приймають значення nil. Якщо функція викликається із більшою кількістю параметрів, ніж зазначено в оголошенні, то зайві параметри відкидаються. Також функція може приймати змінну кількість аргументів, дивіться Оголошення функції.

Lua також дозволяє пряме звернення до значення, яке повертає функція, за допомогою синтаксису. Якщо функція повертає вираз, який є складнішим за звернення до однієї змінної, то замість змінної можна написати вираз в дужках.

В Lua є синтаксичний цукор виклику функції для двох загальних випадків. Перший випадок коли таблиця використовується як об'єкт, а функція, яку треба викликати, є методом об'єкту. Синтаксис

table:name( список параметрів )

еквівалентним до

table.name( table, список параметрів )

Другий випадок є методом імплементації іменованих аргументів передачею до функції таблиці, яка містить поля назва-значення. В випадку якщо до функції передається лише один аргумент, дужки можна не писати. Наприклад, виклики функцій

func{ arg1 = exp, arg2 = exp } func"string"

є еквівалентними до

func( { arg1 = exp, arg2 = exp } ) func( "string" )

Ці способи можна поєднувати. Наступні виклики функцій є еквівалентними

table:name{ arg1 = exp, arg2 = exp } table.name( table, { arg1 = exp, arg2 = exp } )

Оголошення функції
Синтаксис оголошення функції виглядає так:

function ( var-list ) block end

Всі змінні в var-list є локальними змінними функції і вони отримують значення зі списку аргументів при виклику функції. Додаткові локальні змінні можна оголосити всередині блоку функції.

Коли викликається функція, код всередині блоку функції виконується тільки після того, як всі локальні змінні з var-list створені та отримали значення. Якщо досягнуто виразу із твердженням return, то виконання коду функції зупиняється і вираз виклику функції приймає значення повернуте твердженням return. Якщо виконання коду функції доходить до кінця блоку, жодного разу не зустрівши твердження return, то вираз виклику функції має нуль значень.

Функції в Lua є замиканнями. Загальною практикою є оголошення "приватних статичних" змінних як локальних в області видимості, де оголошується функція. Наприклад

Функцію можна оголосити так, щоб вона приймала змінну кількість аргументів, за допомогою виразу, який має бути останнім в списку аргументів.

function ( список аргументів, ... ) блок коду end

Всередині блоку коду функції можна використовувати вираз, який повертатиме список всіх додаткових аргументів, переданих при виклику функції. Наприклад

Функція select працює із списками значень. Зокрема код  має використовуватись замість   для отримання кількості значень в списку.

В Lua є синтаксичний цукор для поєднання оголошення функції з її присвоєнням змінній. Дивіться Твердження оголошення функції.

Зверніть увагу, що такий код не працюватиме:

 local factorial = function ( n ) if n <= 2 then return n   else return n * factorial( n - 1 ) end end

Оскільки оголошення функції обробляється до присвоєння значення локальній змінній, "factorial" всередині тіла функції буде невизначеним. Цієї проблеми можна уникнути спочатку оголосивши локальну змінну, а в наступному твердженні присвоївши їй функцію або іншим методом описаним в розділі Твердження оголошення функції.

Твердження
Твердженням є основна одиниця виконання: одне присвоєння, контрольна структура, виклик функції, оголошення змінної, тощо.

Чанком є послідовність тверджень, розділених крапками з комами (необов'язково). Тіло анонімної фуркції є чанком, тому там можна оголошувати локальні змінні, отримувати аргументи та повертати значення.

Блоком це теж послідовність тверджень, як і чанк. Блок можна явно визначити за допомогою синтаксису. Це використовується для обмеження області видимості локальних змінних або щоб вставити твердження  чи   всередину іншого блоку.

Присвоєння
Список змінних є списком змінних, які розділених комами. Аналогічно список виразів. Всі вирази обчислюються до присвоєння, тому код  поміняє значення змінних a та b місцями.

Оголошення локальної змінної
Локальні змінні можна оголошувати будь-де всередині блоку або чанку. Перша форма оголошення, показана вище, просто оголошує змінні, але не присвоює їм значення, тому вони матимуть значення nil. Друга форма одразу після оголошення присвоює змінним значення так само, як описано вище в розділі Присвоєння вище.

Зверніть увагу що видимість локальної змінної починається із наступного твердження, після її оголошення. Тому код  оголошує локальну змінну x та присвоює їй значення глобальної змінної x. Область видимості локальної змінної продовжується до кінця найвнутрішнього блоку, в якому вона була оголошена.

Контрольні структури
Твердження while виконує блок коду знову і знову, поки значення виразу залишається правдивим.

Твердження repeat виконує блок коду знову і знову, поки значення виразу не стане правдивим. Локальні змінні оголошені всередині блока доступні і в виразі.

Перша форма циклу for оголошує локальну змінну, присвоює їй значення exp1 та повторює блок доки ця змінна не стане рівною чи більшою за exp2, на кожній ітерації збільшуючи змінну на exp3. Якщо вираз exp3 пропущено, то він вважається рівним 1. Всі вирази обчислюються один раз до початку виконання блоку коду.

Форма циклу for, яка показана вище, є еквівалентною до

do    local var, limit, step = tonumber( exp1 ), tonumber( exp2 ), tonumber( exp3 ) if not ( var and limit and step ) then error end while ( step > 0 and var <= limit ) or ( step <= 0 and var >= limit ) do        local name = var block var = var + step end end

окрім того, що змінні var, limit та step більше ніде не доступні. Зверніть увагу, що змінна name є локальною для цього блоку, тому щоб використовувати її значення після циклу, це значення треба скопіювати в змінну оголошену поза циклом.

Друга форма циклу for працює із функцією-ітератором. Як і в першій формі, всі вирази обчислюються один раз до початку виконання блоку коду.

Фома циклу for вказана вище є еквівалентною до

do    local func, static, var = expression-list while true do        local var-list = func( static, var ) var = var1 -- var це перша змінна в var-list if var == nil then break end block end end

окрім того, що знов ж таки змінні func, static та var більше ніде не доступні. Зверніть увагу, що змінні в var-list є локальними для цього блоку, тому щоб використовувати їх значення після циклу, ці значення треба скопіювати в змінні оголошені поза циклом.

Часто список виразів заміняють функцією, яка повертає три значення. Якщо можна написати ітератор так, щоб він залежав тільки від переданих йому аргументів, то краще так і зробити. В інакшому випадку Інструкція з програмування на Lua рекомендує використовувати замикання, яке буде змінювати значенням на кожній ітерації замість таблиці.

виконує блок1 якщо вираз exp1 є правдивим, інакше якщо вираз exp2 є правдивим виконує блок2. Якщо ні exp1, ні exp2 не є правдивими, то виконується блок3. можна пропустити, а  можна повторити стільки разів, скільки потрібно, чи теж пропустити.

Твердження return використовується щоб повертати значення з функцій або чанків. Список виразів є списком виразів, які розділені комами. Він може складатися з нуля чи більше виразів.

Lua implements tail calls: if expression-list consists of exactly one expression which is a function call, the current stack frame will be reused for the call to that function. This has implication for functions that deal with the call stack, such as  and.

The return statement must be the last statement in its block. If for some reason a return is needed in the middle of a block, an explicit block  may be used.

The break statement is used to terminate the execution of a while, repeat, or for loop, skipping to the next statement after the loop.

The break statement must be the last statement in its block. If for some reason a break is needed in the middle of a block, an explicit block  may be used.

Function calls as statements
A function call may be used as a statement; in this case, the function is being called only for any side effects it may have (e.g. mw.log logs values) and any return values are discarded.

Function declaration statements
Lua provides syntactic sugar to make declaring a function and assigning it to a variable more natural. The following pairs of declarations are equivalent

-- Basic declaration function func( var-list ) block end func = function ( var-list ) block end

-- Local function local function func( var-list ) block end local func; func = function ( var-list ) block end

-- Function as a field in a table function table.func( var-list ) block end table.func = function ( var-list ) block end

-- Function as a method in a table function table:func( var-list ) block end table.func = function ( self, var-list ) block end

Note the colon notation here parallels the colon notation for function calls, adding an implicit argument named "self" at the beginning of the arguments list.

Error handling
Errors may be "thrown" using the error and assert functions. To "catch" errors, use pcall or xpcall. Note that certain internal Scribunto errors cannot be caught in Lua code.

Garbage collection
Lua performs automatic memory management. This means that you have to worry neither about allocating memory for new objects nor about freeing it when the objects are no longer needed. Lua manages memory automatically by running a garbage collector from time to time to collect all dead objects (that is, objects that are no longer accessible from Lua) and objects that are only reachable via weak references. All memory used by Lua is subject to automatic management: tables, functions, strings, etc.

Garbage collection happens automatically, and cannot be configured from within Scribunto.

Standard libraries
The standard Lua libraries provide essential services and performance-critical functions to Lua. Only those portions of the standard libraries that are available in Scribunto are documented here.

_G


This variable holds a reference to the current global variable table; the global variable  may also be accessed as. Note, however, that there is nothing special about _G itself; it may be reassigned in the same manner as any other variable:

The global variable table may be used just like any other table. For example,

_VERSION


A string containing the running version of Lua, e.g. "Lua 5.1".

assert
If  is nil or false, issues an error. In this case,  is used as the text of the error: if nil (or unspecified), the text is "assertion failed!"; if a string or number, the text is that value; otherwise assert itself will raise an error.

If  is any other value, assert returns all arguments including   and.

A somewhat common idiom in Lua is for a function to return a "true" value in normal operation, and on failure return nil or false as the first value and an error message as the second value. Easy error checking can then be implemented by wrapping the call in a call to :

error
Issues an error, with text.

normally adds some information about the location of the error. If  is 1 or omitted, that information is the location of the call to   itself; 2 uses the location of the call of the function that called error; and so on. Passing 0 omits inclusion of the location information.

getfenv
Note this function may not be available, depending on  in the engine configuration.

Returns an environment (global variable table), as specified by :


 * If 1, nil, or omitted, returns the environment of the function calling . Often this will be the same as _G.
 * Integers 2–10 return the environment of functions higher in the call stack. For example, 2 returns the environment for the function that called the current function, 3 returns the environment for the function calling that function, and so on. An error will be raised if the value is higher than the number of function calls in the stack, or if the targeted stack level returned with a tail call.
 * Passing a function returns the environment that will be used when that function is called.

The environments used by all standard library functions and Scribunto library functions are protected. Attempting to access these environments using  will return nil instead.

getmetatable
Returns the metatable of a table. Any other type will return nil.

If the metatable has a  field, that value will be returned instead of the actual metatable.

ipairs
Returns three values: an iterator function, the table, and 0. This is intended for use in the iterator form of :

for i, v in ipairs( t ) do    block end

This will iterate over the pairs ( 1, t[1] ), ( 2, t[2] ), and so on, stopping when t[i] would be nil.

The standard behavior may be overridden by providing an  metamethod. If that metamethod exists, the call to ipairs will return the three values returned by  instead.

next
This allows for iterating over the keys in a table. If  is nil or unspecified, returns the "first" key in the table and its value; otherwise, it returns the "next" key and its value. When no more keys are available, returns nil. It is possible to check whether a table is empty using the expression.

Note that the order in which the keys are returned is not specified, even for tables with numeric indexes. To traverse a table in numerical order, use a numerical for or ipairs.

Behavior is undefined if, when using next for traversal, any non-existing key is assigned a value. Assigning a new value (including nil) to an existing field is allowed.

pairs
Returns three values: an iterator function (next or a work-alike), the table, and nil. This is intended for use in the iterator form of :

This will iterate over the key-value pairs in  just as next would; see the documentation for next for restrictions on modifying the table during traversal.

The standard behavior may be overridden by providing a __pairs metamethod. If that metamethod exists, the call to pairs will return the three values returned by  instead.

pcall
Calls the function  with the given arguments in protected mode. This means that if an error is raised during the call to, pcall will return false and the error message raised. If no error occurs, pcall will return true and all values returned by the call.

In pseudocode,  might be defined something like this:

rawequal
This is equivalent to  except that it ignores any __eq metamethod.

rawget
This is equivalent to  except that it ignores any __index metamethod.

rawset
This is equivalent to  except that it ignores any __newindex metamethod.

select
If  is a number, returns all arguments in   after that index. If  is the string '#', returns the count of arguments in.

In other words,  is something roughly like the following except that it will work correctly even when   contains nil values (see documentation for # and unpack for the problem with nils).

setmetatable
Sets the metatable of a table. may be nil, but must be explicitly provided.

If the current metatable has a __metatable field,  will throw an error.

tonumber
Tries to convert  to a number. If it is already a number or a string convertible to a number, then  returns this number; otherwise, it returns nil.

The optional  (default 10) specifies the base to interpret the numeral. The base may be any integer between 2 and 36, inclusive. In bases above 10, the letter 'A' (in either upper or lower case) represents 10, 'B' represents 11, and so forth, with 'Z' representing 35.

In base 10, the value may have a decimal part, be expressed in E notation, and may have a leading "0x" to indicate base 16. In other bases, only unsigned integers are accepted.

tostring
Converts  to a string. See Data types above for details on how each type is converted.

The standard behavior for tables may be overridden by providing a __tostring metamethod. If that metamethod exists, the call to tostring will return the single value returned by  instead.

type
Returns the type of  as a string: ,  ,  ,  ,  , or.

unpack
Returns values from the given table, something like  would do if written out manually. If nil or not given,  defaults to 1 and   defaults to.

Note that results are not deterministic if  is not a sequence and   is nil or unspecified; see Length operator for details.

xpcall
This is much like, except that the error message is passed to the function   before being returned.

In pseudocode,  might be defined something like this:

debug.traceback
Returns a string with a traceback of the call stack. An optional message string is appended at the beginning of the traceback. An optional level number tells at which stack level to start the traceback.

math.abs
Повертає модуль (абсолютне значення).

math.acos
Повертає арккосинус  (в радіанах).

math.asin
Повертає арксинус  (в радіанах).

math.atan
Повертає арктангенс  (в радіанах).

math.atan2
Повертає арктангенс  (в радіанах), використовуючи знаки обох аргументів для визначення того, в якій чверті знаходиться відповідь.

math.ceil
Повертає найменше ціле число, яке більше чи рівне  (округлення в більшу сторону).

math.cos
Повертає косинус  (x задається в радіанах).

math.cosh
Повертає гіперболічний косинус.

math.deg
Переводить величину кута із радіанів в градуси.

math.exp
Повертає $$e^x$$.

math.floor
Повертає найменше ціле число, яке менше чи рівне  (округлення в меншу сторону).

math.fmod
Повертає остачу від ділення  на , з часткою округленою в сторону нуля.

math.frexp
Повертає два значення  та   такі, що:


 * Якщо  є кінцевим числом і не є нулем: $$x = m \times 2^e$$, де   ціле число, а абсолютне значення   лежить на проміжку $$[0.5, 1)$$.
 * Якщо  дорівнює нулю:   та   обидва дорівнюють нулю.
 * Якщо  дорівнює NaN або нескінченності:   дорівнює , а   дорівнює nil.

math.huge
Значення яке представляє додатню нескінченність. Це значення є рівним чи більшим за будь-яке інше числове значення.

math.ldexp
Повертає $$m \times 2^e$$ ( має бути цілим числом).

math.log
Повертає натуральний логарифм.

math.log10
Повертає десятковий логарифм.

math.max
Повертає найбільший аргумент із переданих.

Поведінка щодо NaN не визначена. В поточній реалізації функція поверне NaN якщо  дорівнює NaN, але всі інші NaN будуть проігноровані.

math.min
Повертає найменший аргумент із переданих.

Поведінка щодо NaN не визначена. В поточній реалізації функція поверне NaN якщо  дорівнює NaN, але всі інші NaN будуть проігноровані.

math.modf
Повертає два числа, які є відповідно цілою та дробною частинами.

math.pi
Повертає значення числа $$\pi$$.

math.pow
Еквівалентне до.

math.rad
Переводить величину кута із градусів в радіани.

math.random
Повертає псевдовипадкове число в межах від  до.

Аргументи  та   можна пропустити, але якщо вони задані, то мають бути числами або значеннями які можна перевести в числа.


 * Якщо жоден аргумент не заданий, повертає випадкове число в межах $$[0,1)$$.
 * Якщо задано лише один аргумент, повертає випадкове ціле число в межах $$[1,m]$$.
 * Якщо задані обидва аргументи, повертає випадкове ціле число в межах $$[m,n]$$.

math.randomseed
Встановлює  як зерно для генератора псевдовипадкових чисел.

Зверніть увагу, що використання однакового зерна змусить  видавати однакові послідовності чисел.

math.sin
Повертає синус  (x задається в радіанах).

math.sinh
Повертає гіперболічний синус.

math.sqrt
Повертає квадратний корінь. Еквівалентне до.

math.tan
Повертає тангенс  (x задається в радіанах).

math.tanh
Повертає гіперболічний тангенс.

os.clock
Повертає приблизний час виконання програми процесором в секундах.

os.date

 * formatDate з бібліотеки мов може бути використаний для складнішого форматування дати

Повертає текстовий рядок або таблицю, що містить дату і час, відформатовані відповідно до значення вказаного в змінній. Якщо ця змінна пропущена або дорівнює nil, то за замовчуванням використовується "%c".

Якщо задана змінна, то саме час вказаний в цій змінній форматується (дивіться  ). В іншому випадку форматується поточний час.

Якщо змінна  починається із символу '!', то дата форматується в форматі UTC а не в місцевому форматі. Якщо після цього символу або на самому початку рядка йде "*t", то дата повертається у вигляді таблиці з такими полями:


 * year (рік)
 * month (номер місяця в межах 1–12)
 * day (день місяця в межах 1–31)
 * hour (години в межах 0–23)
 * min (хвилини в межах 0–59)
 * sec (секунди в межах 0–60)
 * wday (номер дня тижня, де Неділя має номер 1)
 * yday (день року)
 * isdst (логічне значення яке вказує на те чи використовується літній та зимовий час)

Якщо змінна  не дорівнює "!", "*t" або "!*t", то дата форматується так само, як би це зробила функція strftime в мові програмування C.

os.difftime
Повертає різницю між моментами часу  та   в секундах.

os.time
Повертає поточний час у вигляді часу Unix.

Якщо функція викликана без аргументів, повертається число для поточного часу. Якщо функції передано таблицю, то повертається число для часу вказаного в таблиці. Таблиця має містити поля "year", "month" та "day", а також може містити поля "hour" (за замовчуванням 12), "min" (за замовчуванням 0), "sec" (за замовчуванням 0) та "isdst".

require
Завантажує вказаний модуль.

Спочатку функція шукає значення для назви модуля в таблиці щоб перевірити чи був вже завантажений цей модуль. Якщо був, то повертається значення.

В іншому випадку функція перевіряє кожен завантажувач з послідовності  щоб знайти підходящий завантажувач для модуля. Якщо потрібний завантажувач знайдено, то він викликається і повертає значення.

Дивіться документацію по  для інформації про доступні завантажувачі.

Note that every required module is loaded in its own sandboxed environment, so it cannot export global variables as is sometimes done in Lua 5.1. Instead, everything that the module wishes to export should be included in the table returned by the module.

For example, if you have a module "Module:Giving" containing the following:

You can load this in another module with code such as this:

package.loaded
This table holds the loaded modules. The keys are the module names, and the values are the values returned when the module was loaded.

package.loaders
This table holds the sequence of searcher functions to use when loading modules. Each searcher function is called with a single argument, the name of the module to load. If the module is found, the searcher must return a function that will actually load the module and return the value to be returned by require. Otherwise, it must return nil.

Scribunto provides two searchers:


 * 1) Look in   for the loader function
 * 2) Look in the modules provided with Scribunto for the module name, and if that fails look in the Module: namespace. The "Module:" prefix must be provided.

Note that the standard Lua loaders are not included.

package.preload
This table holds loader functions, used by the first searcher Scribunto includes in package.loaders.

package.seeall
Sets the __index metamethod for  to _G.

String library
In all string functions, the first character is at position 1, not position 0 as in C, PHP, and JavaScript. Indexes may be negative, in which case they count from the end of the string: position -1 is the last character in the string, -2 is the second-last, and so on.

The string library assumes one-byte character encodings. It cannot handle Unicode characters. To operate on Unicode strings, use the corresponding methods in the Scribunto Ustring library.

string.byte
If the string is considered as an array of bytes, returns the byte values for,  , ···,. The default value for  is 1; the default value for  is. Identical to mw.ustring.byte.

string.char
Receives zero or more integers. Returns a string with length equal to the number of arguments, in which each character has the byte value equal to its corresponding argument.

See mw.ustring.char for a similar function that uses Unicode codepoints rather than byte values.

string.find
Looks for the first match of  in the string. If it finds a match, then  returns the offsets in   where this occurrence starts and ends; otherwise, it returns nil. If the pattern has captures, then in a successful match the captured values are also returned after the two indices.

A third, optional numerical argument  specifies where to start the search; its default value is 1 and can be negative. A value of true as a fourth, optional argument  turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in   being considered "magic".

Note that if  is given, then   must be given as well.

See mw.ustring.find for a similar function extended as described in Ustring patterns and where the  offset is in characters rather than bytes.

string.format
Returns a formatted version of its variable number of arguments following the description given in its first argument (which must be a string).

The format string uses a limited subset of the format specifiers:


 * Recognized flags are '-', '+', ' ', '#', and '0'.
 * Integer field widths up to 99 are supported. '*' is not supported.
 * Integer precisions up to 99 are supported. '*' is not supported.
 * Length modifiers are not supported.
 * Recognized conversion specifiers are 'c', 'd', 'i', 'o', 'u', 'x', 'X', 'e', 'E', 'f', 'g', 'G', 's', '%', and the non-standard 'q'.
 * Positional specifiers (e.g. "%2$s") are not supported.

The conversion specifier 'q' is like 's', but formats the string in a form suitable to be safely read back by the Lua interpreter: the string is written between double quotes, and all double quotes, newlines, embedded zeros, and backslashes in the string are correctly escaped when written.

Conversion between strings and numbers is performed as specified in Data types; other types are not automatically converted to strings. Strings containing NUL characters (byte value 0) are not properly handled.

Identical to mw.ustring.format.

string.gmatch
Returns an iterator function that, each time it is called, returns the next captures from  over string. If  specifies no captures, then the whole match is produced in each call.

For this function, a ' ' at the start of a pattern is not magic, as this would prevent the iteration. It is treated as a literal character.

See mw.ustring.gmatch for a similar function for which the pattern is extended as described in Ustring patterns.

string.gsub
Returns a copy of  in which all (or the first , if given) occurrences of the   have been replaced by a replacement string specified by  , which can be a string, a table, or a function. also returns, as its second value, the total number of matches that occurred.

If  is a string, then its value is used for replacement. The character  works as an escape character: any sequence in   of the form  , with n between 1 and 9, stands for the value of the n-th captured substring. The sequence  stands for the whole match, and the sequence   stands for a single.

If  is a table, then the table is queried for every match, using the first capture as the key; if the pattern specifies no captures, then the whole match is used as the key.

If  is a function, then this function is called every time a match occurs, with all captured substrings passed as arguments, in order; if the pattern specifies no captures, then the whole match is passed as a sole argument.

If the value returned by the table query or by the function call is a string or a number, then it is used as the replacement string; otherwise, if it is false or nil, then there is no replacement (that is, the original match is kept in the string).

See mw.ustring.gsub for a similar function in which the pattern is extended as described in Ustring patterns.

string.len
Returns the length of the string, in bytes. Is not confused by ASCII NUL characters. Equivalent to.

See mw.ustring.len for a similar function using Unicode codepoints rather than bytes.

string.lower
Returns a copy of this string with all ASCII uppercase letters changed to lowercase. All other characters are left unchanged.

See mw.ustring.lower for a similar function in which all characters with uppercase to lowercase definitions in Unicode are converted.

string.match
Looks for the first match of  in the string. If it finds one, then  returns the captures from the pattern; otherwise it returns nil. If  specifies no captures, then the whole match is returned.

A third, optional numerical argument  specifies where to start the search; its default value is 1 and can be negative.

See mw.ustring.match for a similar function in which the pattern is extended as described in Ustring patterns and the  offset is in characters rather than bytes.

string.rep
Returns a string that is the concatenation of  copies of the string. Identical to mw.ustring.rep.

string.reverse
Returns a string that is the string  reversed (bytewise).

string.sub
Returns the substring of  that starts at   and continues until  ;   and   can be negative. If  is nil or omitted, -1 is used.

In particular, the call  returns a prefix of   with length , and   returns a suffix of   with length.

See mw.ustring.sub for a similar function in which the offsets are characters rather than bytes.

string.upper
Returns a copy of this string with all ASCII lowercase letters changed to uppercase. All other characters are left unchanged.

See mw.ustring.upper for a similar function in which all characters with lowercase to uppercase definitions in Unicode are converted.

Patterns
Note that Lua's patterns are similar to regular expressions, but are not identical. In particular, note the following differences from regular expressions and PCRE:


 * The quoting character is percent, not backslash.
 * Dot always matches all characters, including newlines.
 * No case-insensitive mode.
 * No alternation (the  operator).
 * Quantifiers (, ,  , and  ) may only be applied to individual characters or character classes, not to capture groups.
 * The only non-greedy quantifier is, which is equivalent to PCRE's   quantifier.
 * No generalized finite quantifier (e.g. the  quantifier in PCRE).
 * The only zero-width assertions are,  , and the   "frontier" pattern; assertions such as PCRE's   or   are not present.
 * Patterns themselves do not recognize character escapes such as '\ddd'. However, since patterns are strings these sort of escapes may be used in the string literals used to create the pattern-string.

Also note that a pattern cannot contain embedded zero bytes (ASCII NUL, ). Use  instead.

Also see Ustring patterns for a similar pattern-matching scheme using Unicode characters.

Character class
A character class is used to represent a set of characters. The following combinations are allowed in describing a character class:


 * x: (where x is not one of the magic characters ) represents the character x itself.
 *  : (a dot) represents all characters.
 *  : represents all ASCII letters.
 *  : represents all ASCII control characters.
 *  : represents all digits.
 *  : represents all ASCII lowercase letters.
 *  : represents all punctuation characters.
 *  : represents all ASCII space characters.
 *  : represents all ASCII uppercase letters.
 *  : represents all ASCII alphanumeric characters.
 *  : represents all hexadecimal digits.
 *  : represents ASCII NUL, the zero byte.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : All characters not in.
 *  : (where x is any non-alphanumeric character) represents the character x. This is the standard way to escape the magic characters. Any punctuation character (even the non magic) can be preceded by a ' ' when used to represent itself in a pattern.
 *  : represents the class which is the union of all characters in set. A range of characters can be specified by separating the end characters of the range with a ' '. All classes  described above can also be used as components in set. All other characters in set represent themselves. For example,   (or  ) represents all alphanumeric characters plus the underscore,   represents the octal digits, and   represents the octal digits plus the lowercase letters plus the ' ' character. The interaction between ranges and classes is not defined. Therefore, patterns like   or   have no meaning.
 *  : represents the complement of set, where set is interpreted as above.

Pattern items
A pattern item can be


 * a single character class, which matches any single character in the class;
 * a single character class followed by ' ', which matches 0 or more repetitions of characters in the class. These repetition items will always match the longest possible sequence;
 * a single character class followed by ' ', which matches 1 or more repetitions of characters in the class. These repetition items will always match the longest possible sequence;
 * a single character class followed by ' ', which also matches 0 or more repetitions of characters in the class. Unlike ' ', these repetition items will always match the shortest possible sequence;
 * a single character class followed by ' ', which matches 0 or 1 occurrence of a character in the class;
 * , for n between 1 and 9; such item matches a substring equal to the n-th captured string (see below);
 * , where x and y are two distinct characters; such item matches strings that start with x, end with y, and where the x and y are balanced. This means that, if one reads the string from left to right, counting +1 for an x and -1 for a y, the ending y is the first y where the count reaches 0. For instance, the item  matches expressions with balanced parentheses.


 * , a frontier pattern; such item matches an empty string at any position such that the next character belongs to set and the previous character does not belong to set. The set set is interpreted as previously described. The beginning and the end of the subject are handled as if they were the character '\0'. Note that frontier patterns were present but undocumented in Lua 5.1, and officially added to Lua in 5.2. The implementation in Lua 5.2.1 is unchanged from that in 5.1.0.

Pattern
A pattern is a sequence of pattern items.

A ' ' at the beginning of a pattern anchors the match at the beginning of the subject string. A ' ' at the end of a pattern anchors the match at the end of the subject string. At other positions, ' ' and ' ' have no special meaning and represent themselves.

Captures
A pattern can contain sub-patterns enclosed in parentheses; they describe captures. When a match succeeds, the substrings of the subject string that match captures are stored ("captured") for future use. Captures are numbered according to their left parentheses. For instance, in the pattern, the part of the string matching   is stored as the first capture (and therefore has number 1); the character matching   is captured with number 2, and the part matching   has number 3.

Capture references can appear in the pattern string itself, and refer back to text that was captured earlier in the match. For example,  will match any pair of identical lowercase letters, while   will match any 7-letter palindrome.

As a special case, the empty capture  captures the current string position (a number). For instance, if we apply the pattern  on the string , there will be two captures: 3 and 5.

Table library
Most functions in the table library assume that the table represents a sequence.

The functions,  , and   may be available but are deprecated. Use a for loop with pairs, a for loop with ipairs, and the length operator instead.

table.concat
Given an array where all elements are strings or numbers, returns.

The default value for  is the empty string, the default for   is 1, and the default for   is the length of the table. If  is greater than , returns the empty string.

table.insert
Inserts element  at position   in , shifting up other elements to open space, if necessary. The default value for  is the length of the table plus 1, so that a call   inserts   at the end of table.

Elements up to  are shifted; see Length operator for caveats if the table is not a sequence.

table.maxn
Returns the largest positive numerical index of the given table, or zero if the table has no positive numerical indices.

To do this, it iterates over the whole table. This is roughly equivalent to

table.remove
Removes from  the element at position  , shifting down other elements to close the space, if necessary. Returns the value of the removed element. The default value for  is the length of the table, so that a call   removes the last element of table.

Elements up to  are shifted; see Length operator for caveats if the table is not a sequence.

table.sort
Sorts table elements in a given order, in-place, from  to. If  is given, then it must be a function that receives two table elements, and returns true when the first is less than the second (so that   will be true after the sort). If  is not given, then the standard Lua operator   is used instead.

The sort algorithm is not stable; that is, elements considered equal by the given order may have their relative positions changed by the sort.

Scribunto libraries
All Scribunto libraries are located in the table.

mw.addWarning
Adds a warning which is displayed above the preview when previewing an edit. is parsed as wikitext.

mw.allToString
Calls tostring on all arguments, then concatenates them with tabs as separators.

mw.clone
Creates a deep copy of a value. All tables (and their metatables) are reconstructed from scratch. Functions are still shared, however.

mw.getCurrentFrame
Returns the current frame object, typically the frame object from the most recent.

mw.incrementExpensiveFunctionCount
Adds one to the "expensive parser function" count, and throws an exception if it exceeds the limit (see ).

mw.isSubsting
Returns true if the current  is being substed, false otherwise. See Returning text above for discussion on differences when substing versus not substing.

mw.loadData
Sometimes a module needs large tables of data; for example, a general-purpose module to convert units of measure might need a large table of recognized units and their conversion factors. And sometimes these modules will be used many times in one page. Parsing the large data table for every  can use a significant amount of time. To avoid this issue,  is provided.

works like, with the following differences:


 * The loaded module is evaluated only once per page, rather than once per  call.
 * The loaded module is not recorded in.
 * The value returned from the loaded module must be a table. Other data types are not supported.
 * The returned table (and all subtables) may contain only booleans, numbers, strings, and other tables. Other data types, particularly functions, are not allowed.
 * The returned table (and all subtables) may not have a metatable.
 * All table keys must be booleans, numbers, or strings.
 * The table actually returned by  has metamethods that provide read-only access to the table returned by the module. Since it does not contain the data directly,   and   will work but other methods, including ,  , and the functions in the Table library, will not work correctly.

The hypothetical unit-conversion module mentioned above might store its code in "Module:Convert" and its data in "Module:Convert/data", and "Module:Convert" would use  to efficiently load the data.

mw.dumpObject
Serializes  to a human-readable representation, then returns the resulting string.

mw.log
Passes the arguments to mw.allToString, then appends the resulting string to the log buffer.

In the debug console, the function  is an alias for this function.

mw.logObject
Calls mw.dumpObject and appends the resulting string to the log buffer. If  is given, it will be added to the log buffer followed by an equals sign before the serialized string is appended (i.e. the logged text will be "prefix = object-string").

Frame object
The frame object is the interface to the parameters passed to, and to the parser.

frame.args
A table for accessing the arguments passed to the frame. For example, if a module is called from wikitext with

then  will return ,   will return  , and   (or  ) will return. It is also possible to iterate over arguments using  or.

Note that values in this table are always strings;  may be used to convert them to numbers, if necessary. Keys, however, are numbers even if explicitly supplied in the invocation:  gives string values   and   indexed by numeric keys   and.

As in MediaWiki template invocations, named arguments will have leading and trailing whitespace removed from both the name and the value before they are passed to Lua, whereas unnamed arguments will not have whitespace stripped.

For performance reasons,  uses a metatable, rather than directly containing the arguments. Argument values are requested from MediaWiki on demand. This means that most other table methods will not work correctly, including,  , and the functions in the Table library.

If preprocessor syntax such as template invocations and triple-brace arguments are included within an argument to #invoke, they will be expanded before being passed to Lua. If certain special tags written in XML notation, such as,  ,   and  , are included as arguments to #invoke, then these tags will be converted to "strip markers" — special strings which begin with a delete character (ASCII 127), to be replaced with HTML after they are returned from #invoke.

frame:callParserFunction

 * Note the use of named arguments.

Call a parser function, returning an appropriate string. Whenever possible, native Lua functions or Scribunto library functions should be preferred to this interface.

The following calls are approximately equivalent to the indicated wikitext:

Note that, as with frame:expandTemplate, the function name and arguments are not preprocessed before being passed to the parser function.

frame:expandTemplate

 * Note the use of named arguments.

This is transclusion. The call

frame:expandTemplate{ title = 'template', args = { 'arg1', 'arg2', name = 'arg3' } }

does roughly the same thing from Lua that  does in wikitext. As in transclusion, if the passed title does not contain a namespace prefix it will be assumed to be in the Template: namespace.

Note that the title and arguments are not preprocessed before being passed into the template:

frame:extensionTag
This is equivalent to a call to frame:callParserFunction with function name  and with   prepended to.

frame:getParent
Called on the frame created by, returns the frame for the page that called. Called on that frame, returns nil.

For instance, if the template  contains the code , and a page transcludes that template and supplies arguments to it , calling   in Module:ModuleName will return.

frame:getTitle
Returns the title associated with the frame as a string. For the frame created by, this is the title of the module invoked.

frame:newChild

 * Note the use of named arguments.

Create a new Frame object that is a child of the current frame, with optional arguments and title.

This is mainly intended for use in the debug console for testing functions that would normally be called by. The number of frames that may be created at any one time is limited.

frame:preprocess
This expands wikitext in the context of the frame, i.e. templates, parser functions, and parameters such as  are expanded. Certain special tags written in XML-style notation, such as,  ,   and  , will be replaced with "strip markers" &mdash; special strings which begin with a delete character (ASCII 127), to be replaced with HTML after they are returned from.

If you are expanding a single template, use  instead of trying to construct a wikitext string to pass to this method. It's faster and less prone to error if the arguments contain pipe characters or other wikimarkup.

frame:getArgument
Gets an object for the specified argument, or nil if the argument is not provided.

The returned object has one method,, that returns the expanded wikitext for the argument.

frame:newParserValue
Returns an object with one method,, that returns the result of.

frame:newTemplateParserValue

 * Note the use of named arguments.

Returns an object with one method,, that returns the result of   called with the given arguments.

frame:argumentPairs
Same as. Included for backwards compatibility.

mw.hash.hashValue
Hashes a string value with the specified algorithm. Valid algorithms may be fetched using mw.hash.listAlgorithms.

mw.hash.listAlgorithms
Returns a list of supported hashing algorithms, for use in mw.hash.hashValue.

HTML library
is a fluent interface for building complex HTML from Lua. A mw.html object can be created using.

Functions documented as  are available on the global   table; functions documented as   are methods of an mw.html object (see  ).

A basic example could look like this:

mw.html.create
Creates a new mw.html object containing a  html element. You can also pass an empty string or nil as  in order to create an empty mw.html object.

can be a table with the following keys:


 * : Force the current tag to be self-closing, even if mw.html doesn't recognize it as self-closing
 * : Parent of the current mw.html instance (intended for internal usage)

mw.html:node
Appends a child mw.html node to the current mw.html instance. If a nil parameter is passed, this is a no-op. A node is a string representation of an html element.

mw.html:wikitext
Appends an undetermined number of wikitext strings to the mw.html object.

Note that this stops at the first nil item.

mw.html:newline
Appends a newline to the mw.html object.

mw.html:tag
Appends a new child node with the given  to the builder, and returns a mw.html instance representing that new node. The  parameter is identical to that of

mw.html:attr
Set an HTML attribute with the given  and   on the node. Alternatively a table holding name->value pairs of attributes to set can be passed. In the first form, a value of nil causes any attribute with the given name to be unset if it was previously set.

mw.html:getAttr
Get the value of a html attribute previously set using  with the given.

mw.html:addClass
Adds a class name to the node's class attribute. If a nil parameter is passed, this is a no-op.

mw.html:css
Set a CSS property with the given  and   on the node. Alternatively a table holding name->value pairs of properties to set can be passed. In the first form, a value of nil causes any property with the given name to be unset if it was previously set.

mw.html:cssText
Add some raw  to the node's style attribute. If a nil parameter is passed, this is a no-op.

mw.html:done
Returns the parent node under which the current node was created. Like jQuery.end, this is a convenience function to allow the construction of several child nodes to be chained together into a single statement.

mw.html:allDone
Like, but traverses all the way to the root node of the tree and returns it.

Language library
Language codes are described at language code. Many of MediaWiki's language codes are similar to IETF language tags, but not all MediaWiki language codes are valid IETF tags or vice versa.

Functions documented as  are available on the global   table; functions documented as   are methods of a language object (see  ).

mw.language.fetchLanguageName
The full name of the language for the given language code: native name (language autonym) by default, name translated in target language if a value is given for.

mw.language.fetchLanguageNames
Fetch the list of languages known to MediaWiki, returning a table mapping language code to language name.

By default the name returned is the language autonym; passing a language code for  returns all names in that language.

By default, only language names known to MediaWiki are returned; passing  for   will return all available languages (e.g. from Extension:CLDR), while passing   will include only languages having customized messages included with MediaWiki core or enabled extensions. To explicitly select the default,  may be passed.

mw.language.getContentLanguage
Returns a new language object for the wiki's default content language.

mw.language.getFallbacksFor
Returns a list of MediaWiki's fallback language codes for the specified code.

mw.language.isKnownLanguageTag
Returns true if a language code is known to MediaWiki.

A language code is "known" if it is a "valid built-in code" (i.e. it returns true for ) and returns a non-empty string for.

mw.language.isSupportedLanguage
Checks whether any localisation is available for that language code in MediaWiki.

A language code is "supported" if it is a "valid" code (returns true for ), contains no uppercase letters, and has a message file in the currently-running version of MediaWiki.

It is possible for a language code to be "supported" but not "known" (i.e. returning true for ). Also note that certain codes are "supported" despite  returning false.

mw.language.isValidBuiltInCode
Returns true if a language code is of a valid form for the purposes of internal customisation of MediaWiki.

The code may not actually correspond to any known language.

A language code is a "valid built-in code" if it is a "valid" code (i.e. it returns true for ); consists of only ASCII letters, numbers, and hyphens; and is at least two characters long.

Note that some codes are "supported" (i.e. returning true from ) even though this function returns false.

mw.language.isValidCode
Returns true if a language code string is of a valid form, whether or not it exists. This includes codes which are used solely for customisation via the MediaWiki namespace.

The code may not actually correspond to any known language.

A language code is valid if it does not contain certain unsafe characters (colons, single- or double-quotes, slashs, backslashs, angle brackets, ampersands, or ASCII NULs) and is otherwise allowed in a page title.

mw.language.new
Creates a new language object. Language objects do not have any publicly accessible properties, but they do have several methods, which are documented below.

There is a limit on the number of distinct language codes that may be used on a page. Exceeding this limit will result in errors.

mw.language:getCode
Returns the language code for this language object.

mw.language:getFallbackLanguages
Returns a list of MediaWiki's fallback language codes for this language object. Equivalent to.

mw.language:isRTL
Returns true if the language is written right-to-left, false if it is written left-to-right.

mw.language:lc
Converts the string to lowercase, honoring any special rules for the given language.

When the Ustring library is loaded, the mw.ustring.lower function is implemented as a call to.

mw.language:lcfirst
Converts the first character of the string to lowercase, as with lang:lc.

mw.language:uc
Converts the string to uppercase, honoring any special rules for the given language.

When the Ustring library is loaded, the mw.ustring.upper function is implemented as a call to.

mw.language:ucfirst
Converts the first character of the string to uppercase, as with lang:uc.

mw.language:caseFold
Converts the string to a representation appropriate for case-insensitive comparison. Note that the result may not make any sense when displayed.

mw.language:formatNum
Formats a number with grouping and decimal separators appropriate for the given language. Given 123456.78, this may produce "123,456.78", "123.456,78", or even something like "١٢٣٬٤٥٦٫٧٨" depending on the language and wiki configuration.

The  is a table of options, which can be:


 * : Set true to omit grouping separators.

mw.language:formatDate
Formats a date according to the given format string. If  is omitted, the default is the current time. The value for  must be a boolean or nil; if true, the time is formatted in the wiki's local time rather than in UTC.

The format string and supported values for  are identical to those for the #time parser function from Extension:ParserFunctions. Note however that backslashes may need to be doubled in a Lua string literal, since Lua also uses backslash as an escape character while wikitext does not:

mw.language:formatDuration
Breaks a duration in seconds into more human-readable units, e.g. 12345 to 3 hours, 25 minutes and 45 seconds, returning the result as a string.

, if given, is a table with values naming the interval units to use in the response. These include 'millennia', 'centuries', 'decades', 'years', 'weeks', 'days', 'hours', 'minutes', and 'seconds'.

mw.language:parseFormattedNumber
This takes a number as formatted by lang:formatNum and returns the actual number. In other words, this is basically a language-aware version of.

mw.language:convertPlural
This chooses the appropriate grammatical form from  (which must be a sequence table) or   based on the number. For example, in English you might use  or   to generate grammatically-correct text whether there is only 1 sock or 200 socks.

The necessary values for the sequence are language-dependent, see localization of magic words and translatewiki's FAQ on PLURAL for some details.

mw.language:convertGrammar

 * Note the different parameter order between the two aliases.  matches the order of the method of the same name on MediaWiki's Language object, while   matches the order of the parser function of the same name, documented at Special:MyLanguage/Help:Magic words.

This chooses the appropriate inflected form of  for the given inflection code.

The possible values for  and   are language-dependent, see Special:MyLanguage/Help:Magic words and translatewiki:Grammar for some details.

mw.language:gender
Chooses the string corresponding to the gender of, which may be "male", "female", or a registered user name.

mw.language:getArrow
Returns a Unicode arrow character corresponding to :


 * forwards: Either "→" or "←" depending on the directionality of the language.
 * backwards: Either "←" or "→" depending on the directionality of the language.
 * left: "←"
 * right: "→"
 * up: "↑"
 * down: "↓"

mw.language:getDir
Returns "ltr" or "rtl", depending on the directionality of the language.

mw.language:getDirMark
Returns a string containing either U+200E (the left-to-right mark) or U+200F (the right-to-left mark), depending on the directionality of the language and whether  is a true or false value.

mw.language:getDirMarkEntity
Returns "&amp;lrm;" or "&amp;rlm;", depending on the directionality of the language and whether  is a true or false value.

mw.language:getDurationIntervals
Breaks a duration in seconds into more human-readable units, e.g. 12345 to 3 hours, 25 minutes and 45 seconds, returning the result as a table mapping unit names to numbers.

, if given, is a table with values naming the interval units to use in the response. These include 'millennia', 'centuries', 'decades', 'years', 'days', 'hours', 'minutes', and 'seconds'.

Message library
This library is an interface to the localisation messages and the MediaWiki: namespace.

Functions documented as  are available on the global   table; functions documented as   are methods of a message object (see  ).

mw.message.new
Creates a new message object for the given message.

The message object has no properties, but has several methods documented below.

mw.message.newFallbackSequence
Creates a new message object for the given messages (the first one that exists will be used).

The message object has no properties, but has several methods documented below.

mw.message.newRawMessage
Creates a new message object, using the given text directly rather than looking up an internationalized message. The remaining parameters are passed to the new object's  method.

The message object has no properties, but has several methods documented below.

mw.message.rawParam
Wraps the value so that it will not be parsed as wikitext by.

mw.message.numParam
Wraps the value so that it will automatically be formatted as by. Note this does not depend on the Language library actually being available.

mw.message.getDefaultLanguage
Returns a Language object for the default language.

mw.message:params
Add parameters to the message, which may be passed as individual arguments or as a sequence table. Parameters must be numbers, strings, or the special values returned by mw.message.numParam or mw.message.rawParam. If a sequence table is used, parameters must be directly present in the table; references using the __index metamethod will not work.

Returns the  object, to allow for call chaining.

mw.message:rawParams
Like params, but has the effect of passing all the parameters through mw.message.rawParam first.

Returns the  object, to allow for call chaining.

mw.message:numParams
Like params, but has the effect of passing all the parameters through mw.message.numParam first.

Returns the  object, to allow for call chaining.

mw.message:inLanguage
Specifies the language to use when processing the message. may be a string or a table with a  method (i.e. a Language object).

The default language is the one returned by.

Returns the  object, to allow for call chaining.

mw.message:useDatabase
Specifies whether to look up messages in the MediaWiki: namespace (i.e. look in the database), or just use the default messages distributed with MediaWiki.

The default is true.

Returns the  object, to allow for call chaining.

mw.message:plain
Substitutes the parameters and returns the message wikitext as-is. Template calls and parser functions are intact.

mw.message:exists
Returns a boolean indicating whether the message key exists.

mw.message:isBlank
Returns a boolean indicating whether the message key has content. Returns true if the message key does not exist or the message is the empty string.

mw.message:isDisabled
Returns a boolean indicating whether the message key is disabled. Returns true if the message key does not exist or if the message is the empty string or the string "-".

mw.site.currentVersion
A string holding the current version of MediaWiki.

mw.site.scriptPath
The value of.

mw.site.server
The value of.

mw.site.siteName
The value of.

mw.site.stylePath
The value of.

mw.site.namespaces
Table holding data for all namespaces, indexed by number.

The data available is:


 * id: Namespace number.
 * name: Local namespace name.
 * canonicalName: Canonical namespace name.
 * displayName: Set on namespace 0, the name to be used for display (since the name is often the empty string).
 * hasSubpages: Whether subpages are enabled for the namespace.
 * hasGenderDistinction: Whether the namespace has different aliases for different genders.
 * isCapitalized: Whether the first letter of pages in the namespace is capitalized.
 * isContent: Whether this is a content namespace.
 * isIncludable: Whether pages in the namespace can be transcluded.
 * isMovable: Whether pages in the namespace can be moved.
 * isSubject: Whether this is a subject namespace.
 * isTalk: Whether this is a talk namespace.
 * defaultContentModel: The default content model for the namespace, as a string.
 * aliases: List of aliases for the namespace.
 * subject: Reference to the corresponding subject namespace's data.
 * talk: Reference to the corresponding talk namespace's data.
 * associated: Reference to the associated namespace's data.

A metatable is also set that allows for looking up namespaces by name (localized or canonical). For example, both  and   will return information about the Project namespace.

mw.site.contentNamespaces
Table holding just the content namespaces, indexed by number. See mw.site.namespaces for details.

mw.site.subjectNamespaces
Table holding just the subject namespaces, indexed by number. See mw.site.namespaces for details.

mw.site.talkNamespaces
Table holding just the talk namespaces, indexed by number. See mw.site.namespaces for details.

mw.site.stats
Table holding site statistics. Available statistics are:


 * pages: Number of pages in the wiki.
 * articles: Number of articles in the wiki.
 * files: Number of files in the wiki.
 * edits: Number of edits in the wiki.
 * views: Number of views in the wiki. Not available if is set.
 * users: Number of users in the wiki.
 * activeUsers: Number of active users in the wiki.
 * admins: Number of users in group 'sysop' in the wiki.

mw.site.stats.pagesInCategory


Gets statistics about the category. If  is unspecified, nil, or "*", returns a table with the following properties:


 * all: Total pages, files, and subcategories.
 * subcats: Number of subcategories.
 * files: Number of files.
 * pages: Number of pages.

If  is one of the above keys, just the corresponding value is returned instead.

Each new category queried will increment the expensive function count.

mw.site.stats.pagesInNamespace
Returns the number of pages in the given namespace (specify by number).

mw.site.stats.usersInGroup
Returns the number of users in the given group.

mw.site.interwikiMap
Returns a table holding data about available interwiki prefixes. If  is the string "local", then only data for local interwiki prefixes is returned. If  is the string "!local", then only data for non-local prefixes is returned. If no filter is specified, data for all prefixes is returned. A "local" prefix in this context is one that is for the same project. For example, on the English Wikipedia, other-language Wikipedias are considered local, while Wiktionary and such are not.

Keys in the table returned by this function are interwiki prefixes, and the values are subtables with the following properties:


 * prefix - the interwiki prefix.
 * url - the URL that the interwiki points to. The page name is represented by the parameter $1.
 * isProtocolRelative - a boolean showing whether the URL is protocol-relative.
 * isLocal - whether the URL is for a site in the current project.
 * isCurrentWiki - whether the URL is for the current wiki.
 * isTranscludable - whether pages using this interwiki prefix are transcludable. This requires scary transclusion, which is disabled on Wikimedia wikis.
 * isExtraLanguageLink - whether the interwiki is listed in.
 * displayText - for links listed in $wgExtraInterlanguageLinkPrefixes, this is the display text shown for the interlanguage link. Nil if not specified.
 * tooltip - for links listed in $wgExtraInterlanguageLinkPrefixes, this is the tooltip text shown when users hover over the interlanguage link. Nil if not specified.

Text library
The text library provides some common text processing functions missing from the String library and the Ustring library. These functions are safe for use with UTF-8 strings.

mw.text.decode
Replaces HTML entities in the string with the corresponding characters.

If  is omitted or false, the only named entities recognized are '&amp;lt;', '&amp;gt;', '&amp;amp;', '&amp;quot;', and '&amp;nbsp;'. Otherwise, the list of HTML5 named entities to recognize is loaded from PHP's function.

mw.text.encode
Replaces characters in a string with HTML entities. Characters '<', '>', '&', '"', and the non-breaking space are replaced with the appropriate named entities; all others are replaced with numeric entities.

If  is supplied, it should be a string as appropriate to go inside brackets in a Ustring pattern, i.e. the "set" in. The default charset is  (the space at the end is the non-breaking space, U+00A0).

mw.text.jsonDecode
Decodes a JSON string. is 0 or a combination (use ) of the flags   and.

Normally JSON's zero-based arrays are renumbered to Lua one-based sequence tables; to prevent this, pass.

To relax certain requirements in JSON, such as no terminal comma in arrays or objects, pass. This is not recommended.

Limitations:


 * Decoded JSON arrays may not be Lua sequences if the array contains null values.
 * JSON objects will drop keys having null values.
 * It is not possible to directly tell whether the input was a JSON array or a JSON object with sequential integer keys.
 * A JSON object having sequential integer keys beginning with 1 will decode to the same table structure as a JSON array with the same values, despite these not being at all equivalent, unless  is used.

mw.text.jsonEncode
Encode a JSON string. Errors are raised if the passed value cannot be encoded in JSON. is 0 or a combination (use ) of the flags   and.

Normally Lua one-based sequence tables are encoded as JSON zero-based arrays; when  is set in , zero-based sequence tables are encoded as JSON arrays.

Limitations:


 * Empty tables are always encoded as empty arrays, not empty objects.
 * Sequence tables cannot be encoded as JSON objects without adding a "dummy" element.
 * To produce objects or arrays with nil values, a tricky implementation of the  metamethod is required.
 * A Lua table having sequential integer keys beginning with 0 will encode as a JSON array, the same as a Lua table having integer keys beginning with 1, unless  is used.
 * When both a number and the string representation of that number are used as keys in the same table, behavior is unspecified.

mw.text.killMarkers
Removes all MediaWiki strip markers from a string.

mw.text.listToText
Join a list, prose-style. In other words, it's like  but with a different separator before the final item.

The default separator is taken from MediaWiki:comma-separator in the wiki's content language, and the default conjuction is MediaWiki:and concatenated with MediaWiki:word-separator.

Examples, using the default values for the messages:

-- Returns the empty string mw.text.listToText( {} ) -- Returns "1" mw.text.listToText( { 1 } ) -- Returns "1 and 2" mw.text.listToText( { 1, 2 } ) -- Returns "1, 2, 3, 4 and 5" mw.text.listToText( { 1, 2, 3, 4, 5 } ) -- Returns "1; 2; 3; 4 or 5" mw.text.listToText( { 1, 2, 3, 4, 5 }, '; ', ' or ' )

mw.text.nowiki
Replaces various characters in the string with HTML entities to prevent their interpretation as wikitext. This includes:


 * The following characters: '"', '&', "'", '<', '=', '>', '[', ']', '{', '|', '}'
 * The following characters at the start of the string or immediately after a newline: '#', '*', ':', ';', space, tab ('\t')
 * Blank lines will have one of the associated newline or carriage return characters escaped
 * "" at the start of the string or immediately after a newline will have the first '-' escaped
 * "__" will have one underscore escaped
 * "://" will have the colon escaped
 * A whitespace character following "ISBN", "RFC", or "PMID" will be escaped

mw.text.split
Splits the string into substrings at boundaries matching the Ustring pattern. If  is specified and true,   will be interpreted as a literal string rather than as a Lua pattern (just as with the parameter of the same name for  ). Returns a table containing the substrings.

For example,  would return a table.

If  matches the empty string,   will be split into individual characters.

mw.text.gsplit
Returns an iterator function that will iterate over the substrings that would be returned by the equivalent call to.

mw.text.tag

 * Note the use of named arguments.

Generates an HTML-style tag for.

If  is given, it must be a table with string keys. String and number values are used as the value of the attribute; boolean true results in the key being output as an HTML5 valueless parameter; boolean false skips the key entirely; and anything else is an error.

If  is not given (or is nil), only the opening tag is returned. If  is boolean false, a self-closed tag is returned. Otherwise it must be a string or number, in which case that content is enclosed in the constructed opening and closing tag. Note the content is not automatically HTML-encoded; use mw.text.encode if needed.

For properly returning extension tags such as, use frame:extensionTag instead.

mw.text.trim
Remove whitespace or other characters from the beginning and end of a string.

If  is supplied, it should be a string as appropriate to go inside brackets in a Ustring pattern, i.e. the "set" in. The default charset is ASCII whitespace,.

mw.text.truncate
Truncates  to the specified length, adding   if truncation was performed. If length is positive, the end of the string will be truncated; if negative, the beginning will be removed. If  is given and true, the resulting string including ellipsis will not be longer than the specified length.

The default value for  is taken from MediaWiki:ellipsis in the wiki's content language.

Examples, using the default "..." ellipsis:

-- Returns "foobarbaz" mw.text.truncate( "foobarbaz", 9 ) -- Returns "fooba..." mw.text.truncate( "foobarbaz", 5 ) -- Returns "...arbaz" mw.text.truncate( "foobarbaz", -5 ) -- Returns "foo..." mw.text.truncate( "foobarbaz", 6, nil, true ) -- Returns "foobarbaz", because that's shorter than "foobarba..." mw.text.truncate( "foobarbaz", 8 )

mw.text.unstripNoWiki
Replaces MediaWiki &lt;nowiki&gt; strip markers with the corresponding text. Other types of strip markers are not changed.

mw.text.unstrip
Equivalent to.

This no longer reveals the HTML behind special page transclusion, &lt;ref&gt; tags, and so on as it did in earlier versions of Scribunto.

mw.title.equals
Test for whether two titles are equal. Note that fragments are ignored in the comparison.

mw.title.compare
Returns -1, 0, or 1 to indicate whether the title  is less than, equal to, or greater than title.

This compares titles by interwiki prefix (if any) as strings, then by namespace number, then by the unprefixed title text as a string. These string comparisons use Lua's standard  operator.

mw.title.getCurrentTitle
Returns the title object for the current page.

mw.title.new


Creates a new title object.

If a number  is given, an object is created for the title with that page_id. The title referenced will be counted as linked from the current page. If the page_id does not exist, returns nil. The expensive function count will be incremented if the title object created is not for a title that has already been loaded.

If a string  is given instead, an object is created for that title (even if the page does not exist). If the text string does not specify a namespace,  (which may be any key found in  ) will be used. If the text is not a valid title, nil is returned.

mw.title.makeTitle
Creates a title object with title  in namespace , optionally with the specified   and   prefix. may be any key found in. If the resulting title is not valid, returns nil.

Note that, unlike, this method will always apply the specified namespace. For example,  will create an object for the page Template:Module:Foo, while   will create an object for the page Module:Foo.

Title objects
A title object has a number of properties and methods. Most of the properties are read-only.

Note that fields ending with  return titles as string values whereas the fields ending with   return title objects.


 * id: The page_id. 0 if the page does not exist., and the page will be recorded as a link.
 * interwiki: The interwiki prefix, or the empty string if none.
 * namespace: The namespace number.
 * fragment: The fragment, or the empty string. May be assigned.
 * nsText: The text of the namespace for the page.
 * subjectNsText: The text of the subject namespace for the page.
 * text: The title of the page, without the namespace or interwiki prefixes.
 * prefixedText: The title of the page, with the namespace and interwiki prefixes.
 * fullText: The title of the page, with the namespace and interwiki prefixes and the fragment.
 * rootText: If this is a subpage, the title of the root page without prefixes. Otherwise, the same as.
 * baseText: If this is a subpage, the title of the page it is a subpage of without prefixes. Otherwise, the same as.
 * subpageText: If this is a subpage, just the subpage name. Otherwise, the same as.
 * canTalk: Whether the page for this title could have a talk page.
 * exists: Whether the page exists. Alias for file.exists for Media-namespace titles. For File-namespace titles this checks the existence of the file description page, not the file itself., and the page will be recorded as a link.
 * file, fileExists: See below.
 * isContentPage: Whether this title is in a content namespace.
 * isExternal: Whether this title has an interwiki prefix.
 * isLocal: Whether this title is in this project. For example, on the English Wikipedia, any other Wikipedia is considered "local" while Wiktionary and such are not.
 * isRedirect: Whether this is the title for a page that is a redirect., and the page will be recorded as a link.
 * isSpecialPage: Whether this is the title for a possible special page (i.e. a page in the Special: namespace).
 * isSubpage: Whether this title is a subpage of some other title.
 * isTalkPage: Whether this is a title for a talk page.
 * isSubpageOf( title2 ): Whether this title is a subpage of the given title.
 * inNamespace( ns ): Whether this title is in the given namespace. Namespaces may be specified by anything that is a key found in.
 * inNamespaces( ... ): Whether this title is in any of the given namespaces. Namespaces may be specified by anything that is a key found in.
 * hasSubjectNamespace( ns ): Whether this title's subject namespace is in the given namespace. Namespaces may be specified by anything that is a key found in.
 * contentModel: The content model for this title, as a string., and the page will be recorded as a link.
 * basePageTitle: The same as.
 * rootPageTitle: The same as.
 * talkPageTitle: The same as, or nil if this title cannot have a talk page.
 * subjectPageTitle: The same as.
 * redirectTarget: Returns a title object of the target of the redirect page if the page is a redirect and the page exists, returns false otherwise.
 * protectionLevels: The page's protection levels. This is a table with keys corresponding to each action (e.g., "edit" and "move"). The table values are arrays, the first item of which is a string containing the protection level. If the page is unprotected, either the table values or the array items will be nil..
 * subPageTitle( text ): The same as.
 * partialUrl: Returns  encoded as it would be in a URL.
 * fullUrl( query, proto ): Returns the full URL (with optional query table/string) for this title.  may be specified to control the scheme of the resulting url: "http", "https", "relative" (the default), or "canonical".
 * localUrl( query ): Returns the local URL (with optional query table/string) for this title.
 * canonicalUrl( query ): Returns the canonical URL (with optional query table/string) for this title.
 * getContent: Returns the (unparsed) content of the page, or nil if there is no page. The page will be recorded as a transclusion.

Title objects may be compared using Relational operators. will return.

File metadata
Title objects representing a page in the File or Media namespace will have a property called. This is a table, structured as follows:


 * exists: Whether the file exists. It will be recorded as an image usage. The  property on a Title object exists for backwards compatibility reasons and is an alias for this property. If this is false, all other file properties will be nil.
 * width: The width of the file. If the file contains multiple pages, this is the width of the first page.
 * height: The height of the file. If the file contains multiple pages, this is the height of the first page.
 * pages: If the file format supports multiple pages, this is a table containing tables for each page of the file; otherwise, it is nil. The # operator can be used to get the number of pages in the file. Each individual page table contains a width and height property.
 * size: The size of the file in bytes.
 * mimeType: The MIME type of the file.

Expensive properties
The properties id, isRedirect, exists, and contentModel require fetching data about the title from the database. For this reason, the expensive function count is incremented the first time one of them is accessed for a page other than the current page. Subsequent accesses of any of these properties for that page will not increment the expensive function count again.

Other properties marked as expensive will always increment the expensive function count the first time they are accessed for a page other than the current page.

mw.uri.encode
Percent-encodes the string. The default type,, encodes spaces using '+' for use in query strings;   encodes spaces as %20; and   encodes spaces as '_'.

Note that the "WIKI" format is not entirely reversible, as both spaces and underscores are encoded as '_'.

mw.uri.decode
Percent-decodes the string. The default type,, decodes '+' to space;   does not perform any extra decoding; and   decodes '_' to space.

mw.uri.anchorEncode
Encodes a string for use in a MediaWiki URI fragment.

mw.uri.buildQueryString
Encodes a table as a URI query string. Keys should be strings; values may be strings or numbers, sequence tables, or boolean false.

mw.uri.parseQueryString
Decodes the query string  to a table. Keys in the string without values will have a value of false; keys repeated multiple times will have sequence tables as values; and others will have strings as values.

The optional numerical arguments  and   can be used to specify a substring of   to be parsed, rather than the entire string. is the position of the first character of the substring, and defaults to 1. is the position of the last character of the substring, and defaults to the length of the string. Both  and   can be negative, as in string.sub.

mw.uri.canonicalUrl
Returns a URI object for the canonical URL for a page, with optional query string/table.

mw.uri.fullUrl
Returns a URI object for the full URL for a page, with optional query string/table.

mw.uri.localUrl
Returns a URI object for the local URL for a page, with optional query string/table.

mw.uri.new
Constructs a new URI object for the passed string or table. See the description of URI objects for the possible fields for the table.

mw.uri.validate
Validates the passed table (or URI object). Returns a boolean indicating whether the table was valid, and on failure a string explaining what problems were found.

URI object
The URI object has the following fields, some or all of which may be nil:


 * protocol: String protocol/scheme
 * user: String user
 * password: String password
 * host: String host name
 * port: Integer port
 * path: String path
 * query: A table, as from mw.uri.parseQueryString
 * fragment: String fragment.

The following properties are also available:
 * userInfo: String user and password
 * hostPort: String host and port
 * authority: String user, password, host, and port
 * queryString: String version of the query table
 * relativePath: String path, query string, and fragment

will give the URI string.

Methods of the URI object are:

mw.uri:parse
Parses a string into the current URI object. Any fields specified in the string will be replaced in the current object; fields not specified will keep their old values.

mw.uri:clone
Makes a copy of the URI object.

mw.uri:extend
Merges the parameters table into the object's query table.

Ustring library
The ustring library is intended to be a direct reimplementation of the standard String library, except that the methods operate on characters in UTF-8 encoded strings rather than bytes.

Most functions will raise an error if the string is not valid UTF-8; exceptions are noted.

mw.ustring.maxPatternLength
The maximum allowed length of a pattern, in bytes.

mw.ustring.maxStringLength
The maximum allowed length of a string, in bytes.

mw.ustring.byte
Returns individual bytes; identical to string.byte.

mw.ustring.byteoffset
Returns the byte offset of a character in the string. The default for both  and   is 1. may be negative, in which case it counts from the end of the string.

The character at  == 1 is the first character starting at or after byte  ; the character at   == 0 is the first character starting at or before byte. Note this may be the same character. Greater or lesser values of  are calculated relative to these.

mw.ustring.char
Much like string.char, except that the integers are Unicode codepoints rather than byte values.

mw.ustring.codepoint
Much like string.byte, except that the return values are codepoints and the offsets are characters rather than bytes.

mw.ustring.find
Much like string.find, except that the pattern is extended as described in Ustring patterns and the  offset is in characters rather than bytes.

mw.ustring.format
Identical to string.format. Widths and precisions for strings are expressed in bytes, not codepoints.

mw.ustring.gcodepoint
Returns three values for iterating over the codepoints in the string. defaults to 1, and  to -1. This is intended for use in the iterator form of :

mw.ustring.gmatch
Much like string.gmatch, except that the pattern is extended as described in Ustring patterns.

mw.ustring.gsub
Much like string.gsub, except that the pattern is extended as described in Ustring patterns.

mw.ustring.isutf8
Returns true if the string is valid UTF-8, false if not.

mw.ustring.len
Returns the length of the string in codepoints, or nil if the string is not valid UTF-8.

See string.len for a similar function that uses byte length rather than codepoints.

mw.ustring.lower
Much like string.lower, except that all characters with lowercase to uppercase definitions in Unicode are converted.

If the Language library is also loaded, this will instead call lc on the default language object.

mw.ustring.match
Much like string.match, except that the pattern is extended as described in Ustring patterns and the  offset is in characters rather than bytes.

mw.ustring.rep
Identical to string.rep.

mw.ustring.sub
Much like string.sub, except that the offsets are characters rather than bytes.

mw.ustring.toNFC
Converts the string to Normalization Form C. Returns nil if the string is not valid UTF-8.

mw.ustring.toNFD
Converts the string to Normalization Form D. Returns nil if the string is not valid UTF-8.

mw.ustring.upper
Much like string.upper, except that all characters with uppercase to lowercase definitions in Unicode are converted.

If the Language library is also loaded, this will instead call uc on the default language object.

Ustring patterns
Patterns in the ustring functions use the same syntax as the String library patterns. The major difference is that the character classes are redefined in terms of Unicode character properties:


 *  : represents all characters with General Category "Letter".
 *  : represents all characters with General Category "Control".
 *  : represents all characters with General Category "Decimal Number".
 *  : represents all characters with General Category "Lowercase Letter".
 *  : represents all characters with General Category "Punctuation".
 *  : represents all characters with General Category "Separator", plus tab, linefeed, carriage return, vertical tab, and form feed.
 *  : represents all characters with General Category "Uppercase Letter".
 *  : represents all characters with General Category "Letter" or "Decimal Number".
 *  : adds fullwidth character versions of the hex digits.

In all cases, characters are interpreted as Unicode characters instead of bytes, so ranges such as, patterns such as  , and quantifiers applied to multibyte characters will work correctly. Empty captures will capture the position in code points rather than bytes.

Loadable libraries
These libraries are not included by default, but if needed may be loaded using.

bit32
This emulation of the Lua 5.2  library may be loaded using

bit32 = require( 'bit32' )

The bit32 library provides bitwise operations on unsigned 32-bit integers. Input numbers are truncated to integers (in an unspecified manner) and reduced modulo 232 so the value is in the range 0 to 232−1; return values are also in this range.

When bits are numbered (as in bit32.extract), 0 is the least-significant bit (the one with value 20) and 31 is the most-significant (the one with value 231).

bit32.band
Returns the bitwise AND of its arguments: the result has a bit set only if that bit is set in all of the arguments.

If given zero arguments, the result has all bits set.

bit32.bnot
Returns the bitwise complement of.

bit32.bor
Returns the bitwise OR of its arguments: the result has a bit set if that bit is set in any of the arguments.

If given zero arguments, the result has all bits clear.

bit32.btest
Equivalent to

bit32.bxor
Returns the bitwise XOR of its arguments: the result has a bit set if that bit is set in an odd number of the arguments.

If given zero arguments, the result has all bits clear.

bit32.extract
Extracts  bits from , starting with bit. Accessing bits outside of the range 0 to 31 is an error.

If not specified, the default for  is 1.

bit32.replace
Replaces  bits in , starting with bit  , with the low   bits from. Accessing bits outside of the range 0 to 31 is an error.

If not specified, the default for  is 1.

bit32.lshift
Returns the number  shifted   bits to the left. This is a logical shift: inserted bits are 0. This is generally equivalent to multiplying by 2undefined.

Note that a displacement over 31 will result in 0.

bit32.rshift
Returns the number  shifted   bits to the right. This is a logical shift: inserted bits are 0. This is generally equivalent to dividing by 2undefined.

Note that a displacement over 31 will result in 0.

bit32.arshift
Returns the number  shifted   bits to the right. This is an arithmetic shift: if  is positive, the inserted bits will be the same as bit 31 in the original number.

Note that a displacement over 31 will result in 0 or 4294967295.

bit32.lrotate
Returns the number  rotated   bits to the left.

Note that rotations are equivalent modulo 32: a rotation of 32 is the same as a rotation of 0, 33 is the same as 1, and so on.

bit32.rrotate
Returns the number  rotated   bits to the right.

Note that rotations are equivalent modulo 32: a rotation of 32 is the same as a rotation of 0, 33 is the same as 1, and so on.

libraryUtil
This library contains methods useful when implementing Scribunto libraries. It may be loaded using

libraryUtil = require( 'libraryUtil' )

libraryUtil.checkType
Raises an error if  does not match. In addition, no error will be raised if  is nil and   is true.

is the name of the calling function, and  is the position of the argument in the argument list. These are used in formatting the error message.

libraryUtil.checkTypeMulti
Raises an error if  does not match any of the strings in the array.

This is for arguments that have more than one valid type.

libraryUtil.checkTypeForIndex
Raises an error if  does not match.

This is intended for use in implementing a  metamethod.

libraryUtil.checkTypeForNamedArg
Raises an error if  does not match. In addition, no error will be raised if  is nil and   is true.

This is intended to be used as an equivalent to  in methods called using Lua's "named argument" syntax,.

libraryUtil.makeCheckSelfFunction
This is intended for use in implementing "methods" on object tables that are intended to be called with the  syntax. It returns a function that should be called at the top of these methods with the  argument and the method name, which will raise an error if that   object is not.

This function will generally be used in a library's constructor function, something like this:

function myLibrary.new local obj = {} local checkSelf = libraryUtil.makeCheckSelfFunction( 'myLibrary', 'obj', obj, 'myLibrary object' ) function obj:method checkSelf( self, 'method' ) end function obj:method2 checkSelf( self, 'method2' ) end return obj end

luabit
The luabit library modules "bit" and "hex" may be loaded using

bit = require( 'luabit.bit' ) hex = require( 'luabit.hex' )

Note that the bit32 library contains the same operations as "luabit.bit", and the operations in "luabit.hex" may be performed using  and.

The luabit module "noki" is not available, as it is entirely useless in Scribunto. The luabit module "utf8" is also not available, as it was considered redundant to the Ustring library.

ustring
The pure-Lua backend to the Ustring library may be loaded using

ustring = require( 'ustring' )

In all cases the Ustring library should be used instead, as that replaces many of the slower and more memory-intensive operations with callbacks into PHP code.

Extension libraries (mw.ext)
The following MediaWiki extensions provide additional Scribunto libraries:


 * Wikibase Client – provides access to Wikidata. See Extension:Wikibase Client/Lua.
 * Semantic Scribunto - provides native support for the Scribunto extension to Semantic MediaWiki extension.
 * tabular data - provides access to localizable data tables and geojson maps stored on Commons.

See also the lists of extensions using the ScribuntoExternalLibraries and ScribuntoExternalLibraryPaths hooks.

Planned Scribunto libraries
These libraries are planned, or are in Gerrit pending review.


 * (none at this time)

Changed functions
The following functions have been modified:
 * setfenv
 * getfenv: May not be available, depending on the configuration. If available, attempts to access parent environments will fail.
 * getmetatable: Works on tables only to prevent unauthorized access to parent environments.
 * tostring: Pointer addresses of tables and functions are not provided. This is to make memory corruption vulnerabilities more difficult to exploit.
 * pairs
 * ipairs: Support for the __pairs and __ipairs metamethods (added in Lua 5.2) has been added.
 * pcall
 * xpcall: Certain internal errors cannot be intercepted.
 * require: Can fetch certain built-in modules distributed with Scribunto, as well as modules present in the Module namespace of the wiki. To fetch wiki modules, use the full page name including the namespace. Cannot otherwise access the local filesystem.

Removed functions and packages
The following packages are mostly removed. Only those functions listed are available:
 * package.*: Filesystem and C library access has been removed. Available functions and tables are:
 * package.loaded
 * package.preload
 * package.loaders: Loaders which access the local filesystem or load C libraries are not present. A loader for Module-namespace pages is added.
 * package.seeall


 * os.*: There are some insecure functions in here, such as os.execute, which can't be allowed. Available functions are:
 * os.clock
 * os.date
 * os.difftime
 * os.time


 * debug.*: Most of the functions are insecure. Available functions are:
 * debug.traceback

The following functions and packages are not available:
 * collectgarbage
 * module
 * coroutine.*: No application is known for us, so it has not been reviewed for security.
 * dofile
 * loadfile
 * io.*, file.*: Allows local filesystem access, which is insecure.
 * load
 * loadstring: These were omitted to allow for static analysis of the Lua source code. Also, allowing these would allow Lua code to be added directly to article and template pages, which was not desired for usability reasons.
 * print: This was discussed on wikitech-l and it was decided that it should be omitted in favour of return values, to improve code quality. If necessary, mw.log may be used to output information to the debug console.
 * string.dump: May expose private data from parent environments.

Additional caveats

 * Referential data structures: Circular data structures and data structures where the same node may be reached by more than one path cannot be correctly sent to PHP. Attempting to do so will cause undefined behavior. This includes (but is not limited to) returning such data structures from the module called by  and passing such data structures as parameters to Scribunto library functions that are implemented as callbacks into PHP. Such data structures may be used freely within Lua, including as the return values of modules loaded with.

Writing Scribunto libraries
This information is useful to developers writing additional Scribunto libraries, whether for inclusion in Scribunto itself or for providing an interface for their own extensions.

A Scribunto library will generally consist of five parts:


 * The PHP portion of the library.
 * The Lua portion of the library.
 * The PHP portion of the test cases.
 * The Lua portion of the test cases.
 * The documentation.

Existing libraries serve as a good example.

Library
The PHP portion of the library is a class that must extend. See the documentation for that class for implementation details. In the Scribunto extension, this file should be placed in, and a mapping added to. Other extensions should use the  hook. In either case, the key should match the Lua module name ("mw.name" for libraries in Scribunto, or "mw.ext.name" for extension libraries).

The Lua portion of the library sets up the table containing the functions that can be called from Lua modules. In the Scribunto extension, the file should be placed in. This file should generally include boilerplate something like this:

The module in  (load this with  ) contains some functions that may be helpful.

Be sure to run the Scribunto test cases with your library loaded, even if your library doesn't itself provide any test cases. The standard test cases include tests for things like libraries adding unexpected global variables. Also, if the library is loaded with PHP, any upvalues that its Lua functions have will not be reset between #invoke's. Care must be taken to ensure that modules can't abuse this to transfer information between #invoke's.

Test cases
The Scribunto extension includes a base class for test cases,, which will run the tests against both the LuaSandbox and LuaStandalone engines. The library's test case should extend this class, and should not override. In the Scribunto extension, the test case should be in  and added to the array in   (in  ); extensions should add the test case in their own   hook function, probably conditional on whether   is set.

Most of the time, all that is needed to make the test case is this:

class ClassNameTest extends Scribunto_LuaEngineTestBase { protected static $moduleName = 'ClassNameTest'; function getTestModules { return parent::getTestModules + array(             'ClassNameTest' => __DIR__ . '/ClassNameTests.lua';          ); } }

This will load the file  as if it were the page "Module:ClassNameTests", expecting it to return an object with the following properties:


 * count: Integer, number of tests
 * provide( n ): Function that returns three values:, the name of test  , and a string that is the expected output for test.
 * run( n ): Function that runs test  and returns one string.

If  is declared as shown, "Module:TestFramework" is available which provides many useful helper methods. If this is used,  would look something like this:

local testframework = require 'Module:TestFramework' return testframework.getTestProvider( {    -- Tests go here } )

Each test is itself a table, with the following properties:


 * name: The name of the test.
 * func: The function to execute.
 * args: Optional table of arguments to pass to the function.
 * expect: Results to expect.
 * type: Optional "type" of the test, default is "Normal".

The type controls the format of  and how   is called. Included types are:


 * Normal:  is a table of return values, or a string if the test should raise an error.   is simply called.
 * Iterator:  is a table of tables of return values.   is called as with an iterated for loop, and each iteration's return values are accumulated.
 * ToString: Like "Normal", except each return value is passed through.

Test cases in another extension
There are (at least) two ways to run PHPUnit tests:


 * 1) Run phpunit against core, allowing the tests/phpunit/suites/ExtensionsTestSuite.php to find the extension's tests using the UnitTestsList hook. If your extension's test class names all contain a unique component (e.g. the extension's name), the   option may be used to run only your extension's tests.
 * 2) Run phpunit against the extension directory, where it will pick up any file ending in "Test.php".

Either of these will work fine if Scribunto is loaded in LocalSettings.php. And it is easy for method #1 to work if Scribunto is not loaded, as the UnitTestsList hook can easily be written to avoid returning the Scribunto test when  is not set.

But Jenkins uses method #2. For Jenkins to properly run the tests, you will need to add Scribunto as a dependency for your extension. See for an example of how this is done.

If for some reason you need the tests to be able to run using method #2 without Scribunto loaded, one workaround is to add this check to the top of your unit test file:

if ( !isset( $GLOBALS['wgAutoloadClasses']['Scribunto_LuaEngineTestBase'] ) ) { return; }

Documentation
Modules included in Scribunto should include documentation in the Scribunto libraries section above. Extension libraries should include documentation in a subpage of their own Extension page, and link to that documentation from.

License
This manual is derived from the Lua 5.1 reference manual, which is available under the MIT license.

This derivative manual may also be copied under the terms of the same license.