Module:Iteration
From Neodyland Wiki
More actions
This documentation is transcluded from Module:Iteration/doc.
 | This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | Note: This module is used on a great lot of pages. In order not to put too much load on the servers, edits should be kept to a bare minimum. Please discuss proposed changes on the talk page first.
|
The module uses frequently the template {{=}} for title = "="
This module contains the functions for different templates, solving their iteration problem
The MediaWiki template coding does not support the repetitive processing of a parameter set, which leads often to a very primitive and long chain of parameter checks in the kind of:{{#if:{{{1|}}} | perform an action with parameter 1 }}
{{#if:{{{2|}}} | perform an action with parameter 2 }}
{{#if:{{{3|}}} | perform an action with parameter 3 }}
{{#if:{{{4|}}} | perform an action with parameter 4 }}
•••
•••
{{#if:{{{33|}}} perform an action with parameter 33 }}
for loops this iterations should be possible, somehow. After long searching without any success and without an idea how to perform it, I asked at several forums and got finally from User:Trappist the monk the helping hint to solve it with a control structure like: local out = {}
for i, v in ipairs (args) do
table.insert (out, frame:expandTemplate{ title = title, args = v })
end
return table.concat (out)
The functions contained therein are from very simple, just one parameter to pass, to more complicated ones, where e.g. a pair of parameters needs kind of a flip-flop switch when always a tuple of e.g. an item and its correlated text needs to be passed.
When there are tuples, triples etc., the table.insert occurs, when the last element is processed; this performs problems when the last group is incomplete – it should be finished with empty values to trigger the table.insert. The check with table.maxn seems not to work correctly?
This problem is solved differently, for the function attribs with a primitive workaround.
Namespace lists
There are special lists for some namespaces:
- Filelist - for items of the namespace 6 (File:)
- Userlist - for items of the namespace 2 (User:)
- Linklist - for items of the namespace
0(main) — not yet - Templist - for items of the namespace
10(Template:) — not yet - Cat-list - for items of the namespace
14(Category:) — not yet - Mod-list - for items of the namespace
828(Module:) — not yet
Filelist
File list templates
The three templates {{Ifim}}, {{Ifim1}} and {{Ifimt}} avoid to display the file itself as an |other version=.
There are currently five templates creating file lists with the function:filelist
{{Other versions}}a vertical list (without initial){{Filelist}}a horizontal list (without initial){{Derivative versions}}a vertical list{{Derived from}}a vertical list{{File}}a horizontal list
All these templates are autoreferencing, and the support also the |gallery= option.
Other file lists
The function:svglang creates a list of just file_names and language_codes, for:
-
{{Svg lang}} {{Lang gallery}}{{Multilingual SVG diagrams}}
Much more is created by the function:ownbased for the template:
{{Own based}}
which will handle in the majority of cases just one file, but can serve an unlimited number.
This list can be controlled by the user to be displayed either horizontally or vertically.
{{Attribs}}
The template works, whether there is a user assigned for a file, or one filename follows another.
{{Emoji}}
The template displays a line of SVG emojis; Unicode characters/emojis can be displayed with the function emodis or emotab.
Variable iterations
A very simple iteration, usable for everything, is performed by function:iterate
- used by e.g.
{{Image extracted}},{{Image translated}},
More usable is the function:iteration for transclusions of a template with:
- a number of positional parameters which can change at each transclusion, and
- a number of positional parameters which are the same for all transclusions.
See template {{Iterate}}.
The function:loop is used by {{Repeat}}.
samefile function
When the name of one of the files is the same as the first one, it is enough to reference it with its extension after a dot, e.g. just ".jpeg". The most standard extensions can be abbreviated, e.g. ".j" will be sufficient for ".jpg" (only for lower case!).
The function incrhx increments a hexadecimal number (parm 1) by a decimal number (parm 2).
Valid numbers are assumed, no checking occurs!
When parameter 2 is preceded by a minus, the first number is decremented by the second one.
Userlist
- Userlist:
{{Userlist}}with many formatting parameters
Linklist
Templist
Other iterations
- Langlist:
- Colorbox:
{{ColorString}}and other color box templates - Legends :
{{Legtab}}combines single{{Legend}}s - Tleparms: the metatemplate
{{Tle}}displays the parameter usage of a template - Navigate:
{{Navcat}}navigates through color categories - Showname:
{{Showname}}helper template, for parameter tests - Emodis :
{{Emoji}}displays (one or many) Unicode characters
- The function
emodisdisplays Unicode characters / emojis; it can care for newlines, while - The function
emotabdisplays a table of files / emojis.
-- This module contains the functions for different templates, solving their iteration problems.
local p = {}
-- for Template:Ifim
function p.ifim1 (frame)
local args = mw.getCurrentFrame(): getParent().args;
local otab = {};
local p1 = args.p1 or "";
local p2 = args.p2 or "";
local p3 = args.p3 or "";
local p4 = args.p4 or "";
local p5 = args.p5 or "";
local fn = args.fn or "";
for _, v in ipairs(args) do
table.insert(otab, frame:expandTemplate{ title = "Ifim1", args = { v, p1, p2, p3, p4, p5, n= fn } });
end
return table.concat (otab)
end
-- for Template:Ifimc
function p.ifim2 (frame)
local args = mw.getCurrentFrame(): getParent().args;
local otab = {};
local p1 = args.p1 or "";
local p2 = args.p2 or "";
local p3 = args.p3 or "";
local p4 = args.p4 or "";
for _, v in ipairs(args) do
table.insert(otab, frame:expandTemplate{ title = "Ifim2", args = { v, p1, p2, p3, p4, v } });
end
return table.concat (otab)
end
-- for Template:Ifimt (param pairs)
function p.ifimt (frame)
local args = mw.getCurrentFrame(): getParent().args;
local otab = {};
local v1 = "";
local p1 = args.p1 or "";
local p2 = args.p2 or "";
local p3 = args.p3 or "";
local p4 = args.p4 or "";
for _, v in ipairs(args) do
if v1 == "" then
v1 = mw.text.trim( v );
else
table.insert(otab, frame:expandTemplate{ title = "Ifim2", args = { v1, p1, p2, p3, p4, v } });
v1 = "";
end
end
if v1 ~= "" then
table.insert(otab, frame:expandTemplate{ title = "Ifim2", args = { v1, p1, p2, p3, p4, "" } }); -- last elem
end
return table.concat (otab)
end
-------------------------------------------------------
-- for Template:SVG lang, Template:Lang gallery and others
function p.svglang (frame)
local dirp = frame.args-- global parms
local titl = dirp [1] or "Source thumb" -- SVG lang; "Lang gallery thumb";
local args = mw.getCurrentFrame(): getParent().args;
local otab = {};
local file = args.file or "";
for _, v in ipairs(args) do
table.insert(otab, frame:expandTemplate{ title = titl, args = { file, mw.text.trim(v) } });
end
return table.concat (otab)
end
-- horizontal file list for: Template:Filelist; Template:File
-- vertical file list for: Template:Other versions; Template:Derived from, Template:Derivative versions
function p.filelist (frame)
-- local locp = frame -- 1 local parm
local dirp = frame.args-- global parms
local args = mw.getCurrentFrame(): getParent().args;
local ctab = {};
local ntab = {};
local dtab = {};
local otab = {};
local qtab = {};
local rtab = {};
local vtab = {};
local ktab = {};
local itab = {};
local xtab = {};
local btab = {};
local mnum = 0;
local dir = dirp[1] or "none"
local nam = args.n or args.name or "";
local dis = args.d or args.dis or args.display or "";
local opt = args.o or args.opt or args.option or "";
local pr4 = args.par4 or args.qpar or "";
local pr5 = args.par5 or args.rpar or "";
local pr6 = args.par6 or args.vpar or "";
local by0 = args.user or args.by or "";
local wik = args.w or args.k or args.wiki or args.sisterproject or "";
local int = args.i or args.int or args.ind or args.inter or "";
local pfx = args.p or args.x or args.pfx or args.prefix or ""; -- 'list' item {{Comma}}
if mw.ustring.sub(dis, -2) == 'px' then
dis = mw.ustring.sub(dis, 1, mw.ustring.len(dis) -2)
end
if dir == "vert" and pfx == "" then
pfx = "<br><span style=color:#69F>✦ </span>"; -- 'list' item
end
for i, v in ipairs(args) do
ntab [i] = args ["n" .. tostring( i )] or args ["l" .. tostring( i )] or "-";
dtab [i] = args ["d" .. tostring( i )] or "-";
otab [i] = args ["o" .. tostring( i )] or "-";
qtab [i] = args ["q" .. tostring( i )] or "-";
rtab [i] = args ["r" .. tostring( i )] or "-";
vtab [i] = args ["v" .. tostring( i )] or "-";
ktab [i] = args ["k" .. tostring( i )] or "-";
itab [i] = args ["i" .. tostring( i )] or "-";
xtab [i] = args ["x" .. tostring( i )] or "-";
btab [i] = args ["b" .. tostring( i )] or args ["by" .. tostring( i )] or "-";
mnum = i;
end
for i, v in ipairs(args) do
local nm = nam; if ntab[i] ~= "-" then nm = ntab[i] end
local ds = dis; if dtab[i] ~= "-" then ds = dtab[i] end
local op = opt; if otab[i] ~= "-" then op = otab[i] end
local p4 = pr4; if qtab[i] ~= "-" then p4 = qtab[i] end
local p5 = pr5; if rtab[i] ~= "-" then p5 = rtab[i] end
local p6 = pr6; if vtab[i] ~= "-" then p6 = vtab[i] end
local pk = wik; if ktab[i] ~= "-" then pk = ktab[i] end
local pi = int; if itab[i] ~= "-" then pi = itab[i] end
local px = pfx; if xtab[i] ~= "-" then px = xtab[i] end
local by = by0; if btab[i] ~= "-" then by = btab[i] end
local vv = v;
if vv == "" and i > 1 then -- and ps .. pt ~= ""
vv = args [1];
end
if vv ~= "" then
if dir == "hori" then
px = "";
if i == 1 then
px = " "
elseif i == mnum then
table.insert(ctab, frame:expandTemplate{ title = "Conj-and" });
else
table.insert(ctab, frame:expandTemplate{ title = "Comma" });
end
else -- elseif dir == "vert" then
if i == 1 then
px = " "
end
end
table.insert(ctab, frame:expandTemplate{ title = "F", args = {vv, nm, ds, op, p4, p5, p6, l= pk, lang= pi, p= px, by= by} });
end
end
return table.concat (ctab)
end
-- for Template:Attribs (param pairs)
function p.attribs (frame)
local args = mw.getCurrentFrame(): getParent().args;
local otab = {};
local ftab = {};
local ptab = {};
local rtab = {}
local rnum = 0;
local tp = args.type or "SVG"; -- needs check
local un = args.by or args.U or args.u or "";
local tt = args.t or args.to or "";
local f = args.f or args.from or tt;
local p = args.p or args.part or "";
local vx = "";
local ux = "";
local ft = "";
for i, v in ipairs(args) do
ftab [i] = args ["f" .. tostring( i )] or ".";
ptab [i] = args ["p" .. tostring( i )] or ".";
-- table.maxnum (args) does not work
-- therefore the "rtab" workaround
table.insert(rtab, args[i]);
rnum = i
end
-- plus one item when odd number
if rnum % 2 == 1 then
table.insert( rtab, "" ); -- empty user name, to get a pair
end
--
for i, v in ipairs(rtab) do
if vx == "" then -- the 2nd 'v' can be empty
vx = mw.text.trim( v );
else
ux = mw.text.trim( v );
if ux == "" then ux = un end; -- does not work otherwise (?)
if ftab[i/2] == "." then
ft = f;
else
ft = ftab[i/2]
end
if ptab[i/2] == "." then
pt = p;
else
pt = ptab[i/2]
end
table.insert(otab, frame:expandTemplate{ title = "Attrib", args = {vx, ux, "-", tp, "", ux, tt, ft, pt } });
vx = "";
end
end
return table.concat (otab)
end
-- for Template:Legend-table (param pairs)
function p.legendt (frame)
local args = mw.getCurrentFrame(): getParent().args;
local otab = {};
local lg = args.lang or "";
local v1 = ""
-- same problem when not a last pair
for _, v in ipairs(args) do
if v1 == "" then
v1 = v;
else
table.insert(otab, frame:expandTemplate{ title = "Legend", args = { lang = lg, v1, v } });
v1 = "";
end
end
if v1 ~= "" then
table.insert(otab, frame:expandTemplate{ title = "Legend", args = { lang = lg, v1, "" } }); -- last elem
end
return table.concat (otab)
end
-- for Template:ColorString (Igen/cbox - param pairs)
function p.colorbox (frame)
local args = mw.getCurrentFrame(): getParent().args;
local otab = {};
local lg = args.lang or "{{PAGELANGUAGE}}"; --
local v1 = ""
local p2 = ""
for i, v in ipairs(args) do
if i <= 2 then
p2 = v;
else
if v1 == "" then
v1 = mw.text.trim( v );
else
table.insert(otab, frame:expandTemplate{ title = "Igen/cbox", args = { v1, v, p2, lang = lg } });
v1 = "";
end
end
end
if v1 ~= "" then
table.insert(otab, frame:expandTemplate{ title = "Igen/cbox", args = { v1, "", p2, lang = lg } }); -- last elem
end
return table.concat (otab)
end
return p;