WikiDer > Справка: Lua для начинающих - Википедия

Обзор

Lua это язык программирования, реализованный в Википедии с некоторыми существенными ограничениями через Скрибунто. Его цель - позволить вам обрабатывать данные, доступные на страницах содержимого Википедии, чтобы обеспечить различные виды настраиваемого отображения информации.

Самый важный файл справки - это Справочное руководство MediaWiki Scribunto Lua, который предоставляет краткую сводку вызовов языка и стандартных библиотек, реализованных в MediaWiki.

Общие, не связанные с MediaWiki Справочное руководство по Lua может - будучи очень хорошо написанным, всеобъемлющим и информативным - быть проблематичным для новичков, потому что некоторые функции не работают в Википедии, начиная с Распечатать(), который появляется в стандартных программах Lua "hello world".

Проблемы с текущей реализацией

Помимо отсутствия Распечатать(), отсутствуют другие функции - см. Отличия от стандартного Lua для полного списка.

В настоящее время рекомендуется использовать mw.ustring функции вместо нить, потому что последний иногда не работает с символами Unicode.

Вход

Программы запускаются только тогда, когда страница «проанализирована» (когда она или содержащаяся в ней страница изменяется или просматривается), а не каждый раз, когда вы просматриваете вывод. Поэтому не может быть удобного модуля Lua, который позволял бы вам вводить температуру по Фаренгейту в поле ввода и возвращать соответствующую температуру по Цельсию при нажатии кнопки или позволял бы вам щелкнуть сегмент визуализации набора Мандельброта на странице. расширять его сколько угодно раз. Должна существовать настоящая вики-страница (или, по крайней мере, страница, которую вы отправили для предварительного просмотра), содержащую входные данные.

Однако можно использовать библиотечные функции, такие как mw.title.new, для импорта содержимого с любой страницы текстового содержимого в Wiki. Однако вы не можете импортировать данные из файлов, даже из файлов .svg, содержащих текстовые данные XML.

Вызов модуля Lua

Вызовы Lua очень похожи на шаблоны, и состоит из небольшого блока текста, например

{{#invoke:ConvertNumeric| decToHex | 7733}}

Этот текст вызывает сам сценарий Lua, который находится в Модуль: пространство имен. Результатом этого вызова является отправка информации в #invoke block в модуль Lua и заменить все в скобках фрагментом текста, который он отправляет обратно. (Буквально в заявлении "возврат")

Обратите внимание, что первый «параметр» в данном случае decToHex, на самом деле функция вызывается в модуле Lua. Это поле всегда должно быть включено в любой #invoke. Тем, кто не знаком с модулями, особенно кодировщикам шаблонов Википедии, которые ожидают чего-либо после | чтобы быть параметром, необходимость в этом дополнительном поле вызывает удивление, особенно если все использования модуля зависят от его наличия. При документировании вашей работы для них полезно включить явную инструкцию по использованию, например {{mlx | ConvertNumeric | decToHex | 7733}} чтобы они поняли, что нельзя его пропустить.

Для многих существующих модулей пример #invoke сценария (и многое другое) предоставляется на Обсуждение модуля: страница. Авторам удобно иметь возможность быстро перейти на вкладку обсуждения, чтобы посмотреть на последствия своих изменений, но никогда не следует включать страницу обсуждения в качестве шаблона - люди могут действительно говорить на ней!

Другой пример: использование LuaCall для выполнения одной инструкции Lua

Как новичок или в обычном разговоре на странице обсуждения, у вас может быть только один небольшой расчет, для которого вы хотите использовать Lua, но не хотите писать полный модуль. Вы можете найти Модуль: LuaCall удобно для этого. Например, вы можете проверить, насколько жадный Шаблон Lua работает:

• {{#invoke: LuaCall | main | a = bbbbbbbbbba | b = bb (. *) b (. +) bba | string.match (a, b)}} → BBBB

или подсчитайте длину Вы знали крючок или текстовая часть Вы знали кандидат:

• {{#invoke: LuaCall | main | a = ... что вы можете подсчитать длину вашего DYK-хука с помощью модуля Lua? | string.len (a)}} → 69

Однако в этих конкретных примерах Модуль: Строка может выполнять обе эти задачи.

Сценарий на Модуль: LuaCall был написан для приема любого набора именованных параметров somename = значение, для каждого хранящего строку ценить в переменной с именем какое-то имя, а затем позволяет вам использовать эти переменные в качестве параметров для любой функции, доступной в Lua. Затем сценарий возвращает только первый значение, возвращаемое функцией (помните, что Функции Lua могут возвращать несколько значений, но в этом случае из модуля возвращается только первый).

Ошибки

Ошибки Lua отображаются в виде красных сообщений «Ошибка сценария». Если Javascript включен, красное сообщение об ошибке сценария - это ссылка что обычно позволяет вам вернуться к той строке в модуле, где произошла ошибка. Есть некоторые исключения, например, «Модуль не найден», если имя самого модуля введено с ошибкой, или «Указанная функция не существует», если заданное имя функции неверно.

Структура программы Lua: Вывод

Самая фундаментальная часть программы Wikipedia Lua - это возвращаться оператор, который переносит свой вывод обратно на страницу с #invoke. Ты может иметь функцию Lua, которая выполняется без ошибок, даже если она не содержит оператора return, но в Википедии это бессмысленно, поскольку программы Lua обычно не могут иметь побочных эффектов в Википедии.

Сам модуль должен возвращать Lua стол ценностей. Таблица Lua представляет собой список значений, разделенных запятыми и заключенных в фигурные скобки. Когда модуль вызывается #invoke, то функция его имя (первый аргумент после |) ищется в этой таблице. Эта функция, в свою очередь, должна возвращать что-то, что можно представить как нить.

Следовательно, return {mw.ustring.gmatch ("Привет, мир", "(. *)")} на самом деле является полным модулем Lua (хотя и очень странным) - он возвращает функцию, возвращаемую mw.ustring.gmatch (функция итератора, указанная в ссылке на Lua, цитированной выше) как единственный и неповторимый элемент в массиве (представленном внутри {}) - который при выполнении с использованием {{#invoke: ModuleName | 1}} выдает строку «Hello world». тем не мение, обычно так не делают. Обычно мы используем общую форму:

местный п = {} - Определяет переменную p как пустую таблицу, но * не * nil.функция п.главный( Рамка ) - Этот блок определяет элемент таблицы p ["main"] как функцию.    возвращаться "Привет, мир" - Строковый результат функции.конец - Завершает блок, определяющий объект функции p ["main"] (или p.main).возвращаться п - Это возвращает таблицу p, которая под ключом "main" содержит     - функция выше (p.main), которая при вызове возвращает строку «Hello world».

Обратите внимание, что функция p.main (кадр) ... конец эквивалентно p.main = функция (кадр) ... конец или же p ["main"] = функция (кадр) ... конец. Функция - это просто еще один тип значения, полученный с помощью ключа "главный" из таблицы п. Если вы хотите разрешить пользователям вызывать один и тот же модуль с {{#invoke:имя-модуля| привет}} вместо {{#invoke:имя-модуля| main}}, ты можешь написать p.hello = p.main чтобы скопировать ссылку на эту функцию на новый ключ в таблице. Вы даже можете написать p [""] = p.main, что приводит к {{#invoke:имя-модуля|}} для получения того же результата, что и {{#invoke:имя-модуля| main}}. Позже очень важно научиться думать о функциях как о типе данных для работы с такими библиотечными функциями, как mw.ustring.gsub, и построение функций-итераторов.

Структура программы Lua: ввод

В Рамка параметр выше (который почти всегда получает это имя в модулях Wikipedia Lua) получает другую таблицу, которая передается из страница, с которой звонят к модуль Lua. Он содержит удивительное количество материала, из которых лишь некоторые вещи беспокоят новичка.

Аргументы

frame.args содержит еще один таблица, а именно весь контент, отправленный пользователем в #invoke квадратные скобки, кроме первого аргумента, в котором указано имя функции, которая должна быть выполнена. Так что в {{#invoke:ConvertNumeric| decToHex | 3377}}, Струна "3377" это содержание frame.args [1] (который совпадает с кадр ["аргументы"] [1] но нет такой же как frame.args ["1"] или же кадр ["аргументы"] ["1"]). Для параметров без названия используются числа в качестве ключей (frame.args [1], frame.args [2]и т. д.), а именованные параметры - с именами параметров (строками) в качестве ключей (frame.args ["количество"], frame.args ["стиль"], так далее.).

Пример:

{{#invoke:имя модуля|имя функции| 3377 | 4 | count = 3 | style = bold}}

приводит к

frame.args [1]=3377, frame.args [2]=4, frame.args ["количество"]=3, frame.args ["стиль"]="смелый".

Родительский фрейм

В Рамка Существует родитель frame, ссылаясь на страницу, которая вызвала страницу, передающую сценарий, и вы также можете извлечь из нее аргументы. Просто пиши

parent = frame.getParent (кадр)

и parent.args будет содержать эти аргументы.

В Lua популярно использовать синонимичный оператор parent = frame:getParent (), отменяя необходимость писать Рамка дважды. Обратите внимание на двоеточие (:) вместо точки (.). родительский = кадр: getParent () означает то же самое, что и parent = frame.getParent (кадр). Для новичков это может сбивать с толку, и важно знать об этой идиоме. Однако, если вы используете его неправильно, ошибки сценария довольно хорошо указывают на то, что это была ошибка.

Базовая отладка

Отладка может начаться, как только вы напишете программы, и может быть выполнена просто с помощью конкатенации строк. Просто настройте переменную с некоторым узнаваемым именем, например, "debuglog", в вашей основной функции (p.main) с помощью такого оператора, как локальный отладчик = "". Это первоначальное определение помогает, потому что в противном случае оно будет ноль и объединение строки с nil приведет к ошибке. Теперь, когда у вас есть переменная, которую вы хотите протестировать, скажем x, просто напишите debuglog = debuglog .. "x =" .. tostring (x), и в конце вашей программы вернуть вывод .. debuglog «Tostring» - это функция, обеспечивающая интерпретацию x как строку, поэтому, если это таблица, nil и т. Д., Она будет отображаться как «table», «nil» и т. Д., А не как ошибка сценария.

Формат

В WP: руководство по стилю Lua дает некоторые базовые предложения по форматированию, ожидаемые редактором модуля Javascript, такие как использование отступов с четырьмя пробелами и сохранение if, then, else, заканчиваются на том же уровне отступа.

Комментарии в конце строки помечаются знаком -. Используй их. Многие модули для Википедии имеют простой, линейный дизайн, но это не значит, что четкая маркировка ваших разделов не поможет, когда вы в сотый раз вернетесь к коду. Руководство по стилю Lua дает дополнительные рекомендации по использованию функций, чтобы ваша работа была более организованной.

Досадные ошибки

Некоторые ошибки, о которых стоит помнить:

• Попытка вызвать строковое значение. Это означает, что вы забыли ... между строкой и переменной где-то в беспорядке, который вы объединяете.
• Переменная игнорирует все ваши усилия по присвоению ей чего-либо. Вы могли случайно написать два локальные операторы - один устанавливает значение переменной в ограниченном регионе, и когда программа покидает этот регион, вы возвращаетесь к старому значению.
• Пронумерованная запись в таблице игнорирует все ваши попытки присвоить ей. Это потому, что ["50"] не является а [50]. Обычно вы обрабатываете параметр (который вы могли получить от вызова как строку) со строковыми функциями в одном месте, но выполняли числовые операции в другом, оставляя вам два разных типа переменных для использования в качестве индекса.
• Некоторая графика, которую вы пытаетесь отобразить, уходит в упадок. (на самом деле ошибка HTML) Вы не закрыли свои