Перейти к содержанию

Руниверсалис:Модули

Материал из энциклопедии Руниверсалис

Модули — это специальные страницы Руниверсалис, содержащие код на языке Lua, который может быть запущен для генерации содержимого других страниц. Назначение модулей — расширение функций движка Руниверсалис за счёт относительно сложных функций, написанных пользователями. Модули размещаются в пространстве имён «Модуль» ({{ns:828}}). Кроме них, в данном пространстве размещаются документация модулей на подстраницах вида Module:$1/doc, страницы JSON-данных и стилей шаблонов.

Технические особенности

  • Страницы с исполнимым кодом на Lua — это страницы в пространстве имён модулей, кроме тех, название которых соответствует шаблону документации модуля. Технически нельзя переименовать в модуль страницу, содержащую вики-код, и наоборот.
  • На страницах модулей не действуют никакие конструкции вики-кода, включая тэги категоризации, включения шаблонов, комментарии. Перед кодом модуля автоматически включается страница документации (или выводится приглашение создать её, если её нет), на которой могут быть все подобные элементы.
  • Вызов модуля с других страниц может осуществляться:
    • Непосредственным использованием конструкции {{#invoke:Имя модуля|функция|…}};
    • Включением данной конструкции через шаблон (любую включаемую страницу), при этом модулю доступны параметры непосредственно вызывающего #invoke шаблона;
    • Вызовом из другого модуля (см. документацию Lua).
Во всех случаях результат аналогичен появлению в статье на месте раскрытия #invoke некоторого вики-кода.
  • Страницы модулей для пользователей, у которых включён в браузере JavaScript, открываются для редактирования в специальном удобном редакторе. Редактор включает в себя средства для отладки модуля без сохранения. Также по умолчанию движок не даёт сохранить модуль с синтаксической ошибкой.
  • Обычно модуль вычисляется в каждой конструкции #invoke, которая его вызывает; его значением должна быть таблица, содержащая функции. Есть возможность вычислять некоторые данные, вызывая модуль однократно при обновлении страницы.
  • Для кода на Lua действуют определённые технические ограничения, при превышении которых возникают ошибки.

Организационные особенности

  1. Модули, их документация и обсуждения являются страницами Руниверсалис. Все базовые правила Руниверсалис (например, Руниверсалис:АП, Руниверсалис:НТЗ, Руниверсалис:СОВР) должны соблюдаться также и в них. Содержимое, генерируемое модулем при корректном использовании, также должно удовлетворять всем правилам для содержимого соответствующих страниц (например, Руниверсалис:КДИ).
  2. Модули во многом аналогичны шаблонам, и в большинстве случаев положения правил для шаблонов автоматически распространяются на них.
  3. Не следует использовать конструкцию {{#invoke}} непосредственно на страницах основного пространства имён, категорий, документации проекта и т. п. Сколько-нибудь широко применяемые модули следует использовать через специальные шаблоны.
  4. Для модулей, как правило, обязательно наличие страниц документации, содержащих, как минимум, категорию Категория:Руниверсалис:Модули или одну из её подкатегорий (иначе модуль не может быть категоризован). Крайне желательно также объяснить там, где, как и для чего должен применяться модуль и его отдельные функции.
  5. Настоятельно рекомендуется отлаживать модуль сперва в консоли, а после сохранения и перед практическим применением за пределами личного пространства — с помощью Модуль:UnitTests (см. документацию). При отладке новых функций в уже используемых модулях рекомендуется создавать для экспериментов временную версию. В особенности эти положения относятся к активно используемым и близким к пределам ограничений модулям.
  6. В пространстве модулей размещаются страницы пользователей, тем и т. п., для которых необходимо исполнение кода. Они должны иметь псевдопрефикс вида Участник:, Тема:. Содержимое таких страниц должно отвечать критериям для данного пространства имён.
  7. Код модулей желательно комментировать, чтобы другим участникам проще было вносить в него изменения.

См. также

Источник — https://xn--h1ajim.xn--p1ai/index.php?title=Руниверсалис:Модули&oldid=28260543