Модуль:Обратная ссылка/док[править введение]

[обновить]

Эта страница документации, она будет включена в основную страницу. Больше информации на странице Шаблон:Документация.

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

Преобразование осуществляется функцией reverseLink. Вне модулей она может использоваться через шаблон {{Обратная ссылка}}.

Использование

Функция принимает два обязательных неименованных аргумента: первый — русскоязычное название, второй — страница со списком преобразований. Последняя также может быть задана по названию аргумента страница.

Следующие два аргумента (могут быть указаны под названиями префикс и суффикс) соответственно задают префикс и суффикс цели ссылки. Если они не указаны, то будут по возможности использоваться значения, заданные в странице соответствий (в объекте или подтаблице настройки).

По умолчанию функция возвращает значение nil, если произошла ошибка при загрузке страницы соответствий (например, если её нет или в ней синтаксическая ошибка), а также если не найдено соответствие указанному названию. Если задать дополнительный аргумент строгий не с пустым значением, то в этих случаях вместо возвращения nil возникнет ошибка модуля.

Зависимости

• Модуль:Специальные утилиты — функции tryLoadData и tryLoadJsonData для загрузки страниц соответствий.
• Страницы преобразований