Модуль:Transclude/doc

Это страница документации Модуль:Transclude.

Этот модуль относится к критическим. У него очень много включений или он используется с подстановкой. Из-за опасности вандализма или ошибочного редактирования он был защищён.

Функции

uni

{{#invoke:Transclude|uni|имя шаблона|список параметров…}}

Унифицирует обращение к шаблону, преобразует все имена параметров к нижнему регистру и позволяет задавать удобные псевдонимы (вводить параметрами в нижнем регистре).

forall

{{#invoke:Transclude|forall|имя шаблона}}

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

Если после имени шаблона поставить «#», следующая часть параметра будет разделителем, по умолчанию ничего.

escapeparams

{{#invoke:Transclude|escapeparams|(зарезервировано автором?)
|разделитель пар|альтернатива знаку равенства
|суффикс}}

Возвращает параметры (вызывающего шаблона? --Incnis Mrsi) через «|» с заменой «=» на «{{=}}» и «|» на «{{!}}». Параметры предусмотрены, но необязательны.

Предполагается когда-то снабдить интеллектом для незамены палочек в вики-ссылках и сортировки.

Назначение параметров f.args[2], f.args[3] и f.args[4] угадано участником Incnis Mrsi и может не соответствовать замыслу автора, исходная документация на них отсутствовала.

npc

{{#invoke:Transclude|npc|имя шаблона 1[|имя шаблона 2…]
|базовое имя[=значение]|…}}

Абзац сильно переписан, т.к. авторский текст был тотально невразумителен. --Incnis Mrsi

Итератор по массиву из групп параметров типа «параметрЛо:Mvar=…» (где номер Ло:Mvar группы — десятичное число) вызываемого шаблона. Группы подставляются в список из одного или более указанных шаблонов, заданных в виде нумерованных параметров. Одна группа в один из шаблонов, которые применяются по круговой очереди с возрастанием Ло:Mvar. Вывод шаблонов соединяется в том же порядке. Пример использования с двумя шаблонами: полосатые строки в таблицах.

Именованные параметры представляют базовые имена вызывающего шаблона (автор хотел сказать, его параметров? --Incnis Mrsi), которые будут также именами параметров для вызываемых шаблонов. Их значения (необязательные) будут использоваться по умолчанию, если для какого-то Ло:Mvar есть некоторые, но не все значения. По-видимому автор намекает на то, что когда для какого-то Ло:Mvar нет значений никаких, на нём процесс и останавливается. --Incnis Mrsi

Параметры сортируются при выводе по числам (начиная с ничего, потом ноль).Ло:Непонятно видимо, отсылка к оператору table.sort(ns); но смысл ускользает. --Incnis Mrsi

call

{{#invoke:Transclude|call|имя шаблона}}

Просто вызывает указанный шаблон с аргументами вызывающего.

join

{{#invoke:Transclude|join|разделитель|терминальный разделитель
|игнор|[from=номер|][to=номер|]список параметров…}}

Версия #forall без шаблона, объединяет нумерованные аргументы от from или 1 до to или первого отсутствующего через указанный разделитель.

Последний элемент можно присоединять иначе, задав терминальный разделитель (необязательный; по умолчанию «,» или «и»).

Если значение параметра игнор равно «s», то строки из пробелов игнорируются; если оно равно «_», то игнорируются пустые строки.

cycle

{{#invoke:Transclude|cycle|имя шаблона|Ло:Mvar|список параметров…}}

Действует аналогично #forall по числовой переменной, изменяющейся от 1 до Ло:Mvar. Другое начало можно задать в виде «-10..10» вместо Ло:Mvar. Также можно задать предел цикла в виде имени шаблона (если второго параметра нет или он имеет вид «1..», шаблон раскрывается, пока не пуст). Не увлекитесь!

Замечание: номера нумерованных параметров шаблона при записи увеличить на 1.

Примеры использования

Шаблон: Карточка/Temp (для {{#invoke:Transclude|npc}})