Модуль:Transclude
Документація модуля[перегляд] [редагувати] [історія] [очистити кеш]Нажаль такому корисному Модулю не вистачае документації, деякі відомості можна почерпнути з коментарів функцій модуля, або зі сторинок, яки його викликають (Special:WhatLinksHere/Модуль:Transclude), документація, якщо з'явиться, то швидше за все російською мовою: ru:Module:Transclude/doc (Модуль:Transclude/документація), якщо, звичайно, Вам допоможе цей шаблон-посилання.
 | Цей модуль позначений як К:бета-модуль (25), і готовий до широкого вжитку. Він і досі новий і його слід використовувати з певною обережністю, щоб гарантувати, передбачувані результати. |
 | Цей модуль 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}})
| Документація вище включена з Модуль:Transclude/документація. (ред. | історія) Дописувачі можуть експериментувати на підсторінках пісочниця (створити | дзеркало) та тести (створити) цього модуля. Будь ласка, додавайте категорії до підсторінки /документація. Підсторінки цієї сторінки. |
local M={}
---------------------------------------------------------
-- Функции для работы с параметрами вызвавшего шаблона --
---------------------------------------------------------
function M.uni(f)-- Унификация имён параметров; псевдонимы.
local tf, cs=f:getParent(), {};
local findcs=function(a) cs[a]=f.args[a] end;
(f.args['|фіксрег'] or f.args['|fixreg'] or ''):gmatch(' *([^%n]+) *', findcs);
-- {{!}}фиксрег = список разделённых новыми строками аргументов, регистр которых не менять
local args,am={};
for a,v in pairs(tf.args) do
am = a:lower():gsub('[_ ]+',' ');
args[ cs[a] and a or ( f.args[am] or am ) ] = v
end
return tf:expandTemplate{title=f.args[1]; args=args}
end
M['forall'] = function(f)-- Итератор по аргументам вызывающего шаблона.
-- f.args[1] — имя вызываемого шаблона.
local tf,ac,res,tln,sep,gl=f:getParent(),{},{},f.args[1]:match('^%s*([^#]-)%s*#(.*)$'),tonumber(f.args[2]) or 1;
if not tln then tln,sep=f.args[1]:match('^%s*(.-)%s*$'),'' end
for p,k in pairs(f.args) do if type(p)=='string' then ac[p]=k end end
local ans,i,ablk={},1;
while tf.args[i] do
if gl==1 then
ans[i] = tf:expandTemplate{ title=tln; args={tf.args[i], unpack(ac)} }
else
ablk={}; for j = 0, gl-1 do ablk[j] = tf.args[i*gl+j] end;
for k,v in pairs(ac) do ablk[k]=v end;
ans[i] = tf:expandTemplate{ title=tln; args=ablk }
end
i = i+1
end
return table.concat(ans,sep)
end
function M.escapeparams(f)-- Нормализация
-- (обезопасивание) значений параметров.
local i,ac,acn=0,{},{};
local function repl(s)
return s:gsub('{{','{{Х'):gsub('}}',"{{ЪЪ}}"):gsub('{{Х','{{ХХ}}')--: --замена фигурных скобок
:gsub('=','{{=}}'):gsub('|','{{!}}')
end
for k,v in pairs(f:getParent().args) do
if type(k)=='number' then ac[k]=repl(v); i=i+1
else acn[repl(k)]=repl(v)end
end
if i ~= #ac-1 then --нумерованные параметры не сплошные
for k,v in pairs(ac) do
if k>i then acn[tostring(k)] = v; ac[k]=nil end-- удалять в pairs можно
end
end
for k,v in pairs(acn) do
table.insert(ac, table.concat(f.args[2] or "\n ", k, f.args[3] or ' = ', v, f.args[4] or '') )
end
return table.concat(ac,'|')
end
function M.npc(f)-- Итератор по именованно-нумерованным параметрам.
local tf, ac, ns = f:getParent(), {}, {};
for k,v in pairs(tf.args) do
local b,n = string.match(k,"^(.-)%s*(%d*)$");
n = tonumber(n);
if n then
if f.args[b] then
if not ac[n] then
ac[n] = mw.clone(f.args)
setmetatable( ac[n], nil ) -- metatable ломает expandTemplate
table.insert(ns,n)
end
ac[n][b] = v
end--if f.args[b]
end--if n
end--for
table.sort(ns);
local tmod = #f.args-1
for n,i in ipairs(ns) do
ns[n]=tf:expandTemplate{ title=f.args[n % tmod+1]; args=ac[i] }
end
return table.concat(ns)
end
function M.call(f)-- Просто вызывает шаблон с аргументами вызывающего.
return f:getParent():expandTemplate{ title=f.args[1]; args=f:getParent().args }
end
function M.join(f)-- Версия forall с разделителем вместо шаблона.
-- f.args[1] — разделитель.
local t, tf, i = {}, f:getParent(), tonumber(f.args.from) or 1
local k,j,m = tonumber(f.args.to),i,f.args[3]
while k and i<=k or tf.args[i] do
if (
({
['_']=function(s)return s~=''end;
['s']=function(s)return not tostring(s):match("^%s*$")end
})[m] or function() return true end
)(tf.args[i]) then
t[j]=tf.args[i];
j=j+1
end;
i=i+1
end
return mw.text.listToText(t,f.args[1],f.args[2] or f.args[1])
end
-------------------------------------------------------
-- Функции для работы с параметрами шаблона в invoke --
-------------------------------------------------------
--[[
function M.split(f)-- Разрезает строку f.args[3]
-- указанным в f.args[2](?) разделителем
-- и передаёт куски шаблону f.args[1].
local tf, ac, oldi, i, e =f:getParent(), {}, 1, f.args[3]:find(f.args[1],1,true)
-- «f.args[1]» в строке выше — точно не ошибка? --Incnis Mrsi
while i do
table.insert( ac, f.args[3]:sub(oldi, i-1) ); oldi=e+1
end
table.insert( ac, f.args[3]:sub(oldi, #f.args[3]-1) )
return f:getParent():expandTemplate{ title=f.args[1]; args=ac }
end
]]
function M.cycle(f)-- Действует аналогично forall по числовой переменной,
-- изменяющейся (по умолчанию, от 1) до f.args[2].
local tf,ac=f:getParent(),{};
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*$');
local acr={};
if not tonumber(s) then error('Початок циклу «'..s..'» — не число') end
local function dc()
local r=tf:expandTemplate{ title=f.args[1]; args={s,unpack(ac)} }
s=s+1;
if r~='' then table.insert(acr,r); return r end
end
if type(fh)=='number' then
while s<fh do dc() end
elseif fh~='' then
while tf:expandTemplate{ title=fh; args={s,unpack(ac)} } do dc() end
else
while dc() do end
end
return table.concat(acr)
end
--[[Функция не пашет как можно ждать — пробелы отсекаются после передачи параметров в expandTemplate
function M.pass(f)-- Передаёт шаблону параметры без подрезки.
local ac,i={},1;
while f.args[2*i] do ac[ tonumber(f.args[2*i]) or f.args[2*i] ] = f.args[2*i+1]; i=i+1 end;
return f:getParent():expandTemplate{ title=f.args[1]; args=ac }
end
]]
return M