Module:Infobox: Difference between revisions

Jump to navigation Jump to search
m (spacing)
m (1 revision imported)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
--
-- This module implements {{Infobox}}
--
local p = {}
local p = {}
local navbar = require('Module:Navbar')._navbar
local args = {}
local args = {}
local origArgs = {}
local origArgs
local root
local root
local empty_row_categories = {}
 
local category_in_empty_row_pattern = '%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*]]'
local function notempty( s ) return s and s:match( '%S' ) end
local has_rows = false


local function fixChildBoxes(sval, tt)
local function fixChildBoxes(sval, tt)
local function notempty( s ) return s and s:match( '%S' ) end
if notempty(sval) then
if notempty(sval) then
local marker = '<span class=special_infobox_marker>'
local marker = '<span class=special_infobox_marker>'
local s = sval
local s = sval
-- start moving templatestyles and categories inside of table rows
local slast = ''
while slast ~= s do
slast = s
s = mw.ustring.gsub(s, '(</[Tt][Rr]%s*>%s*)(%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*%]%])', '%2%1')
s = mw.ustring.gsub(s, '(</[Tt][Rr]%s*>%s*)(\127[^\127]*UNIQ%-%-templatestyles%-%x+%-QINU[^\127]*\127)', '%2%1')
end
-- end moving templatestyles and categories inside of table rows
s = mw.ustring.gsub(s, '(<%s*[Tt][Rr])', marker .. '%1')
s = mw.ustring.gsub(s, '(<%s*[Tt][Rr])', marker .. '%1')
s = mw.ustring.gsub(s, '(</[Tt][Rr]%s*>)', '%1' .. marker)
s = mw.ustring.gsub(s, '(</[Tt][Rr]%s*>)', '%1' .. marker)
Line 31: Line 27:
s = mw.ustring.gsub(s, '^(%{|[^\r\n]*[\r\n]%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, '([\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*</[Tt][Aa][Bb][Ll][Ee]%s*>)', '%1')
s = mw.ustring.gsub(s, marker .. '(%s*\n|%})', '%1')
s = mw.ustring.gsub(s, marker .. '(%s*\n|%})', '%1')
end
end
if s:match(marker) then
if s:match(marker) then
Line 43: Line 39:
local rowstyle = ' style="display:none"'
local rowstyle = ' style="display:none"'
if notempty(subcells[k]) then rowstyle = '' end
if notempty(subcells[k]) then rowstyle = '' end
s = s .. '<tr' .. rowstyle ..'><' .. tt .. ' colspan=2>\n' ..
s = s .. '<tr' .. rowstyle ..'><' .. tt .. ' colspan=2>\n' .. subcells[k]
subcells[k]
elseif notempty(subcells[k]) then
elseif notempty(subcells[k]) then
if (k % 2) == 0 then
if (k % 2) == 0 then
s = s .. subcells[k]
s = s .. subcells[k]
else
else
s = s .. '<tr><' .. tt .. ' colspan=2>\n' ..
s = s .. '<tr><' .. tt .. ' colspan=2>\n' .. subcells[k] .. '</' .. tt .. '></tr>'
subcells[k] .. '</' .. tt .. '></tr>'
end
end
end
end
Line 56: Line 50:
end
end
-- the next two lines add a newline at the end of lists for the PHP parser
-- the next two lines add a newline at the end of lists for the PHP parser
-- [[Special:Diff/849054481]]
-- https://en.wikipedia.org/w/index.php?title=Template_talk:Infobox_musical_artist&oldid=849054481
-- remove when [[:phab:T191516]] is fixed or OBE
-- 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][%*#;:][^\r\n]*)$', '%1\n')
Line 68: Line 62:
end
end


-- Cleans empty tables
local function cleanInfobox()
root = tostring(root)
if has_rows == false then
root = mw.ustring.gsub(root, '<table[^<>]*>%s*</table>', '')
end
end
-- Returns the union of the values of two tables, as a sequence.
local function union(t1, t2)
local function union(t1, t2)
 
    -- Returns the union of the values of two tables, as a sequence.
local vals = {}
    local vals = {}
for k, v in pairs(t1) do
    for k, v in pairs(t1) do
vals[v] = true
        vals[v] = true
end
    end
for k, v in pairs(t2) do
    for k, v in pairs(t2) do
vals[v] = true
        vals[v] = true
end
    end
local ret = {}
    local ret = {}
for k, v in pairs(vals) do
    for k, v in pairs(vals) do
table.insert(ret, k)
        table.insert(ret, k)
end
    end
return ret
    return ret
end
end


-- 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}.
local function getArgNums(prefix)
local function getArgNums(prefix)
local nums = {}
    -- Returns a table containing the numbers of the arguments that exist
for k, v in pairs(args) do
    -- for the specified prefix. For example, if the prefix was 'data', and
local num = tostring(k):match('^' .. prefix .. '([1-9]%d*)$')
    -- 'data1', 'data2', and 'data5' exist, it would return {1, 2, 5}.
if num then table.insert(nums, tonumber(num)) end
    local nums = {}
end
    for k, v in pairs(args) do
table.sort(nums)
        local num = tostring(k):match('^' .. prefix .. '([1-9]%d*)$')
return nums
        if num then table.insert(nums, tonumber(num)) end
    end
    table.sort(nums)
    return nums
end
end


-- Adds a row to the infobox, with either a header cell
-- or a label/data cell combination.
local function addRow(rowArgs)
local function addRow(rowArgs)
    -- Adds a row to the infobox, with either a header cell
if rowArgs.header and rowArgs.header ~= '_BLANK_' then
    -- or a label/data cell combination.
has_rows = true
    if rowArgs.header then
root
        root
:tag('tr')
            :tag('tr')
:addClass(rowArgs.rowclass)
                :addClass(rowArgs.rowclass)
:cssText(rowArgs.rowstyle)
                :cssText(rowArgs.rowstyle)
:tag('th')
                :attr('id', rowArgs.rowid)
:attr('colspan', '2')
                :tag('th')
:addClass('infobox-header')
                    :attr('colspan', 2)
:addClass(rowArgs.class)
                    :attr('id', rowArgs.headerid)
:addClass(args.headerclass)
                    :addClass(rowArgs.class)
-- @deprecated next; target .infobox-<name> .infobox-header
                    :addClass(args.headerclass)
:cssText(args.headerstyle)
                    :css('text-align', 'center')
:cssText(rowArgs.rowcellstyle)
                    :cssText(args.headerstyle)
:wikitext(fixChildBoxes(rowArgs.header, 'th'))
                    :cssText(rowArgs.rowcellstyle)
if rowArgs.data then
                    :wikitext(fixChildBoxes(rowArgs.header, 'th'))
root:wikitext(
    elseif rowArgs.data then
'[[Category:Pages using infobox templates with ignored data cells]]'
        local row = root:tag('tr')
)
        row:addClass(rowArgs.rowclass)
end
        row:cssText(rowArgs.rowstyle)
elseif rowArgs.data and rowArgs.data:gsub(
        row:attr('id', rowArgs.rowid)
category_in_empty_row_pattern, ''
        if rowArgs.label then
):match('^%S') then
            row
has_rows = true
                :tag('th')
local row = root:tag('tr')
                    :attr('scope', 'row')
row:addClass(rowArgs.rowclass)
                    :attr('id', rowArgs.labelid)
row:cssText(rowArgs.rowstyle)
                    :cssText(args.labelstyle)
if rowArgs.label then
                    :cssText(rowArgs.rowcellstyle)
row
                    :wikitext(rowArgs.label)
:tag('th')
                    :done()
:attr('scope', 'row')
        end
:addClass('infobox-label')
       
-- @deprecated next; target .infobox-<name> .infobox-label
        local dataCell = row:tag('td')
:cssText(args.labelstyle)
        if not rowArgs.label then
:cssText(rowArgs.rowcellstyle)
            dataCell
:wikitext(rowArgs.label)
                :attr('colspan', 2)
:done()
                :css('text-align', 'center')  
end
        end
 
        dataCell
local dataCell = row:tag('td')
            :attr('id', rowArgs.dataid)
dataCell
            :addClass(rowArgs.class)
:attr('colspan', not rowArgs.label and '2' or nil)
            :cssText(rowArgs.datastyle)
:addClass(not rowArgs.label and 'infobox-full-data' or 'infobox-data')
            :cssText(rowArgs.rowcellstyle)
:addClass(rowArgs.class)
            :wikitext(fixChildBoxes(rowArgs.data, 'td'))
-- @deprecated next; target .infobox-<name> .infobox(-full)-data
    end
:cssText(rowArgs.datastyle)
:cssText(rowArgs.rowcellstyle)
:wikitext(fixChildBoxes(rowArgs.data, 'td'))
else
table.insert(empty_row_categories, rowArgs.data or '')
end
end
end


local function renderTitle()
local function renderTitle()
if not args.title then return end
    if not args.title then return end


has_rows = true
    root
root
        :tag('caption')
:tag('caption')
            :addClass(args.titleclass)
:addClass('infobox-title')
            :cssText(args.titlestyle)
:addClass(args.titleclass)
            :wikitext(args.title)
-- @deprecated next; target .infobox-<name> .infobox-title
:cssText(args.titlestyle)
:wikitext(args.title)
end
end


local function renderAboveRow()
local function renderAboveRow()
if not args.above then return end
    if not args.above then return end
 
   
has_rows = true
    root
root
        :tag('tr')
:tag('tr')
            :tag('th')
:tag('th')
                :attr('colspan', 2)
:attr('colspan', '2')
                :addClass(args.aboveclass)
:addClass('infobox-above')
                :css('text-align', 'center')
:addClass(args.aboveclass)
                :css('font-size', '125%')
-- @deprecated next; target .infobox-<name> .infobox-above
                :css('font-weight', 'bold')
:cssText(args.abovestyle)
                :cssText(args.abovestyle)
:wikitext(fixChildBoxes(args.above,'th'))
                :wikitext(fixChildBoxes(args.above,'th'))
end
end


local function renderBelowRow()
local function renderBelowRow()
if not args.below then return end
    if not args.below then return end
 
   
has_rows = true
    root
root
        :tag('tr')
:tag('tr')
            :tag('td')
:tag('td')
                :attr('colspan', '2')
:attr('colspan', '2')
                :addClass(args.belowclass)
:addClass('infobox-below')
                :css('text-align', 'center')
:addClass(args.belowclass)
                :cssText(args.belowstyle)
-- @deprecated next; target .infobox-<name> .infobox-below
                :wikitext(fixChildBoxes(args.below,'td'))
:cssText(args.belowstyle)
:wikitext(fixChildBoxes(args.below,'td'))
end
 
local function addSubheaderRow(subheaderArgs)
if subheaderArgs.data and
subheaderArgs.data:gsub(category_in_empty_row_pattern, ''):match('^%S') then
has_rows = true
local row = root:tag('tr')
row:addClass(subheaderArgs.rowclass)
 
local dataCell = row:tag('td')
dataCell
:attr('colspan', '2')
:addClass('infobox-subheader')
:addClass(subheaderArgs.class)
:cssText(subheaderArgs.datastyle)
:cssText(subheaderArgs.rowcellstyle)
:wikitext(fixChildBoxes(subheaderArgs.data, 'td'))
else
table.insert(empty_row_categories, subheaderArgs.data or '')
end
end
end


local function renderSubheaders()
local function renderSubheaders()
if args.subheader then
    if args.subheader then
args.subheader1 = args.subheader
        args.subheader1 = args.subheader
end
    end
if args.subheaderrowclass then
    if args.subheaderrowclass then
args.subheaderrowclass1 = args.subheaderrowclass
        args.subheaderrowclass1 = args.subheaderrowclass
end
    end
local subheadernums = getArgNums('subheader')
    local subheadernums = getArgNums('subheader')
for k, num in ipairs(subheadernums) do
    for k, num in ipairs(subheadernums) do
addSubheaderRow({
        addRow({
data = args['subheader' .. tostring(num)],
            data = args['subheader' .. tostring(num)],
-- @deprecated next; target .infobox-<name> .infobox-subheader
            datastyle = args.subheaderstyle,
datastyle = args.subheaderstyle,
            rowcellstyle = args['subheaderstyle' .. tostring(num)],
rowcellstyle = args['subheaderstyle' .. tostring(num)],
            class = args.subheaderclass,
class = args.subheaderclass,
            rowclass = args['subheaderrowclass' .. tostring(num)]
rowclass = args['subheaderrowclass' .. tostring(num)]
        })
})
    end
end
end
 
local function addImageRow(imageArgs)
 
if imageArgs.data and
imageArgs.data:gsub(category_in_empty_row_pattern, ''):match('^%S') then
 
has_rows = true
local row = root:tag('tr')
row:addClass(imageArgs.rowclass)
 
local dataCell = row:tag('td')
dataCell
:attr('colspan', '2')
:addClass('infobox-image')
:addClass(imageArgs.class)
:cssText(imageArgs.datastyle)
:wikitext(fixChildBoxes(imageArgs.data, 'td'))
else
table.insert(empty_row_categories, imageArgs.data or '')
end
end
end


local function renderImages()
local function renderImages()
if args.image then
    if args.image then
args.image1 = args.image
        args.image1 = args.image
end
    end
if args.caption then
    if args.caption then
args.caption1 = args.caption
        args.caption1 = args.caption
end
    end
local imagenums = getArgNums('image')
    local imagenums = getArgNums('image')
for k, num in ipairs(imagenums) do
    for k, num in ipairs(imagenums) do
local caption = args['caption' .. tostring(num)]
        local caption = args['caption' .. tostring(num)]
local data = mw.html.create():wikitext(args['image' .. tostring(num)])
        local data = mw.html.create():wikitext(args['image' .. tostring(num)])
if caption then
        if caption then
data
            data
:tag('div')
                :tag('div')
:addClass('infobox-caption')
                    :cssText(args.captionstyle)
-- @deprecated next; target .infobox-<name> .infobox-caption
                    :wikitext(caption)
:cssText(args.captionstyle)
        end
:wikitext(caption)
        addRow({
end
            data = tostring(data),
addImageRow({
            datastyle = args.imagestyle,
data = tostring(data),
            class = args.imageclass,
-- @deprecated next; target .infobox-<name> .infobox-image
            rowclass = args['imagerowclass' .. tostring(num)]
datastyle = args.imagestyle,
        })
class = args.imageclass,
    end
rowclass = args['imagerowclass' .. tostring(num)]
})
end
end
end


-- When autoheaders are turned on, preprocesses the rows
local function preprocessRows()
if not args.autoheaders then return end
local rownums = union(getArgNums('header'), getArgNums('data'))
table.sort(rownums)
local lastheader
for k, num in ipairs(rownums) do
if args['header' .. tostring(num)] then
if lastheader then
args['header' .. tostring(lastheader)] = nil
end
lastheader = num
elseif args['data' .. tostring(num)] and
args['data' .. tostring(num)]:gsub(
category_in_empty_row_pattern, ''
):match('^%S') then
local data = args['data' .. tostring(num)]
if data:gsub(category_in_empty_row_pattern, ''):match('%S') then
lastheader = nil
end
end
end
if lastheader then
args['header' .. tostring(lastheader)] = nil
end
end
-- Gets the union of the header and data argument numbers,
-- and renders them all in order
local function renderRows()
local function renderRows()
 
    -- Gets the union of the header and data argument numbers,
local rownums = union(getArgNums('header'), getArgNums('data'))
    -- and renders them all in order using addRow.
table.sort(rownums)
    local rownums = union(getArgNums('header'), getArgNums('data'))
for k, num in ipairs(rownums) do
    table.sort(rownums)
addRow({
    for k, num in ipairs(rownums) do
header = args['header' .. tostring(num)],
        addRow({
label = args['label' .. tostring(num)],
            header = args['header' .. tostring(num)],
data = args['data' .. tostring(num)],
            label = args['label' .. tostring(num)],
datastyle = args.datastyle,
            data = args['data' .. tostring(num)],
class = args['class' .. tostring(num)],
            datastyle = args.datastyle,
rowclass = args['rowclass' .. tostring(num)],
            class = args['class' .. tostring(num)],
-- @deprecated next; target .infobox-<name> rowclass
            rowclass = args['rowclass' .. tostring(num)],
rowstyle = args['rowstyle' .. tostring(num)],
            rowstyle = args['rowstyle' .. tostring(num)],
rowcellstyle = args['rowcellstyle' .. tostring(num)]
            rowcellstyle = args['rowcellstyle' .. tostring(num)],
})
            dataid = args['dataid' .. tostring(num)],
end
            labelid = args['labelid' .. tostring(num)],
            headerid = args['headerid' .. tostring(num)],
            rowid = args['rowid' .. tostring(num)]
        })
    end
end
end


local function renderNavBar()
local function renderNavBar()
if not args.name then return end
    if not args.name then return end
 
   
has_rows = true
    root
root
        :tag('tr')
:tag('tr')
            :tag('td')
:tag('td')
                :attr('colspan', '2')
:attr('colspan', '2')
                :css('text-align', 'right')
:addClass('infobox-navbar')
                :wikitext(navbar{
:wikitext(require('Module:Navbar')._navbar{
                    args.name,
args.name,
                    mini = 1,
mini = 1,
                })
})
end
end


local function renderItalicTitle()
local function renderItalicTitle()
local italicTitle = args['italic title'] and mw.ustring.lower(args['italic title'])
    local italicTitle = args['italic title'] and mw.ustring.lower(args['italic title'])
if italicTitle == '' or italicTitle == 'force' or italicTitle == 'yes' then
    if italicTitle == '' or italicTitle == 'force' or italicTitle == 'yes' then
root:wikitext(mw.getCurrentFrame():expandTemplate({title = 'italic title'}))
        root:wikitext(mw.getCurrentFrame():expandTemplate({title = 'italic title'}))
end
    end
end
 
-- Categories in otherwise empty rows are collected in empty_row_categories.
-- This function adds them to the module output. It is not affected by
-- args.decat because this module should not prevent module-external categories
-- from rendering.
local function renderEmptyRowCategories()
for _, s in ipairs(empty_row_categories) do
root:wikitext(s)
end
end
end


-- Render tracking categories. args.decat == turns off tracking categories.
local function renderTrackingCategories()
local function renderTrackingCategories()
if args.decat == 'yes' then return end
    if args.decat ~= 'yes' then
if args.child == 'yes' then
    if args.child == 'yes' then
if args.title then
        if args.title then
root:wikitext(
            root:wikitext('[[Category:Pages which use embedded infobox templates with the title parameter]]')
'[[Category:Pages using embedded infobox templates with the title parameter]]'
        end
)
        elseif #(getArgNums('data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then
end
            root:wikitext('[[Category:Articles which use infobox templates with no data rows]]')
elseif #(getArgNums('data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then
        end
root:wikitext('[[Category:Articles using infobox templates with no data rows]]')
    end
end
end
end


--[=[
Loads the templatestyles for the infobox.
TODO: FINISH loading base templatestyles here rather than in
MediaWiki:Common.css. There are 4-5000 pages with 'raw' infobox tables.
See [[Mediawiki_talk:Common.css/to_do#Infobox]] and/or come help :).
When we do this we should clean up the inline CSS below too.
Will have to do some bizarre conversion category like with sidebar.
]=]
local function loadTemplateStyles()
local frame = mw.getCurrentFrame()
-- See function description
local base_templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = 'Module:Infobox/styles.css' }
}
local templatestyles = ''
if args['templatestyles'] then templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = args['templatestyles'] }
}
end
local child_templatestyles = ''
if args['child templatestyles'] then child_templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = args['child templatestyles'] }
}
end
local grandchild_templatestyles = ''
if args['grandchild templatestyles'] then grandchild_templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = args['grandchild templatestyles'] }
}
end
return table.concat({
base_templatestyles, -- see function description
templatestyles,
child_templatestyles,
grandchild_templatestyles
})
end
-- common functions between the child and non child cases
local function structure_infobox_common()
renderSubheaders()
renderImages()
preprocessRows()
renderRows()
renderBelowRow()
renderNavBar()
renderItalicTitle()
renderEmptyRowCategories()
renderTrackingCategories()
cleanInfobox()
end
-- Specify the overall layout of the infobox, with special settings if the
-- infobox is used as a 'child' inside another infobox.
local function _infobox()
local function _infobox()
if args.child ~= 'yes' then
    -- Specify the overall layout of the infobox, with special settings
root = mw.html.create('table')
    -- 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


root
    renderSubheaders()
:addClass(args.subbox == 'yes' and 'infobox-subbox' or 'infobox')
    renderImages()  
:addClass(args.bodyclass)
    renderRows()  
-- @deprecated next; target .infobox-<name>
    renderBelowRow()
:cssText(args.bodystyle)
    renderNavBar()
 
    renderItalicTitle()
renderTitle()
    renderTrackingCategories()
renderAboveRow()
   
else
    return tostring(root)
root = mw.html.create()
 
root
:wikitext(args.title)
end
structure_infobox_common()
return loadTemplateStyles() .. root
end
end


-- 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.
local function preprocessSingleArg(argName)
local function preprocessSingleArg(argName)
if origArgs[argName] and origArgs[argName] ~= '' then
    -- If the argument exists and isn't blank, add it to the argument table.
args[argName] = origArgs[argName]
    -- Blank arguments are treated as nil to match the behaviour of ParserFunctions.
end
    if origArgs[argName] and origArgs[argName] ~= '' then
        args[argName] = origArgs[argName]
    end
end
end


-- 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.
local function preprocessArgs(prefixTable, step)
local function preprocessArgs(prefixTable, step)
if type(prefixTable) ~= 'table' then
    -- Assign the parameters with the given prefixes to the args table, in order, in batches
error("Non-table value detected for the prefix table", 2)
    -- of the step size specified. This is to prevent references etc. from appearing in the
end
    -- wrong order. The prefixTable should be an array containing tables, each of which has
if type(step) ~= 'number' then
    -- two possible fields, a "prefix" string and a "depend" table. The function always parses
error("Invalid step value detected", 2)
    -- parameters containing the "prefix" string, but only parses parameters in the "depend"
end
    -- table if the prefix parameter is present and non-blank.
 
    if type(prefixTable) ~= 'table' then
-- Get arguments without a number suffix, and check for bad input.
        error("Non-table value detected for the prefix table", 2)
for i,v in ipairs(prefixTable) do
    end
if type(v) ~= 'table' or type(v.prefix) ~= "string" or
    if type(step) ~= 'number' then
(v.depend and type(v.depend) ~= 'table') then
        error("Invalid step value detected", 2)
error('Invalid input detected to preprocessArgs prefix table', 2)
    end
end
   
preprocessSingleArg(v.prefix)
    -- Get arguments without a number suffix, and check for bad input.
-- Only parse the depend parameter if the prefix parameter is present
    for i,v in ipairs(prefixTable) do
-- and not blank.
        if type(v) ~= 'table' or type(v.prefix) ~= "string" or (v.depend and type(v.depend) ~= 'table') then
if args[v.prefix] and v.depend then
            error('Invalid input detected to preprocessArgs prefix table', 2)
for j, dependValue in ipairs(v.depend) do
        end
if type(dependValue) ~= 'string' then
        preprocessSingleArg(v.prefix)
error('Invalid "depend" parameter value detected in preprocessArgs')
        -- Only parse the depend parameter if the prefix parameter is present and not blank.
end
        if args[v.prefix] and v.depend then
preprocessSingleArg(dependValue)
            for j, dependValue in ipairs(v.depend) do
end
                if type(dependValue) ~= 'string' then
end
                    error('Invalid "depend" parameter value detected in preprocessArgs')
end
                end
                preprocessSingleArg(dependValue)
            end
        end
    end


-- Get arguments with number suffixes.
    -- Get arguments with number suffixes.
local a = 1 -- Counter variable.
    local a = 1 -- Counter variable.
local moreArgumentsExist = true
    local moreArgumentsExist = true
while moreArgumentsExist == true do
    while moreArgumentsExist == true do
moreArgumentsExist = false
        moreArgumentsExist = false
for i = a, a + step - 1 do
        for i = a, a + step - 1 do
for j,v in ipairs(prefixTable) do
            for j,v in ipairs(prefixTable) do
local prefixArgName = v.prefix .. tostring(i)
                local prefixArgName = v.prefix .. tostring(i)
if origArgs[prefixArgName] then
                if origArgs[prefixArgName] then
-- Do another loop if any arguments are found, even blank ones.
                    moreArgumentsExist = true -- Do another loop if any arguments are found, even blank ones.
moreArgumentsExist = true
                    preprocessSingleArg(prefixArgName)
preprocessSingleArg(prefixArgName)
                end
end
                -- Process the depend table if the prefix argument is present and not blank, or
-- Process the depend table if the prefix argument is present
                -- we are processing "prefix1" and "prefix" is present and not blank, and
-- and not blank, or we are processing "prefix1" and "prefix" is
                -- if the depend table is present.
-- 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
if v.depend and (args[prefixArgName] or (i == 1 and args[v.prefix])) then
                    for j,dependValue in ipairs(v.depend) do
for j,dependValue in ipairs(v.depend) do
                        local dependArgName = dependValue .. tostring(i)
local dependArgName = dependValue .. tostring(i)
                        preprocessSingleArg(dependArgName)
preprocessSingleArg(dependArgName)
                    end
end
                end
end
            end
end
        end
end
        a = a + step
a = a + step
    end
end
end
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.
local function parseDataParameters()
 
preprocessSingleArg('autoheaders')
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')
preprocessArgs({
{prefix = 'header'},
{prefix = 'data', depend = {'label'}},
{prefix = 'rowclass'},
{prefix = 'rowstyle'},
{prefix = 'rowcellstyle'},
{prefix = 'class'}
}, 50)
preprocessSingleArg('headerclass')
preprocessSingleArg('headerstyle')
preprocessSingleArg('labelstyle')
preprocessSingleArg('datastyle')
preprocessSingleArg('below')
preprocessSingleArg('belowclass')
preprocessSingleArg('belowstyle')
preprocessSingleArg('name')
-- different behaviour for italics if blank or absent
args['italic title'] = origArgs['italic title']
preprocessSingleArg('decat')
preprocessSingleArg('templatestyles')
preprocessSingleArg('child templatestyles')
preprocessSingleArg('grandchild templatestyles')
end
 
-- If called via #invoke, use the args passed into the invoking template.
-- Otherwise, for testing purposes, assume args are being passed directly in.
function p.infobox(frame)
function p.infobox(frame)
if frame == mw.getCurrentFrame() then
    -- If called via #invoke, use the args passed into the invoking template.
origArgs = frame:getParent().args
    -- Otherwise, for testing purposes, assume args are being passed directly in.
else
    if frame == mw.getCurrentFrame() then
origArgs = frame
        origArgs = frame:getParent().args
end
    else
        origArgs = frame
parseDataParameters()
    end
   
return _infobox()
    -- Parse the data parameters in the same order that the old {{infobox}} did, so that
end
    -- references etc. will display in the expected places. Parameters that depend on
 
    -- another parameter are only processed if that parameter is present, to avoid
-- For calling via #invoke within a template
    -- phantom references appearing in article reference lists.
function p.infoboxTemplate(frame)
    preprocessSingleArg('child')
origArgs = {}
    preprocessSingleArg('bodyclass')
for k,v in pairs(frame.args) do origArgs[k] = mw.text.trim(v) end
    preprocessSingleArg('subbox')
    preprocessSingleArg('bodystyle')
parseDataParameters()
    preprocessSingleArg('title')
    preprocessSingleArg('titleclass')
return _infobox()
    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')
    preprocessArgs({
        {prefix = 'header'},
        {prefix = 'data', depend = {'label'}},
        {prefix = 'rowclass'},
        {prefix = 'rowstyle'},
        {prefix = 'rowcellstyle'},
        {prefix = 'class'},
        {prefix = 'dataid'},
        {prefix = 'labelid'},
        {prefix = 'headerid'},
        {prefix = 'rowid'}
    }, 50)
    preprocessSingleArg('headerclass')
    preprocessSingleArg('headerstyle')
    preprocessSingleArg('labelstyle')
    preprocessSingleArg('datastyle')
    preprocessSingleArg('below')
    preprocessSingleArg('belowclass')
    preprocessSingleArg('belowstyle')
    preprocessSingleArg('name')
    args['italic title'] = origArgs['italic title'] -- different behaviour if blank or absent
    preprocessSingleArg('decat')
    return _infobox()
end
end
return p
return p

Latest revision as of 09:28, 25 May 2022

Documentation for this module may be created at Module:Infobox/doc

--
-- This module implements {{Infobox}}
--

local p = {}

local navbar = require('Module:Navbar')._navbar

local args = {}
local origArgs
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')
		s = mw.ustring.gsub(s, '^([%*#;:])', '\n%1')
		s = mw.ustring.gsub(s, '^(%{%|)', '\n%1')
		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)
    -- 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}.
    local nums = {}
    for k, v in pairs(args) do
        local num = tostring(k):match('^' .. prefix .. '([1-9]%d*)$')
        if num then table.insert(nums, tonumber(num)) end
    end
    table.sort(nums)
    return nums
end

local function addRow(rowArgs)
    -- 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', 2)
                    :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
        
        local dataCell = row:tag('td')
        if not rowArgs.label then 
            dataCell
                :attr('colspan', 2)
                :css('text-align', 'center') 
        end
        dataCell
            :attr('id', rowArgs.dataid)
            :addClass(rowArgs.class)
            :cssText(rowArgs.datastyle)
            :cssText(rowArgs.rowcellstyle)
            :wikitext(fixChildBoxes(rowArgs.data, 'td'))
    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)
                :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
        addRow({
            data = args['subheader' .. tostring(num)],
            datastyle = args.subheaderstyle,
            rowcellstyle = args['subheaderstyle' .. tostring(num)],
            class = args.subheaderclass,
            rowclass = args['subheaderrowclass' .. tostring(num)]
        })
    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 caption = args['caption' .. tostring(num)]
        local data = mw.html.create():wikitext(args['image' .. tostring(num)])
        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' .. tostring(num)]
        })
    end
end

local function renderRows()
    -- Gets the union of the header and data argument numbers,
    -- and renders them all in order using addRow.
    local rownums = union(getArgNums('header'), getArgNums('data'))
    table.sort(rownums)
    for k, num in ipairs(rownums) do
        addRow({
            header = args['header' .. tostring(num)],
            label = args['label' .. tostring(num)],
            data = args['data' .. tostring(num)],
            datastyle = args.datastyle,
            class = args['class' .. tostring(num)],
            rowclass = args['rowclass' .. tostring(num)],
            rowstyle = args['rowstyle' .. tostring(num)],
            rowcellstyle = args['rowcellstyle' .. tostring(num)],
            dataid = args['dataid' .. tostring(num)],
            labelid = args['labelid' .. tostring(num)],
            headerid = args['headerid' .. tostring(num)],
            rowid = args['rowid' .. tostring(num)]
        })
    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
    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)
    -- 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)
                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 via #invoke, use the args passed into the invoking template.
    -- Otherwise, for testing purposes, assume args are being passed directly in.
    if frame == mw.getCurrentFrame() then
        origArgs = frame:getParent().args
    else
        origArgs = frame
    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('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')
    preprocessArgs({
        {prefix = 'header'},
        {prefix = 'data', depend = {'label'}},
        {prefix = 'rowclass'},
        {prefix = 'rowstyle'},
        {prefix = 'rowcellstyle'},
        {prefix = 'class'},
        {prefix = 'dataid'},
        {prefix = 'labelid'},
        {prefix = 'headerid'},
        {prefix = 'rowid'}
    }, 50)
    preprocessSingleArg('headerclass')
    preprocessSingleArg('headerstyle')
    preprocessSingleArg('labelstyle')
    preprocessSingleArg('datastyle')
    preprocessSingleArg('below')
    preprocessSingleArg('belowclass')
    preprocessSingleArg('belowstyle')
    preprocessSingleArg('name')
    args['italic title'] = origArgs['italic title'] -- different behaviour if blank or absent
    preprocessSingleArg('decat')
 
    return _infobox()
end
 
return p