Модуль: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}})
local p={}
-- Вызывает внутренний шаблон с аргументами объемлющего шаблона
function p.call(frame)
local template = frame.args[1]
local args = frame:getParent().args
return frame:expandTemplate{ title=template, args=args }
end
-- Общая реализация для forall и call
local function forallImpl(args, separator, conjunction, func)
-- нумерованные ключи из args
local keys = {}
-- перебор в произвольном порядке, даже для нумерованных ключей
for key, value in pairs(args) do
if type(key) == 'number' and value and value ~= '' then
table.insert(keys, key)
end
end
table.sort(keys)
local results = {}
for _, key in ipairs(keys) do
local value = func(args[key])
table.insert(results, value)
end
return mw.text.listToText(results, separator, conjunction)
end
-- Вызывает внутренний шаблон, передавая ему нумерованные параметры объемлющего шаблона по-одному
function p.forall(frame)
local template = frame.args[1]
local separator = frame.args.separator or ''
local conjunction = frame.args.conjunction or separator
local args = frame:getParent().args
local func = function(value)
return frame:expandTemplate{ title = template, args = {value} } -- или другой frame?
end
return forallImpl(args, separator, conjunction, func)
end
-- Берёт нумерованные аргументы объемлющего шаблона и склеивает их в единую строку
function p.join(frame)
local separator = frame.args[1] or ''
local conjunction = frame.args[2] or separator
local args = frame:getParent().args
local func = function(value)
return value
end
return forallImpl(args, separator, conjunction, func)
end
-- Служебная функция: удаляет дубликаты из отсортированного массива с нумерованными индексами
local function deleteDuplicates(args)
local res = {}
for key, value in pairs(args) do
if args[key+1] ~= value then
table.insert(res, value)
end
end
return res
end
-- Вызывает внутренний шаблон несколько раз, передавая в него блоки аргументов объемлющего шаблона
function p.npc(frame)
local args = frame:getParent().args
local templateFrame = frame:getParent()
local template = frame.args[1]
-- определение, блоки аргументов с какими номерами нужны:
-- если в объемлющем шаблоне есть "параметр12" и в вызове модуля есть "параметр", то вызывается 12-й блок
local nums = {}
for key, _ in pairs(args) do
local main, num = string.match(key, '^(.-)%s*(%d*)$')
num = tonumber(num)
-- учитывать "параметр12", только если задано "параметр"
if num and frame.args[main] then
table.insert(nums, num)
end
end
table.sort(nums)
nums = deleteDuplicates(nums)
-- проходить по нужным номерам блоков по возрастанию и однократно
-- подставлять в шаблон:
-- 1. общие аргументы данного модуля
-- 2. аргументы объемлющего шаблона вида "параметр12" как "параметр" в 12-й блок
local results = {}
for _, blockNum in ipairs(nums) do
-- общие аргументы модуля, которые передаются в каждый блок
local blockArgs = mw.clone(frame.args)
-- metatable ломает expandTemplate
setmetatable(blockArgs, nil)
for key, value in pairs(args) do
local main, num = string.match(key, '^(.-)%s*(%d*)$')
num = tonumber(num)
-- передавать "параметр12" как "параметр" в 12-й блок, только если есть "параметр" в вызове модуля
if blockNum == num and frame.args[main] then
blockArgs[main] = value
end
end
local blockText = templateFrame:expandTemplate{ title=template; args=blockArgs }
table.insert(results, blockText)
end
return table.concat(results)
end
-- Действует аналогично forall по числовой переменной, изменяющейся (по умолчанию, от 1) до f.args[2].
function p.cycle(f)
local tf,ac,op=f:getParent(), {}, f.args.output or 'inline';
local sep='';
if op == 'newline' then
sep='\n';
end
for p,k in pairs(f.args) do
if type(p)=='number' then
if p>2 then ac[p-1]=k end
else ac[p]=k
end
end
local s,fh = f.args[2]:match('^%s*(%-?%d+)%s*%.%.') or 1,
f.args[2]:match('%.%.%s*(%S.*)%s*$') or f.args[2] or '';
fh=tonumber(fh) or fh:match('^%s*(.-)%s*$');
s=tonumber(s);
local acr={};
if not s then error('Начало цикла «'..s..'» — не число') end
local function dc(order)
local r=tf:expandTemplate{ title=f.args[1]; args={s,unpack(ac)} }
if order == 'desc' then
s=s-1;
else
s=s+1;
end
if r~='' then table.insert(acr,r); return r end
end
if type(fh)=='number' then
if fh > s then
while s<=fh do dc('asc') end
else
while s>=fh do dc('desc') end
end
elseif fh~='' then
while tf:expandTemplate{ title=fh; args={s,unpack(ac)} } do dc('asc') end
else
while dc('asc') do end
end
return table.concat(acr, sep)
end
return p