--
-- This module implements {{Infobox}}
--
--[[Change list:
Make infobox tracking category generate here, and not at Template:Infobox
Ability to specify data number ranges where template code specified in <nowiki> is executed with changing input
Add "Headerif" functionality to specify data ranges to check for whether a header should show
]]--
local p = {}
local navbar = require('Module:Navbar')._navbar
local args = {}
local origArgs
local parentArgs
local root
local function notempty( s ) return s and s:match( '%S' ) end
local function fixChildBoxes(sval, tt)
if notempty(sval) then
local marker = '<span class=special_infobox_marker>'
local s = sval
s = mw.ustring.gsub(s, '(<%s*[Tt][Rr])', marker .. '%1')
s = mw.ustring.gsub(s, '(</[Tt][Rr]%s*>)', '%1' .. marker)
if s:match(marker) then
s = mw.ustring.gsub(s, marker .. '%s*' .. marker, '')
s = mw.ustring.gsub(s, '([\r\n]|-[^\r\n]*[\r\n])%s*' .. marker, '%1')
s = mw.ustring.gsub(s, marker .. '%s*([\r\n]|-)', '%1')
s = mw.ustring.gsub(s, '(</[Cc][Aa][Pp][Tt][Ii][Oo][Nn]%s*>%s*)' .. marker, '%1')
s = mw.ustring.gsub(s, '(<%s*[Tt][Aa][Bb][Ll][Ee][^<>]*>%s*)' .. marker, '%1')
s = mw.ustring.gsub(s, '^(%{|[^\r\n]*[\r\n]%s*)' .. marker, '%1')
s = mw.ustring.gsub(s, '([\r\n]%{|[^\r\n]*[\r\n]%s*)' .. marker, '%1')
s = mw.ustring.gsub(s, marker .. '(%s*</[Tt][Aa][Bb][Ll][Ee]%s*>)', '%1')
s = mw.ustring.gsub(s, marker .. '(%s*\n|%})', '%1')
end
if s:match(marker) then
local subcells = mw.text.split(s, marker)
s = ''
for k = 1, #subcells do
if k == 1 then
s = s .. subcells[k] .. '</' .. tt .. '></tr>'
elseif k == #subcells then
local rowstyle = ' style="display:none"'
if notempty(subcells[k]) then rowstyle = '' end
s = s .. '<tr' .. rowstyle ..'><' .. tt .. ' colspan=2>\n' .. subcells[k]
elseif notempty(subcells[k]) then
if (k % 2) == 0 then
s = s .. subcells[k]
else
s = s .. '<tr><' .. tt .. ' colspan=2>\n' .. subcells[k] .. '</' .. tt .. '></tr>'
end
end
end
end
-- the next two lines add a newline at the end of lists for the PHP parser
-- https://en.wikipedia.org/w/index.php?title=Template_talk:Infobox_musical_artist&oldid=849054481
-- remove when [[:phab:T191516]] is fixed or OBE
s = mw.ustring.gsub(s, '([\r\n][%*#;:][^\r\n]*)$', '%1\n')
s = mw.ustring.gsub(s, '^([%*#;:][^\r\n]*)$', '%1\n')
return s
else
return sval
end
end
local function union(t1, t2)
-- Returns the union of the values of two tables, as a sequence.
local vals = {}
for k, v in pairs(t1) do
vals[v] = true
end
for k, v in pairs(t2) do
vals[v] = true
end
local ret = {}
for k, v in pairs(vals) do
table.insert(ret, k)
end
return ret
end
local function getArgNums(prefix, suffix)
-- Returns a table containing the numbers of the arguments that exist
-- for the specified prefix. For example, if the prefix was 'data', and
-- 'data1', 'data2', and 'data5' exist, it would return {1, 2, 5}.
suffix = suffix or ''
local nums = {}
for k, v in pairs(args) do
local num, retsuf = tostring(k):match('^' .. prefix .. '([1-9]%d*)'..suffix..'$')
if num then table.insert(nums, tonumber(num)) end
end
table.sort(nums)
return nums
end
local function processName (name, num, stop)
logic = args[name..'logic'..num]
if logic then
local text = mw.text.unstripNoWiki(args[name..'logic'..num])
for i = num, stop do
local count = tostring(i)
local strings = mw.ustring.gmatch(text, '(%a+)%$')
local finaltext = mw.ustring.gsub(text, '%a+%$', strings()..count)
out = mw.getCurrentFrame():getParent():preprocess(finaltext)
if out ~= '' then args[name..count] = out end
end
end
end
local function processRows()
startrownums = getArgNums ('datalogic')
for k = 1,#startrownums do
local num = startrownums[k]
local stop = tonumber(args['rowend'..num])
processName('data', num, stop)
processName('label', num, stop)
processName('rowclass', num, stop)
end
end
local function checkInRanges (s, e, nums, textlen, text)
start = tonumber (text[1])
last = tonumber (text[2])
while s < e do
c = math.floor((s+e)/2)
local var = nums[c] or nums[1]
if var > last then
e = c
elseif var < start then
s = c +1
else
if isInTable(text, var, textlen, 3) then
table.remove(nums, c)
e = e - 1
else
return true
end
end
end
--[[for i = 1,#nums do
if start < nums[i] and nums[i] < last then
return tr
ue
end
end]]--
return false
end
local function showIfRange (name, nums)
local nameif = name..'if'
local range = getArgNums(nameif)
local length = #nums
for i, num in ipairs(range) do
local snum = tostring(num)
local text = mw.text.split(args[nameif..snum], ',')
textlen = #text
if textlen == 1 then
text[2] = text[1]
end
show = checkInRanges (0, length, nums, textlen, text)
if not show then args[name..snum] = nil end
end
end
local function genDataCell (datacell, suffix, rowArgs)
dataCell
:attr('id', rowArgs['data'..suffix..'id'])
:addClass(rowArgs.class)
:cssText(rowArgs['data'..suffix..'style'])
:cssText(rowArgs.rowcellstyle)
:newline()
:wikitext(fixChildBoxes(rowArgs['data'..suffix], 'td'))
return datacell
end
local function addRow(rowArgs, snum)
-- Adds a row to the infobox, with either a header cell
-- or a label/data cell combination.
if rowArgs.header then
root
:tag('tr')
:addClass(rowArgs.rowclass)
:cssText(rowArgs.rowstyle)
:attr('id', rowArgs.rowid)
:tag('th')
:attr('colspan', args.columns)
:attr('id', rowArgs.headerid)
:addClass(rowArgs.class)
:addClass(args.headerclass)
:css('text-align', 'center')
:cssText(args.headerstyle)
:cssText(rowArgs.rowcellstyle)
:wikitext(fixChildBoxes(rowArgs.header, 'th'))
elseif rowArgs.data then
local row = root:tag('tr')
row:addClass(rowArgs.rowclass)
row:cssText(rowArgs.rowstyle)
row:attr('id', rowArgs.rowid)
if rowArgs.label then
row
:tag('th')
:attr('scope', 'row')
:attr('id', rowArgs.labelid)
:cssText(args.labelstyle)
:cssText(rowArgs.rowcellstyle)
:wikitext(rowArgs.label)
:done()
end
if not rowArgs.label then
dataCell
:attr('colspan', args.columns-1)
:css('text-align', 'center')
end
if snum then
for i = 0, args.columns-2 do
suffix = string.sub("abcdefghijklmnopqrstuvwxyz",i, i)
rowArgs = args['data'..suffix]
local datacell = row:tag('td')
datacell = wikitext(genDataCell(datacell, suffix, rowArgs))
end
end
end
end
local function renderTitle()
if not args.title then return end
root
:tag('caption')
:addClass(args.titleclass)
:cssText(args.titlestyle)
:wikitext(args.title)
end
local function renderAboveRow()
if not args.above then return end
root
:tag('tr')
:tag('th')
:attr('colspan', 2)
:addClass(args.aboveclass)
:css('text-align', 'center')
:css('font-size', '125%')
:css('font-weight', 'bold')
:cssText(args.abovestyle)
:wikitext(fixChildBoxes(args.above,'th'))
end
local function renderBelowRow()
if not args.below then return end
root
:tag('tr')
:tag('td')
:attr('colspan', '2')
:addClass(args.belowclass)
:css('text-align', 'center')
:cssText(args.belowstyle)
:newline()
:wikitext(fixChildBoxes(args.below,'td'))
end
local function renderSubheaders()
if args.subheader then
args.subheader1 = args.subheader
end
if args.subheaderrowclass then
args.subheaderrowclass1 = args.subheaderrowclass
end
local subheadernums = getArgNums('subheader')
for k, num in ipairs(subheadernums) do
local snum = tostring(num)
addRow({
data = args['subheader' .. snum],
datastyle = args.subheaderstyle or args['subheaderstyle' .. snum],
class = args.subheaderclass,
rowclass = args['subheaderrowclass' .. snum]
})
end
end
local function renderImages()
if args.image then
args.image1 = args.image
end
if args.caption then
args.caption1 = args.caption
end
local imagenums = getArgNums('image')
for k, num in ipairs(imagenums) do
local snum = tostring(num)
local caption = args['caption' .. snum]
local data = mw.html.create():wikitext(args['image' .. snum])
if caption then
data
:tag('div')
:cssText(args.captionstyle)
:wikitext(caption)
end
addRow({
data = tostring(data),
datastyle = args.imagestyle,
class = args.imageclass,
rowclass = args['imagerowclass' .. snum]
})
end
end
local function renderRows()
-- Gets the union of the header and data argument numbers,
-- and renders them all in order using addRow.
local datanums = getArgNums('data','%a')
showIfRange ('header', datanums)
local rownums = union(getArgNums('header'), datanums)
table.sort(rownums)
for k, num in ipairs(rownums) do
local snum = tostring(num)
addRow({
header = args['header' .. snum],
label = args['label' .. snum],
data = args['data' .. snum],
datastyle = args.datastyle,
class = args['class' .. snum],
rowclass = args['rowclass' .. snum],
rowstyle = args['rowstyle' .. snum],
rowcellstyle = args['rowcellstyle' .. snum],
dataid = args['dataid' .. snum],
labelid = args['labelid' .. snum],
headerid = args['headerid' .. snum],
rowid = args['rowid' .. snum]
}, snum)
end
end
local function renderNavBar()
if not args.name then return end
root
:tag('tr')
:tag('td')
:attr('colspan', '2')
:css('text-align', 'right')
:wikitext(navbar{
args.name,
mini = 1,
})
end
local function renderItalicTitle()
local italicTitle = args['italic title'] and mw.ustring.lower(args['italic title'])
if italicTitle == '' or italicTitle == 'force' or italicTitle == 'yes' then
root:wikitext(mw.getCurrentFrame():expandTemplate({title = 'italic title'}))
end
end
local function renderTrackingCategories()
if args.decat ~= 'yes' then
if args.child == 'yes' then
if args.title then
root:wikitext('[[Category:Pages which use embedded infobox templates with the title parameter]]')
end
elseif #(getArgNums('data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then
root:wikitext('[[Category:Articles which use infobox templates with no data rows]]')
end
title = mw.title.getCurrentTitle()
if title.namespace == 10 then
text = title.subpageText
if string.sub(text, 1, 7) == 'infobox' then
local cat = string.format('[[Category:Infobox template|%s]]', string.sub(text, 9))
root:wikitext(cat)
end
end
end
end
local function _infobox()
-- Specify the overall layout of the infobox, with special settings
-- if the infobox is used as a 'child' inside another infobox.
if args.child ~= 'yes' then
root = mw.html.create('table')
root
:addClass((args.subbox ~= 'yes') and 'infobox' or nil)
:addClass(args.bodyclass)
if args.subbox == 'yes' then
root
:css('padding', '0')
:css('border', 'none')
:css('margin', '-3px')
:css('width', 'auto')
:css('min-width', '100%')
:css('font-size', '100%')
:css('clear', 'none')
:css('float', 'none')
:css('background-color', 'transparent')
else
root
:css('width', '22em')
end
root
:cssText(args.bodystyle)
renderTitle()
renderAboveRow()
else
root = mw.html.create()
root
:wikitext(args.title)
end
renderSubheaders()
renderImages()
renderRows()
renderBelowRow()
renderNavBar()
renderItalicTitle()
renderTrackingCategories()
return tostring(root)
end
local function preprocessSingleArg(argName)
-- If the argument exists and isn't blank, add it to the argument table.
-- Blank arguments are treated as nil to match the behaviour of ParserFunctions.
if origArgs[argName] and origArgs[argName] ~= '' then
args[argName] = origArgs[argName]
end
end
local function preprocessArgs(prefixTable, step, suffix)
-- Assign the parameters with the given prefixes to the args table, in order, in batches
-- of the step size specified. This is to prevent references etc. from appearing in the
-- wrong order. The prefixTable should be an array containing tables, each of which has
-- two possible fields, a "prefix" string and a "depend" table. The function always parses
-- parameters containing the "prefix" string, but only parses parameters in the "depend"
-- table if the prefix parameter is present and non-blank.
if type(prefixTable) ~= 'table' then
error("Non-table value detected for the prefix table", 2)
end
if type(step) ~= 'number' then
error("Invalid step value detected", 2)
end
-- Get arguments without a number suffix, and check for bad input.
for i,v in ipairs(prefixTable) do
if type(v) ~= 'table' or type(v.prefix) ~= "string" or (v.depend and type(v.depend) ~= 'table') then
error('Invalid input detected to preprocessArgs prefix table', 2)
end
preprocessSingleArg(v.prefix)
-- Only parse the depend parameter if the prefix parameter is present and not blank.
if args[v.prefix] and v.depend then
for j, dependValue in ipairs(v.depend) do
if type(dependValue) ~= 'string' then
error('Invalid "depend" parameter value detected in preprocessArgs')
end
preprocessSingleArg(dependValue)
end
end
end
-- Get arguments with number suffixes.
local a = 1 -- Counter variable.
local moreArgumentsExist = true
while moreArgumentsExist == true do
moreArgumentsExist = false
for i = a, a + step - 1 do
for j,v in ipairs(prefixTable) do
local prefixArgName = v.prefix .. tostring(i)..(v.suffix or '')
if origArgs[prefixArgName] then
moreArgumentsExist = true -- Do another loop if any arguments are found, even blank ones.
preprocessSingleArg(prefixArgName)
end
-- Process the depend table if the prefix argument is present and not blank, or
-- we are processing "prefix1" and "prefix" is present and not blank, and
-- if the depend table is present.
if v.depend and (args[prefixArgName] or (i == 1 and args[v.prefix])) then
for j,dependValue in ipairs(v.depend) do
local dependArgName = dependValue .. tostring(i)
preprocessSingleArg(dependArgName)
end
end
end
end
a = a + step
end
end
function p.infobox(frame)
-- If called by Template:Infobox, set origArgs as parentArgs
-- Otherwise, assume directly called in other infoboxes
if frame:getParent():getTitle():gsub('/sandbox$', '') == "Template:Infobox" then
origArgs = frame:getParent().args
else
origArgs = frame.args
parentArgs = frame:getParent().args
end
-- Parse the data parameters in the same order that the old {{infobox}} did, so that
-- references etc. will display in the expected places. Parameters that depend on
-- another parameter are only processed if that parameter is present, to avoid
-- phantom references appearing in article reference lists.
preprocessSingleArg('columns')
preprocessSingleArg('child')
preprocessSingleArg('bodyclass')
preprocessSingleArg('subbox')
preprocessSingleArg('bodystyle')
preprocessSingleArg('title')
preprocessSingleArg('titleclass')
preprocessSingleArg('titlestyle')
preprocessSingleArg('above')
preprocessSingleArg('aboveclass')
preprocessSingleArg('abovestyle')
preprocessArgs({
{prefix = 'subheader', depend = {'subheaderstyle', 'subheaderrowclass'}}
}, 10)
preprocessSingleArg('subheaderstyle')
preprocessSingleArg('subheaderclass')
preprocessArgs({
{prefix = 'image', depend = {'caption', 'imagerowclass'}},
}, 10)
preprocessSingleArg('captionstyle')
preprocessSingleArg('imagestyle')
preprocessSingleArg('imageclass')
local rowArgs = {
{prefix = 'header'},
{prefix = 'headerif'},
{prefix = 'class'},
{prefix = 'labelid'},
{prefix = 'headerid'},
{prefix = 'rowid'},
{prefix = 'rowclass'},
{prefix = 'rowstyle'},
{prefix = 'rowcellstyle'}
}
args.columns = args.columns or 1
for i = 0, args.columns-2 do --TODO: need to process all label and dataa datab for each row at the same time in order from left to right for correct referencing. Make "suffix = true" do processing of dataa etc at the same time
suffix = string.sub("abcdefghijklmnopqrstuvwxyz",i, i)
table.insert(rowArgs, {prefix = 'data', suffix = suffix, depend = {'label'}})
table.insert(rowArgs, {prefix = 'data', suffix = suffix, 'id'})
preprocessSingleArg('data'..suffix..'style')
end
preprocessArgs(rowArgs, 50)
preprocessArgs({
{prefix = 'rowend'},
{prefix = 'rowclasslogic'},
{prefix = 'labellogic'},
{prefix = 'datalogic'}},
50)
preprocessSingleArg('headerclass')
preprocessSingleArg('headerstyle')
preprocessSingleArg('labelstyle')
preprocessSingleArg('below')
preprocessSingleArg('belowclass')
preprocessSingleArg('belowstyle')
preprocessSingleArg('name')
args['italic title'] = origArgs['italic title'] -- different behaviour if blank or absent
preprocessSingleArg('decat')
if parentArgs then processRows() end
return _infobox()
end
return p
