Ethan's Workspace

Module:Infobox: Difference between revisions

Module Discussion

Module:Infobox (view source)

Revision as of 21:08, 4 June 2021

2,961 bytes added ,  4 June 2021
no edit summary
m (1 revision imported)
No edit summary
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 function notempty( s ) return s and s:match( '%S' ) end
local category_in_empty_row_pattern = '%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*]]'


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>'
Line 39: Line 34:
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' .. subcells[k]
s = s .. '<tr' .. rowstyle ..'><' .. tt .. ' colspan=2>\n' ..
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' .. subcells[k] .. '</' .. tt .. '></tr>'
s = s .. '<tr><' .. tt .. ' colspan=2>\n' ..
subcells[k] .. '</' .. tt .. '></tr>'
end
end
end
end
Line 50: Line 47:
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
-- https://en.wikipedia.org/w/index.php?title=Template_talk:Infobox_musical_artist&oldid=849054481
-- [[Special:Diff/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 62: Line 59:
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
Line 78: Line 76:
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)
-- 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 = {}
local nums = {}
for k, v in pairs(args) do
for k, v in pairs(args) do
Line 91: Line 89:
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
-- or a label/data cell combination.
if rowArgs.header and rowArgs.header ~= '_BLANK_' then
if rowArgs.header and rowArgs.header ~= '_BLANK_' then
root
root
Line 99: Line 98:
:addClass(rowArgs.rowclass)
:addClass(rowArgs.rowclass)
:cssText(rowArgs.rowstyle)
:cssText(rowArgs.rowstyle)
:attr('id', rowArgs.rowid)
:tag('th')
:tag('th')
:attr('colspan', 2)
:attr('colspan', '2')
:attr('id', rowArgs.headerid)
:addClass('infobox-header')
:addClass(rowArgs.class)
:addClass(rowArgs.class)
:addClass(args.headerclass)
:addClass(args.headerclass)
:css('text-align', 'center')
-- @deprecated next; target .infobox-<name> .infobox-header
:cssText(args.headerstyle)
:cssText(args.headerstyle)
:cssText(rowArgs.rowcellstyle)
:cssText(rowArgs.rowcellstyle)
:wikitext(fixChildBoxes(rowArgs.header, 'th'))
:wikitext(fixChildBoxes(rowArgs.header, 'th'))
if rowArgs.data then
if rowArgs.data then
root:wikitext('[[Category:Pages which use infobox templates with ignored data cells]]')
root:wikitext(
end
'[[Category:Pages which use infobox templates with ignored data cells]]'
elseif rowArgs.data then
)
if not rowArgs.data:gsub('%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*]]', ''):match('^%S') then
rowArgs.rowstyle = 'display:none'
end
end
elseif rowArgs.data and rowArgs.data:gsub(
category_in_empty_row_pattern, ''
):match('^%S') then
local row = root:tag('tr')
local row = root:tag('tr')
row:addClass(rowArgs.rowclass)
row:addClass(rowArgs.rowclass)
row:cssText(rowArgs.rowstyle)
row:cssText(rowArgs.rowstyle)
row:attr('id', rowArgs.rowid)
if rowArgs.label then
if rowArgs.label then
row
row
:tag('th')
:tag('th')
:attr('scope', 'row')
:attr('scope', 'row')
:attr('id', rowArgs.labelid)
:addClass('infobox-label')
-- @deprecated next; target .infobox-<name> .infobox-label
:cssText(args.labelstyle)
:cssText(args.labelstyle)
:cssText(rowArgs.rowcellstyle)
:cssText(rowArgs.rowcellstyle)
Line 132: Line 131:


local dataCell = row:tag('td')
local dataCell = row:tag('td')
if not rowArgs.label then
dataCell
:attr('colspan', 2)
:css('text-align', 'center')
end
dataCell
dataCell
:attr('id', rowArgs.dataid)
:attr('colspan', not rowArgs.label and '2' or nil)
:addClass(not rowArgs.label and 'infobox-full-data' or 'infobox-data')
:addClass(rowArgs.class)
:addClass(rowArgs.class)
-- @deprecated next; target .infobox-<name> .infobox(-full)-data
:cssText(rowArgs.datastyle)
:cssText(rowArgs.datastyle)
:cssText(rowArgs.rowcellstyle)
:cssText(rowArgs.rowcellstyle)
:wikitext(fixChildBoxes(rowArgs.data, 'td'))
:wikitext(fixChildBoxes(rowArgs.data, 'td'))
else
table.insert(empty_row_categories, rowArgs.data or '')
end
end
end
end
Line 151: Line 149:
root
root
:tag('caption')
:tag('caption')
:addClass('infobox-title')
:addClass(args.titleclass)
:addClass(args.titleclass)
-- @deprecated next; target .infobox-<name> .infobox-title
:cssText(args.titlestyle)
:cssText(args.titlestyle)
:wikitext(args.title)
:wikitext(args.title)
Line 162: Line 162:
:tag('tr')
:tag('tr')
:tag('th')
:tag('th')
:attr('colspan', 2)
:attr('colspan', '2')
:addClass('infobox-above')
:addClass(args.aboveclass)
:addClass(args.aboveclass)
:css('text-align', 'center')
-- @deprecated next; target .infobox-<name> .infobox-above
:css('font-size', '125%')
:css('font-weight', 'bold')
:cssText(args.abovestyle)
:cssText(args.abovestyle)
:wikitext(fixChildBoxes(args.above,'th'))
:wikitext(fixChildBoxes(args.above,'th'))
Line 178: Line 177:
:tag('td')
:tag('td')
:attr('colspan', '2')
:attr('colspan', '2')
:addClass('infobox-below')
:addClass(args.belowclass)
:addClass(args.belowclass)
:css('text-align', 'center')
-- @deprecated next; target .infobox-<name> .infobox-below
:cssText(args.belowstyle)
:cssText(args.belowstyle)
:wikitext(fixChildBoxes(args.below,'td'))
: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
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


Line 193: Line 212:
local subheadernums = getArgNums('subheader')
local subheadernums = getArgNums('subheader')
for k, num in ipairs(subheadernums) do
for k, num in ipairs(subheadernums) do
addRow({
addSubheaderRow({
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)],
Line 200: Line 220:
rowclass = args['subheaderrowclass' .. tostring(num)]
rowclass = args['subheaderrowclass' .. tostring(num)]
})
})
end
end
local function addImageRow(imageArgs)
if imageArgs.data and
imageArgs.data:gsub(category_in_empty_row_pattern, ''):match('^%S') then
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
end
Line 217: Line 257:
data
data
:tag('div')
:tag('div')
:addClass('infobox-caption')
-- @deprecated next; target .infobox-<name> .infobox-caption
:cssText(args.captionstyle)
:cssText(args.captionstyle)
:wikitext(caption)
:wikitext(caption)
end
end
addRow({
addImageRow({
data = tostring(data),
data = tostring(data),
-- @deprecated next; target .infobox-<name> .infobox-image
datastyle = args.imagestyle,
datastyle = args.imagestyle,
class = args.imageclass,
class = args.imageclass,
Line 229: Line 272:
end
end


-- When autoheaders are turned on, preprocesses the rows
local function preprocessRows()
local function preprocessRows()
-- Gets the union of the header and data argument numbers,
if not args.autoheaders then return end
-- and renders them all in order using addRow.
local rownums = union(getArgNums('header'), getArgNums('data'))
local rownums = union(getArgNums('header'), getArgNums('data'))
table.sort(rownums)
table.sort(rownums)
Line 241: Line 285:
end
end
lastheader = num
lastheader = num
elseif args['data' .. tostring(num)] and args['data' .. tostring(num)]:gsub('%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*]]', ''):match('^%S') then
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)]
local data = args['data' .. tostring(num)]
if data:gsub('%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*]]', ''):match('%S') then
if data:gsub(category_in_empty_row_pattern, ''):match('%S') then
lastheader = nil
lastheader = nil
end
end
Line 253: Line 300:
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,
 
-- and renders them all in order using addRow.
local rownums = union(getArgNums('header'), getArgNums('data'))
local rownums = union(getArgNums('header'), getArgNums('data'))
table.sort(rownums)
table.sort(rownums)
Line 266: Line 314:
class = args['class' .. tostring(num)],
class = args['class' .. tostring(num)],
rowclass = args['rowclass' .. tostring(num)],
rowclass = args['rowclass' .. tostring(num)],
-- @deprecated next; target .infobox-<name> rowclass
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)],
labelid = args['labelid' .. tostring(num)],
headerid = args['headerid' .. tostring(num)],
rowid = args['rowid' .. tostring(num)]
})
})
end
end
Line 283: Line 328:
: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,
Line 297: Line 342:
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
-- Render tracking categories. args.decat == turns off tracking categories.
local function renderTrackingCategories()
local function renderTrackingCategories()
if args.decat ~= 'yes' then
if args.decat == 'yes' then return end
if args.child == 'yes' then
if args.child == 'yes' then
if args.title then
if args.title then
root:wikitext('[[Category:Pages which use embedded infobox templates with the title parameter]]')
root:wikitext(
end
'[[Category:Pages which use embedded infobox templates with the title parameter]]'
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
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
end


--[=[
Loads the templatestyles for the infobox.
TODO: load base templatestyles here rather than in MediaWiki:Common.css
We aren't doing it here yet because 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 = cfg.i18n.templatestyles }
-- }
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
-- 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()
-- 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
if args.child ~= 'yes' then
root = mw.html.create('table')
root = mw.html.create('table')


root
root
:addClass((args.subbox ~= 'yes') and 'infobox' or nil)
:addClass(args.subbox == 'yes' and 'infobox-subbox' or 'infobox')
:addClass(args.bodyclass)
:addClass(args.bodyclass)
 
-- @deprecated next; target .infobox-<name>
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)
:cssText(args.bodystyle)


Line 348: Line 434:
renderSubheaders()
renderSubheaders()
renderImages()
renderImages()
if args.autoheaders then
preprocessRows()
preprocessRows()
end
renderRows()
renderRows()
renderBelowRow()
renderBelowRow()
renderNavBar()
renderNavBar()
renderItalicTitle()
renderItalicTitle()
renderEmptyRowCategories()
renderTrackingCategories()
renderTrackingCategories()


return tostring(root)
return loadTemplateStyles() .. tostring(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 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
if origArgs[argName] and origArgs[argName] ~= '' then
args[argName] = origArgs[argName]
args[argName] = origArgs[argName]
Line 368: Line 453:
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)
-- 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
if type(prefixTable) ~= 'table' then
error("Non-table value detected for the prefix table", 2)
error("Non-table value detected for the prefix table", 2)
Line 384: Line 470:
-- Get arguments without a number suffix, and check for bad input.
-- Get arguments without a number suffix, and check for bad input.
for i,v in ipairs(prefixTable) do
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
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)
error('Invalid input detected to preprocessArgs prefix table', 2)
end
end
preprocessSingleArg(v.prefix)
preprocessSingleArg(v.prefix)
-- Only parse the depend parameter if the prefix parameter is present and not blank.
-- Only parse the depend parameter if the prefix parameter is present
-- and not blank.
if args[v.prefix] and v.depend then
if args[v.prefix] and v.depend then
for j, dependValue in ipairs(v.depend) do
for j, dependValue in ipairs(v.depend) do
Line 408: Line 496:
local prefixArgName = v.prefix .. tostring(i)
local prefixArgName = v.prefix .. tostring(i)
if origArgs[prefixArgName] then
if origArgs[prefixArgName] then
moreArgumentsExist = true -- Do another loop if any arguments are found, even blank ones.
-- 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
Line 426: Line 515:
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()
local function parseDataParameters()
-- 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('autoheaders')
preprocessSingleArg('autoheaders')
preprocessSingleArg('child')
preprocessSingleArg('child')
Line 459: Line 549:
{prefix = 'rowstyle'},
{prefix = 'rowstyle'},
{prefix = 'rowcellstyle'},
{prefix = 'rowcellstyle'},
{prefix = 'class'},
{prefix = 'class'}
{prefix = 'dataid'},
{prefix = 'labelid'},
{prefix = 'headerid'},
{prefix = 'rowid'}
}, 50)
}, 50)
preprocessSingleArg('headerclass')
preprocessSingleArg('headerclass')
Line 473: Line 559:
preprocessSingleArg('belowstyle')
preprocessSingleArg('belowstyle')
preprocessSingleArg('name')
preprocessSingleArg('name')
args['italic title'] = origArgs['italic title'] -- different behaviour if blank or absent
-- different behaviour for italics if blank or absent
args['italic title'] = origArgs['italic title']
preprocessSingleArg('decat')
preprocessSingleArg('decat')
preprocessSingleArg('templatestyles')
preprocessSingleArg('child templatestyles')
preprocessSingleArg('grandchild templatestyles')
end
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 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
if frame == mw.getCurrentFrame() then
origArgs = frame:getParent().args
origArgs = frame:getParent().args
Line 491: Line 581:
end
end


-- For calling via #invoke within a template
function p.infoboxTemplate(frame)
function p.infoboxTemplate(frame)
-- For calling via #invoke within a template
origArgs = {}
origArgs = {}
for k,v in pairs(frame.args) do origArgs[k] = mw.text.trim(v) end
for k,v in pairs(frame.args) do origArgs[k] = mw.text.trim(v) end
Retrieved from "http://ethans-workspace.com/wiki/Special:MobileDiff/1146"