Редактирование: Модуль:Transclude/doc

{{СИШ}}
{{module rating|p}}
== Функции ==

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

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

=== forall ===
 &#123;{#invoke:Transclude|forall|''имя шаблона''}}

Вызывает заданный шаблон, передавая ему нумерованные параметры по-одному: сначала <code><nowiki>{{имя шаблона|1={{{1|}}}}}</nowiki></code>, потом <code><nowiki>{{имя шаблона|1={{{2|}}}}}</nowiki></code>, <code><nowiki>{{имя шаблона|1={{{3|}}}}}</nowiki></code> и т. д.

Предполагается, что параметры введены подряд, при пропуске поведение не определено (TODO).

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

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

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

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

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

<small>Абзац сильно переписан, т.к. авторский текст был тотально невразумителен. --Incnis Mrsi</small>
: [[Итератор]] по массиву из групп параметров типа «параметр{{mvar|k}}=…» (где номер {{mvar|k}} группы — десятичное число) вызываемого шаблона. Группы подставляются в список из одного или более указанных шаблонов, заданных в виде нумерованных параметров. Одна группа в один из шаблонов, которые применяются по круговой очереди с возрастанием {{mvar|k}}. Вывод шаблонов [[конкатенация|соединяется]] в том же порядке. Пример использования с двумя шаблонами: полосатые строки в таблицах. 

Именованные параметры представляют базовые имена вызывающего шаблона (автор хотел сказать, его параметров? --Incnis Mrsi), которые будут также именами параметров для вызываемых шаблонов. Их значения (необязательные) будут использоваться по умолчанию, если для какого-то {{mvar|k}} есть некоторые, но не все значения. <small>По-видимому автор намекает на то, что когда для какого-то {{mvar|k}} нет значений никаких, на нём процесс и останавливается. --Incnis Mrsi</small>

Параметры сортируются <u>при выводе</u> по числам (начиная с ничего, потом ноль).{{непонятно}}<small> видимо, отсылка к оператору table.sort(ns); но смысл ускользает. --Incnis Mrsi</small>

=== call ===
 &#123;{#invoke:Transclude|call|''имя шаблона''}}

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

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

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

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

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

<!-- === split ===
 &#123;{#invoke:Transclude|split|''имя шаблона''|''разделитель''|''строка параметров''}}

Разрезает строку указанным разделителем и передаёт куски шаблону.

Примечание: по состоянию на 15 мая не удалось сделать демонстрацию работы данной функции. Есть предположение, что в коде (см. комментарии) имеется ошибка.

{{#invoke:Transclude|split|code| |за code сада}}
{{#invoke:Transclude|split|code| |засада}}
{{#invoke:Transclude|split|code|-|за-сада}}
-->
=== cycle ===
 &#123;{#invoke:Transclude|cycle|''имя шаблона''|{{mvar|n}}|''список параметров''…}}

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

Замечание: номера нумерованных параметров шаблона при записи увеличить на 1.
<!--Не работает
=== pass ===
 &#123;{#invoke:Transclude|pass|''имя шаблона''|''имя параметра''|''значение''…}}

Передаёт шаблону параметры без подрезки.
-->
== Примеры использования ==
* [[Шаблон:Карточка]] (для &#123;{#invoke:Transclude|npc}})


<noinclude>
[[Категория:Модули:Документация]]</noinclude>