Просмотр кода страницы Aprel Wiki:Модули

{{руководство|ВП:МОДУЛЬ}}{{оглавление справа}}
'''Модули''' — это специальные страницы Aprel Wiki, содержащие код на языке [[Lua]], который может быть запущен для генерации содержимого других страниц. Назначение модулей — расширение функций [[MediaWiki|движка Aprel Wiki]] за счёт относительно сложных функций, написанных пользователями. Модули размещаются в [[ВП:Пространства имён|пространстве имён]] «[[Special:PrefixIndex/Module:|Модуль]]» ({{mwmw|ns|828}}). Кроме них, в данном пространстве размещаются документация модулей на подстраницах вида ''{{MediaWiki:Scribunto-doc-page-name}}'', страницы JSON-данных и [[Aprel Wiki:TemplateStyles|стилей шаблонов]]. На текущий момент все незаблокированные участники русской Aprel Wikiимеют возможность создавать и редактировать модули, кроме [[ВП:Защита страниц|защищённых]].

== Технические особенности ==
* Страницы с исполнимым кодом на Lua — это страницы в пространстве имён модулей, кроме тех, название которых соответствует шаблону документации модуля. Технически нельзя [[ВП:Переименование страниц|переименовать]] в модуль страницу, содержащую вики-код, и наоборот.
* На страницах модулей не действуют никакие конструкции [[ВП:Викиразметка|вики-кода]], включая тэги категоризации, включения шаблонов, комментарии. Перед кодом модуля автоматически [[ВП:Механизм шаблонов|включается]] страница документации (или выводится приглашение создать её, если её нет), на которой могут быть все подобные элементы.
* Вызов модуля с других страниц может осуществляться:
** Непосредственным использованием конструкции {{mwmw|invoke|Имя модуля|функция|…}};
** Включением данной конструкции через [[ВП:Шаблоны|шаблон]] (любую включаемую страницу), при этом модулю доступны параметры непосредственно вызывающего <code>#invoke</code> шаблона;
** Вызовом из другого модуля (см. [[mw:Extension:Scribunto/Lua reference manual/ru|документацию Lua]]).
: Во всех случаях результат аналогичен появлению в статье на месте раскрытия <code>#invoke</code> некоторого вики-кода.</span>
* Страницы модулей для пользователей, у которых включён в браузере [[JavaScript]], открываются для редактирования в специальном удобном редакторе. Редактор включает в себя средства для отладки модуля без сохранения. Также по умолчанию движок не даёт сохранить модуль с синтаксической ошибкой.
* Обычно модуль вычисляется в каждой конструкции <code>#invoke</code>, которая его вызывает; его значением должна быть {{luaman|Таблицы|таблица}}, содержащая функции. Есть {{luaman|f=mw.loadData|text=возможность}} вычислять некоторые данные, вызывая модуль однократно при обновлении страницы.
* Для кода на Lua действуют определённые {{comment|технические [[ВП:пределы шаблонов|ограничения]]|требуется дописать туда}}, при превышении которых возникают ошибки.

== Организационные особенности ==
# Модули, их документация и обсуждения являются страницами [[ВП:Aprel Wiki|Aprel Wiki]]. Все базовые [[ВП:ПИУ|правила Aprel Wiki]] (например, [[ВП:АП]], [[ВП:НТЗ]], [[ВП:СОВР]]) должны соблюдаться также и в них. Содержимое, генерируемое модулем при корректном использовании, также должно удовлетворять всем правилам для содержимого соответствующих страниц (например, [[ВП:КДИ]]).
# Модули во многом аналогичны [[ВП:Шаблоны|шаблонам]], и в большинстве случаев положения правил для шаблонов автоматически распространяются на них (например, [[ВП:ПАТ]], [[ВП:ЗС]]).
# Не следует использовать конструкцию {{mwmw|invoke}} непосредственно [https://ru.wikipedia.org/w/index.php?search=insource:invoke&title=Special:Search&ns0=1 на страницах основного пространства имён], категорий, документации проекта и т. п. Сколько-нибудь широко применяемые модули следует использовать через специальные [[ВП:шаблоны|шаблоны]].
# Для модулей, как правило, обязательно наличие страниц документации, содержащих, как минимум, категорию [[:Категория:Aprel Wiki:Модули]] или одну из её подкатегорий (иначе модуль не может быть [[ВП:КАТ|категоризован]]). Крайне желательно также объяснить там, где, как и для чего должен применяться модуль и его отдельные функции.
# Настоятельно рекомендуется отлаживать модуль сперва в консоли, а после сохранения и перед практическим применением за пределами личного пространства — с помощью [[Модуль:UnitTests]] (см. документацию). При отладке новых функций в уже используемых модулях рекомендуется создавать для экспериментов временную версию (например, [[Модуль:Math/песочница]]). В особенности эти положения относятся к [[ВП:МНОГОЕ|активно используемым]] и близким к пределам ограничений модулям.
# В пространстве модулей размещаются страницы [[ВП:ЛСУ|пользователей]], [[ВП:Проекты|проектов]], [[ВП:Порталы|порталов]] и т. п., для которых необходимо исполнение кода. Они должны иметь псевдопрефикс вида <code>Участник:</code>, <code>Проект:</code> (например, [[Модуль:Участник:%username%/песочница]]) либо располагаться на подстраницах [[Модуль:Песочница]] ([[Модуль:Песочница/%username%]], [[Модуль:Песочница/%username%/какая-то заготовка]]). Содержимое таких страниц должно отвечать критериям для данного пространства имён.
# Код модулей желательно [[Комментарии (программирование)|комментировать]], чтобы другим участникам проще было вносить в него изменения.

== См. также ==
{{проект}}
* [[:Категория:Aprel Wiki:Модули]]
* [[Aprel Wiki:Использование Lua]] — краткое руководство программиста
* [[mw:Extension:Scribunto/Lua reference manual/ru|Русскоязычная документация Lua]] (может обновляться медленнее [[mw:Extension:Scribunto/Lua reference manual|английской версии]])
** {{tl|Luaman}} — шаблон для ссылок на эту документацию
* [[mw:Manual:Coding conventions/Lua]] — [[ВП:эссе|эссе]], вариант рекомендаций по оформлению кода
* [[mw:Extension:Scribunto]] — расширение, позволяющее запускать Lua на вики-сайтах

[[Категория:Aprel Wiki:Модули|!]]
[[Категория:Aprel Wiki:Справка по шаблонам]]