Module:Infobox: Difference between revisions
m
spacing
m (Reverted edits by Ethan (talk) to last revision by [[User:Templates>ISUtahraptor|Templates>ISUtahraptor]]) Tag: Rollback |
w>Fayenatic london m (spacing) |
||
Line 1: | Line 1: | ||
local p = {} | local p = {} | ||
local args = {} | local args = {} | ||
local origArgs = {} | local origArgs = {} | ||
local root | local root | ||
local empty_row_categories = {} | |||
local | local category_in_empty_row_pattern = '%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*]]' | ||
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 39: | Line 43: | ||
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 56: | ||
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]] | ||
-- 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 68: | ||
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) | ||
local vals = {} | local vals = {} | ||
for k, v in pairs(t1) do | for k, v in pairs(t1) do | ||
Line 78: | Line 93: | ||
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 = {} | local nums = {} | ||
for k, v in pairs(args) do | for k, v in pairs(args) do | ||
Line 91: | Line 106: | ||
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) | ||
if rowArgs.header and rowArgs.header ~= '_BLANK_' then | if rowArgs.header and rowArgs.header ~= '_BLANK_' then | ||
has_rows = true | |||
root | root | ||
:tag('tr') | :tag('tr') | ||
:addClass(rowArgs.rowclass) | :addClass(rowArgs.rowclass) | ||
:cssText(rowArgs.rowstyle) | :cssText(rowArgs.rowstyle) | ||
:tag('th') | :tag('th') | ||
:attr('colspan', 2) | :attr('colspan', '2') | ||
: | :addClass('infobox-header') | ||
:addClass(rowArgs.class) | :addClass(rowArgs.class) | ||
:addClass(args.headerclass) | :addClass(args.headerclass) | ||
-- @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 | root:wikitext( | ||
'[[Category:Pages using infobox templates with ignored data cells]]' | |||
) | |||
end | end | ||
elseif rowArgs.data and rowArgs.data:gsub( | |||
category_in_empty_row_pattern, '' | |||
):match('^%S') then | |||
has_rows = true | |||
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) | ||
if rowArgs.label then | if rowArgs.label then | ||
row | row | ||
:tag('th') | :tag('th') | ||
:attr('scope', 'row') | :attr('scope', 'row') | ||
: | :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 150: | ||
local dataCell = row:tag('td') | local dataCell = row:tag('td') | ||
dataCell | dataCell | ||
:attr(' | :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 149: | Line 166: | ||
if not args.title then return end | if not args.title then return end | ||
has_rows = true | |||
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 159: | Line 179: | ||
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('infobox-above') | |||
:addClass(args.aboveclass) | :addClass(args.aboveclass) | ||
-- @deprecated next; target .infobox-<name> .infobox-above | |||
:cssText(args.abovestyle) | :cssText(args.abovestyle) | ||
:wikitext(fixChildBoxes(args.above,'th')) | :wikitext(fixChildBoxes(args.above,'th')) | ||
Line 174: | Line 194: | ||
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('infobox-below') | |||
:addClass(args.belowclass) | :addClass(args.belowclass) | ||
-- @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 | |||
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 | ||
Line 193: | Line 235: | ||
local subheadernums = getArgNums('subheader') | local subheadernums = getArgNums('subheader') | ||
for k, num in ipairs(subheadernums) do | for k, num in ipairs(subheadernums) do | ||
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 243: | ||
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 | |||
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 | end | ||
Line 217: | Line 281: | ||
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 | ||
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 296: | ||
end | end | ||
-- When autoheaders are turned on, preprocesses the rows | |||
local function preprocessRows() | local function preprocessRows() | ||
if not args.autoheaders then return end | |||
local rownums = union(getArgNums('header'), getArgNums('data')) | local rownums = union(getArgNums('header'), getArgNums('data')) | ||
table.sort(rownums) | table.sort(rownums) | ||
Line 241: | Line 309: | ||
end | end | ||
lastheader = num | lastheader = num | ||
elseif args['data' .. tostring(num)] and args['data' .. tostring(num)]:gsub( | 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( | if data:gsub(category_in_empty_row_pattern, ''):match('%S') then | ||
lastheader = nil | lastheader = nil | ||
end | end | ||
Line 253: | Line 324: | ||
end | end | ||
-- Gets the union of the header and data argument numbers, | |||
-- and renders them all in order | |||
local function renderRows() | local function renderRows() | ||
local rownums = union(getArgNums('header'), getArgNums('data')) | local rownums = union(getArgNums('header'), getArgNums('data')) | ||
table.sort(rownums) | table.sort(rownums) | ||
Line 266: | Line 338: | ||
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 | rowcellstyle = args['rowcellstyle' .. tostring(num)] | ||
}) | }) | ||
end | end | ||
Line 279: | Line 348: | ||
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') | ||
: | :addClass('infobox-navbar') | ||
:wikitext( | :wikitext(require('Module:Navbar')._navbar{ | ||
args.name, | args.name, | ||
mini = 1, | mini = 1, | ||
Line 297: | Line 367: | ||
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 | if args.decat == 'yes' then return end | ||
if args.child == 'yes' then | |||
if args.title then | |||
root:wikitext( | |||
'[[Category:Pages using embedded infobox templates with the title parameter]]' | |||
) | |||
end | end | ||
elseif #(getArgNums('data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then | |||
root:wikitext('[[Category:Articles using infobox templates with no data rows]]') | |||
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 | 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 | 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 | if args.child ~= 'yes' then | ||
root = mw.html.create('table') | root = mw.html.create('table') | ||
root | root | ||
:addClass | :addClass(args.subbox == 'yes' and 'infobox-subbox' or 'infobox') | ||
:addClass(args.bodyclass) | :addClass(args.bodyclass) | ||
-- @deprecated next; target .infobox-<name> | |||
:cssText(args.bodystyle) | :cssText(args.bodystyle) | ||
Line 345: | Line 469: | ||
:wikitext(args.title) | :wikitext(args.title) | ||
end | 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 origArgs[argName] and origArgs[argName] ~= '' then | ||
args[argName] = origArgs[argName] | args[argName] = origArgs[argName] | ||
Line 368: | Line 482: | ||
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 | 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 499: | ||
-- 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 525: | ||
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 | |||
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 | ||
-- 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 426: | Line 544: | ||
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() | ||
preprocessSingleArg('autoheaders') | preprocessSingleArg('autoheaders') | ||
preprocessSingleArg('child') | preprocessSingleArg('child') | ||
Line 459: | Line 578: | ||
{prefix = 'rowstyle'}, | {prefix = 'rowstyle'}, | ||
{prefix = 'rowcellstyle'}, | {prefix = 'rowcellstyle'}, | ||
{prefix = 'class | {prefix = 'class'} | ||
}, 50) | }, 50) | ||
preprocessSingleArg('headerclass') | preprocessSingleArg('headerclass') | ||
Line 473: | Line 588: | ||
preprocessSingleArg('belowstyle') | preprocessSingleArg('belowstyle') | ||
preprocessSingleArg('name') | preprocessSingleArg('name') | ||
args['italic title'] = origArgs['italic title'] | -- 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 frame == mw.getCurrentFrame() then | if frame == mw.getCurrentFrame() then | ||
origArgs = frame:getParent().args | origArgs = frame:getParent().args | ||
Line 491: | Line 610: | ||
end | end | ||
-- For calling via #invoke within a template | |||
function p.infoboxTemplate(frame) | function p.infoboxTemplate(frame) | ||
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 |