Editing Module:Infobox
Appearance
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
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 function | local function notempty( s ) return s and s:match( '%S' ) end | ||
end | |||
local function fixChildBoxes(sval, tt) | local function fixChildBoxes(sval, tt) | ||
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 | ||
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 81: | 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] | ||
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>' | ||
end | end | ||
end | end | ||
Line 94: | 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 | ||
-- | -- 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 106: | Line 62: | ||
end | end | ||
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 131: | Line 78: | ||
end | end | ||
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 144: | Line 91: | ||
end | end | ||
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 | ||
:tag('tr') | :tag('tr') | ||
:addClass(rowArgs.rowclass) | :addClass(rowArgs.rowclass) | ||
:cssText(rowArgs.rowstyle) | :cssText(rowArgs.rowstyle) | ||
:attr('id', rowArgs.rowid) | |||
:tag('th') | :tag('th') | ||
:attr('colspan', | :attr('colspan', 2) | ||
: | :attr('id', rowArgs.headerid) | ||
:addClass(rowArgs.class) | :addClass(rowArgs.class) | ||
:addClass(args.headerclass) | :addClass(args.headerclass) | ||
- | :css('text-align', 'center') | ||
: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( | root:wikitext('[[Category:Pages which use infobox templates with ignored data cells]]') | ||
end | |||
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 | ||
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) | ||
:cssText(args.labelstyle) | :cssText(args.labelstyle) | ||
:cssText(rowArgs.rowcellstyle) | :cssText(rowArgs.rowcellstyle) | ||
Line 190: | Line 132: | ||
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(' | :attr('id', rowArgs.dataid) | ||
:addClass(rowArgs.class) | :addClass(rowArgs.class) | ||
:cssText(rowArgs.datastyle) | :cssText(rowArgs.datastyle) | ||
:cssText(rowArgs.rowcellstyle) | :cssText(rowArgs.rowcellstyle) | ||
:wikitext(fixChildBoxes(rowArgs.data, 'td')) | :wikitext(fixChildBoxes(rowArgs.data, 'td')) | ||
end | end | ||
end | end | ||
Line 206: | Line 149: | ||
if not args.title then return end | if not args.title then return end | ||
root | root | ||
:tag('caption') | :tag('caption') | ||
:addClass(args.titleclass) | :addClass(args.titleclass) | ||
:cssText(args.titlestyle) | :cssText(args.titlestyle) | ||
:wikitext(args.title) | :wikitext(args.title) | ||
end | end | ||
Line 222: | Line 159: | ||
if not args.above then return end | if not args.above then return end | ||
root | root | ||
:tag('tr') | :tag('tr') | ||
:tag('th') | :tag('th') | ||
:attr('colspan', | :attr('colspan', 2) | ||
:addClass(args.aboveclass) | :addClass(args.aboveclass) | ||
-- | :css('text-align', 'center') | ||
: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 239: | Line 174: | ||
if not args.below then return end | if not args.below then return end | ||
root | root | ||
:tag('tr') | :tag('tr') | ||
:tag('td') | :tag('td') | ||
:attr('colspan', '2') | :attr('colspan', '2') | ||
:addClass(args.belowclass) | :addClass(args.belowclass) | ||
- | :css('text-align', 'center') | ||
:cssText(args.belowstyle) | :cssText(args.belowstyle) | ||
:wikitext(fixChildBoxes(args.below,'td')) | :wikitext(fixChildBoxes(args.below,'td')) | ||
end | end | ||
Line 284: | Line 193: | ||
local subheadernums = getArgNums('subheader') | local subheadernums = getArgNums('subheader') | ||
for k, num in ipairs(subheadernums) do | for k, num in ipairs(subheadernums) do | ||
addRow({ | |||
data = args['subheader' .. tostring(num)], | data = args['subheader' .. tostring(num)], | ||
datastyle = args.subheaderstyle, | datastyle = args.subheaderstyle, | ||
rowcellstyle = args['subheaderstyle' .. tostring(num)], | rowcellstyle = args['subheaderstyle' .. tostring(num)], | ||
Line 292: | Line 200: | ||
rowclass = args['subheaderrowclass' .. tostring(num)] | rowclass = args['subheaderrowclass' .. tostring(num)] | ||
}) | }) | ||
end | end | ||
end | end | ||
Line 332: | Line 217: | ||
data | data | ||
:tag('div') | :tag('div') | ||
:cssText(args.captionstyle) | :cssText(args.captionstyle) | ||
:wikitext(caption) | :wikitext(caption) | ||
end | end | ||
addRow({ | |||
data = tostring(data), | data = tostring(data), | ||
datastyle = args.imagestyle, | datastyle = args.imagestyle, | ||
class = args.imageclass, | class = args.imageclass, | ||
Line 347: | Line 229: | ||
end | end | ||
local function preprocessRows() | local function preprocessRows() | ||
-- 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 360: | Line 241: | ||
end | end | ||
lastheader = num | lastheader = num | ||
elseif args['data' .. tostring(num)] and | elseif args['data' .. tostring(num)] and args['data' .. tostring(num)]:gsub('%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*]]', ''):match('^%S') then | ||
local data = args['data' .. tostring(num)] | local data = args['data' .. tostring(num)] | ||
if data:gsub( | if data:gsub('%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*]]', ''):match('%S') then | ||
lastheader = nil | lastheader = nil | ||
end | end | ||
Line 375: | Line 253: | ||
end | end | ||
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 389: | Line 266: | ||
class = args['class' .. tostring(num)], | class = args['class' .. tostring(num)], | ||
rowclass = args['rowclass' .. tostring(num)], | 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)], | |||
labelid = args['labelid' .. tostring(num)], | |||
headerid = args['headerid' .. tostring(num)], | |||
rowid = args['rowid' .. tostring(num)] | |||
}) | }) | ||
end | end | ||
Line 399: | Line 279: | ||
if not args.name then return end | if not args.name then return end | ||
root | root | ||
:tag('tr') | :tag('tr') | ||
:tag('td') | :tag('td') | ||
:attr('colspan', '2') | :attr('colspan', '2') | ||
: | :css('text-align', 'right') | ||
:wikitext( | :wikitext(navbar{ | ||
args.name, | args.name, | ||
mini = 1, | mini = 1, | ||
Line 414: | Line 293: | ||
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( | root:wikitext(mw.getCurrentFrame():expandTemplate({title = 'italic title'})) | ||
end | end | ||
end | end | ||
local function renderTrackingCategories() | local function renderTrackingCategories() | ||
if args.decat | 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 | end | ||
end | end | ||
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 | :addClass((args.subbox ~= 'yes') and 'infobox' or nil) | ||
:addClass(args.bodyclass) | :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) | :cssText(args.bodystyle) | ||
renderTitle() | renderTitle() | ||
Line 544: | Line 345: | ||
:wikitext(args.title) | :wikitext(args.title) | ||
end | end | ||
renderSubheaders() | |||
return | renderImages() | ||
if args.autoheaders then | |||
preprocessRows() | |||
end | |||
renderRows() | |||
renderBelowRow() | |||
renderNavBar() | |||
renderItalicTitle() | |||
renderTrackingCategories() | |||
return tostring(root) | |||
end | end | ||
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 557: | Line 368: | ||
end | end | ||
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 574: | Line 384: | ||
-- 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 | 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 | -- 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 600: | Line 408: | ||
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. | ||
preprocessSingleArg(prefixArgName) | preprocessSingleArg(prefixArgName) | ||
end | end | ||
-- Process the depend table if the prefix argument is present | -- 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 | 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 619: | Line 426: | ||
end | end | ||
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 653: | Line 459: | ||
{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 663: | Line 473: | ||
preprocessSingleArg('belowstyle') | preprocessSingleArg('belowstyle') | ||
preprocessSingleArg('name') | preprocessSingleArg('name') | ||
args['italic title'] = origArgs['italic title'] -- different behaviour if blank or absent | |||
args['italic title'] = origArgs['italic title'] | |||
preprocessSingleArg('decat') | preprocessSingleArg('decat') | ||
end | end | ||
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 685: | Line 491: | ||
end | end | ||
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 |