Модуль:Transclude/документація

Це підсторінка документації модуля Модуль:Transclude. Вона містить інформацію про використання, категорії та інший вміст, що не є частиною оригінальної сторінки модуля.

Нажаль такому корисному Модулю не вистачае документації, деякі відомості можна почерпнути з коментарів функцій модуля, або зі сторинок, яки його викликають (Special:WhatLinksHere/Модуль:Transclude), документація, якщо з'явиться, то швидше за все російською мовою: ru:Module:Transclude/doc (Модуль:Transclude/документація●), якщо, звичайно, Вам допоможе цей шаблон-посилання.

Цей модуль позначений як К:бета-модуль (26), і готовий до широкого вжитку. Він і досі новий і його слід використовувати з певною обережністю, щоб гарантувати, передбачувані результати.

Цей модуль Lua використовується на багатьох сторінках і його зміни будуть дуже помітними. Будь ласка, перевіряйте будь-які зміни на підсторінках /пісочниці та /тестів цього модуля, або у вашій пісочниці модуля, та зважайте на обговорення змін на сторінці обговорення перед їхнім впровадженням.

Функції

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

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

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

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

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

Не працює

pass

{{#invoke:Transclude|pass|назва шаблону|назва параметру|значення…}}

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

Приклади використання

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