Module:Infobox: Difference between revisions
Jump to navigation
Jump to search
m (1 revision imported) |
(Replace infobox with a different one) Tag: Manual revert |
||
Line 1: | Line 1: | ||
-- Load necessary modules. |
|||
local p = {} |
|||
require('Module:No globals') |
|||
local args = {} |
|||
local |
local getArgs |
||
local yesno = require('Module:Yesno') |
|||
local root |
|||
local empty_row_categories = {} |
|||
local category_in_empty_row_pattern = '%[%[%s*[Cc][Aa][Tt][Ee][Gg][Oo][Rr][Yy]%s*:[^]]*]]' |
|||
local has_rows = false |
|||
local lists = { |
|||
plainlist_t = { |
|||
patterns = { |
|||
'^plainlist$', |
|||
'%splainlist$', |
|||
'^plainlist%s', |
|||
'%splainlist%s' |
|||
}, |
|||
found = false, |
|||
styles = 'Plainlist/styles.css' |
|||
}, |
|||
hlist_t = { |
|||
patterns = { |
|||
'^hlist$', |
|||
'%shlist$', |
|||
'^hlist%s', |
|||
'%shlist%s' |
|||
}, |
|||
found = false, |
|||
styles = 'Hlist/styles.css' |
|||
} |
|||
} |
|||
local p = { } |
|||
local function has_list_class(args_to_check) |
|||
for _, list in pairs(lists) do |
|||
if not list.found then |
|||
for _, arg in pairs(args_to_check) do |
|||
for _, pattern in ipairs(list.patterns) do |
|||
if mw.ustring.find(arg or '', pattern) then |
|||
list.found = true |
|||
break |
|||
end |
|||
end |
|||
if list.found then break end |
|||
end |
|||
end |
|||
end |
|||
end |
|||
-------------------------------------------------------------------------------- |
|||
local function fixChildBoxes(sval, tt) |
|||
-- Helper functions |
|||
local function notempty( s ) return s and s:match( '%S' ) end |
|||
-------------------------------------------------------------------------------- |
|||
if notempty(sval) then |
|||
local marker = '<span class=special_infobox_marker>' |
|||
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, '(</[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 |
|||
-- [[Special:Diff/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 |
|||
-- 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 temp = {} |
|||
for _, v in pairs(t1) do |
|||
local vals = {} |
|||
temp[v] = true |
|||
for k, v in pairs(t1) do |
|||
vals[v] = true |
|||
end |
end |
||
for |
for _, v in pairs(t2) do |
||
temp[v] = true |
|||
end |
end |
||
local ret = {} |
local ret = {} |
||
for k |
for k in pairs(temp) do |
||
table.insert(ret, k) |
table.insert(ret, k) |
||
end |
end |
||
table.sort(ret) |
|||
return ret |
return ret |
||
end |
end |
||
local function getArgNums(args, prefix) |
|||
-- Returns a table containing the numbers of the arguments that exist |
|||
local ret = { } |
|||
-- for the specified prefix. For example, if the prefix was 'data', and |
|||
for k in pairs(args) do |
|||
-- 'data1', 'data2', and 'data5' exist, it would return {1, 2, 5}. |
|||
local |
local num = string.match(k, "^" .. prefix .. "(%d*)$") |
||
if num then |
|||
local nums = {} |
|||
table.insert(ret, tonumber(num)) |
|||
for k, v in pairs(args) do |
|||
end |
|||
local num = tostring(k):match('^' .. prefix .. '([1-9]%d*)$') |
|||
if num then table.insert(nums, tonumber(num)) end |
|||
end |
end |
||
table.sort( |
table.sort(ret) |
||
return |
return ret |
||
end |
end |
||
-------------------------------------------------------------------------------- |
|||
-- Adds a row to the infobox, with either a header cell |
|||
-- Box class definition |
|||
-- or a label/data cell combination. |
|||
-------------------------------------------------------------------------------- |
|||
local function addRow(rowArgs) |
|||
if rowArgs.header and rowArgs.header ~= '_BLANK_' then |
|||
has_rows = true |
|||
has_list_class({ rowArgs.rowclass, rowArgs.class, args.headerclass }) |
|||
root |
|||
:tag('tr') |
|||
:addClass(rowArgs.rowclass) |
|||
:cssText(rowArgs.rowstyle) |
|||
:tag('th') |
|||
:attr('colspan', '2') |
|||
:addClass('infobox-header') |
|||
:addClass(rowArgs.class) |
|||
:addClass(args.headerclass) |
|||
-- @deprecated next; target .infobox-<name> .infobox-header |
|||
:cssText(args.headerstyle) |
|||
:cssText(rowArgs.rowcellstyle) |
|||
:wikitext(fixChildBoxes(rowArgs.header, 'th')) |
|||
if rowArgs.data then |
|||
root:wikitext( |
|||
'[[Category:Pages using infobox templates with ignored data cells]]' |
|||
) |
|||
end |
|||
elseif rowArgs.data and rowArgs.data:gsub(category_in_empty_row_pattern, ''):match('^%S') then |
|||
has_rows = true |
|||
has_list_class({ rowArgs.rowclass, rowArgs.class }) |
|||
local row = root:tag('tr') |
|||
row:addClass(rowArgs.rowclass) |
|||
row:cssText(rowArgs.rowstyle) |
|||
if rowArgs.label then |
|||
row |
|||
:tag('th') |
|||
:attr('scope', 'row') |
|||
:addClass('infobox-label') |
|||
-- @deprecated next; target .infobox-<name> .infobox-label |
|||
:cssText(args.labelstyle) |
|||
:cssText(rowArgs.rowcellstyle) |
|||
:wikitext(rowArgs.label) |
|||
:done() |
|||
end |
|||
local Infobox = {} |
|||
Infobox.__index = Infobox |
|||
dataCell |
|||
:attr('colspan', not rowArgs.label and '2' or nil) |
|||
:addClass(not rowArgs.label and 'infobox-full-data' or 'infobox-data') |
|||
:addClass(rowArgs.class) |
|||
-- @deprecated next; target .infobox-<name> .infobox(-full)-data |
|||
:cssText(rowArgs.datastyle) |
|||
:cssText(rowArgs.rowcellstyle) |
|||
:wikitext(fixChildBoxes(rowArgs.data, 'td')) |
|||
else |
|||
table.insert(empty_row_categories, rowArgs.data or '') |
|||
end |
|||
end |
|||
function Infobox.new(args) |
|||
args = args or {} |
|||
local obj = {} |
|||
-- Set the arguments |
|||
has_rows = true |
|||
obj.args = args |
|||
has_list_class({args.titleclass}) |
|||
mw.logObject(obj) |
|||
root |
|||
:tag('caption') |
|||
:addClass('infobox-title') |
|||
:addClass(args.titleclass) |
|||
-- @deprecated next; target .infobox-<name> .infobox-title |
|||
:cssText(args.titlestyle) |
|||
:wikitext(args.title) |
|||
end |
|||
return setmetatable(obj, Infobox) |
|||
local function renderAboveRow() |
|||
if not args.above then return end |
|||
has_rows = true |
|||
has_list_class({ args.aboveclass }) |
|||
root |
|||
:tag('tr') |
|||
:tag('th') |
|||
:attr('colspan', '2') |
|||
:addClass('infobox-above') |
|||
:addClass(args.aboveclass) |
|||
-- @deprecated next; target .infobox-<name> .infobox-above |
|||
:cssText(args.abovestyle) |
|||
:wikitext(fixChildBoxes(args.above,'th')) |
|||
end |
end |
||
function Infobox:setParameters() |
|||
local args = self.args |
|||
has_rows = true |
|||
has_list_class({ args.belowclass }) |
|||
self.title = args.title |
|||
root |
|||
self.above = args.above |
|||
:tag('tr') |
|||
:tag('td') |
|||
self.autoheaders = yesno(args.autoheaders) |
|||
:attr('colspan', '2') |
|||
if self.autoheaders then |
|||
:addClass('infobox-below') |
|||
self:removeLoneHeaders() |
|||
:addClass(args.belowclass) |
|||
-- @deprecated next; target .infobox-<name> .infobox-below |
|||
: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 |
|||
has_list_class({ subheaderArgs.rowclass, subheaderArgs.class }) |
|||
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 |
||
self.subheaders = self:setSubheaders() |
|||
self.images = self:setImages() |
|||
self.rows = self:setRows() |
|||
self.below = args.below |
|||
end |
end |
||
function Infobox:setSubheaders() |
|||
local args = self.args |
|||
local nums = getArgNums(args, 'subheader') |
|||
local t = { } |
|||
if args.subheader then |
if args.subheader then |
||
table.insert(t, args.subheader) |
|||
end |
end |
||
if args.subheaderrowclass then |
|||
for _,v in pairs(nums) do |
|||
args.subheaderrowclass1 = args.subheaderrowclass |
|||
table.insert(t, args['subheader' .. v]) |
|||
end |
|||
local subheadernums = getArgNums('subheader') |
|||
for k, num in ipairs(subheadernums) do |
|||
addSubheaderRow({ |
|||
data = args['subheader' .. tostring(num)], |
|||
-- @deprecated next; target .infobox-<name> .infobox-subheader |
|||
datastyle = args.subheaderstyle, |
|||
rowcellstyle = args['subheaderstyle' .. tostring(num)], |
|||
class = args.subheaderclass, |
|||
rowclass = args['subheaderrowclass' .. tostring(num)] |
|||
}) |
|||
end |
end |
||
return t |
|||
end |
end |
||
function Infobox:setImages() |
|||
local args = self.args |
|||
local nums = union(getArgNums(args, 'image'), getArgNums(args, 'caption')) |
|||
if imageArgs.data and |
|||
local t = { } |
|||
imageArgs.data:gsub(category_in_empty_row_pattern, ''):match('^%S') then |
|||
if args.image or args.caption then |
|||
has_rows = true |
|||
table.insert(t, |
|||
has_list_class({ imageArgs.rowclass, imageArgs.class }) |
|||
{ |
|||
image = args.image, |
|||
local row = root:tag('tr') |
|||
caption = args.caption |
|||
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 |
|||
for _,v in pairs(nums) do |
|||
table.insert(t, |
|||
local function renderImages() |
|||
{ |
|||
if args.image then |
|||
image = args['image' .. v], |
|||
caption = args['caption' .. v] |
|||
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') |
|||
:addClass('infobox-caption') |
|||
-- @deprecated next; target .infobox-<name> .infobox-caption |
|||
:cssText(args.captionstyle) |
|||
:wikitext(caption) |
|||
end |
|||
addImageRow({ |
|||
data = tostring(data), |
|||
-- @deprecated next; target .infobox-<name> .infobox-image |
|||
datastyle = args.imagestyle, |
|||
class = args.imageclass, |
|||
rowclass = args['imagerowclass' .. tostring(num)] |
|||
}) |
|||
end |
end |
||
return t |
|||
end |
end |
||
function Infobox:removeLoneHeaders() |
|||
-- When autoheaders are turned on, preprocesses the rows |
|||
local |
local args = self.args |
||
if not args.autoheaders then return end |
|||
local |
local nums = union(getArgNums(args, 'header'), getArgNums(args, 'data')) |
||
table.sort( |
table.sort(nums) |
||
local lastheader |
|||
local lastHeader |
|||
for k, num in ipairs(rownums) do |
|||
if args['header' .. tostring(num)] then |
|||
for _, v in pairs(nums) do |
|||
if lastheader then |
|||
if args['header' .. v] then |
|||
if lastHeader then |
|||
end |
|||
args['header' .. lastHeader] = nil |
|||
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 |
||
lastHeader = v |
|||
else |
|||
lastHeader = nil |
|||
end |
end |
||
end |
end |
||
if lastheader then |
|||
args['header' .. tostring(lastheader)] = nil |
|||
end |
|||
end |
|||
if lastHeader then |
|||
-- Gets the union of the header and data argument numbers, |
|||
args['header' .. lastHeader] = nil |
|||
-- and renders them all in order |
|||
local function renderRows() |
|||
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)], |
|||
-- @deprecated next; target .infobox-<name> rowclass |
|||
rowstyle = args['rowstyle' .. tostring(num)], |
|||
rowcellstyle = args['rowcellstyle' .. tostring(num)] |
|||
}) |
|||
end |
end |
||
end |
end |
||
function Infobox:setRows() |
|||
local args = self.args |
|||
has_rows = true |
|||
root |
|||
:tag('tr') |
|||
:tag('td') |
|||
:attr('colspan', '2') |
|||
:addClass('infobox-navbar') |
|||
:wikitext(require('Module:Navbar')._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(require('Module:Italic title')._main({})) |
|||
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() |
|||
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 |
|||
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() |
|||
local |
local nums = { } |
||
nums = union(nums, getArgNums(args, 'header')) |
|||
if lists.hlist_t.found then |
|||
nums = union(nums, getArgNums(args, 'label')) |
|||
hlist_templatestyles = frame:extensionTag{ |
|||
nums = union(nums, getArgNums(args, 'data')) |
|||
name = 'templatestyles', args = { src = lists.hlist_t.styles } |
|||
} |
|||
local t = { } |
|||
end |
|||
for _,v in pairs(nums) do |
|||
local plainlist_templatestyles = '' |
|||
table.insert(t, |
|||
if lists.plainlist_t.found then |
|||
{ |
|||
plainlist_templatestyles = frame:extensionTag{ |
|||
header = args['header' .. v], |
|||
name = 'templatestyles', args = { src = lists.plainlist_t.styles } |
|||
label = args['label' .. v], |
|||
} |
|||
data = args['data' .. v] |
|||
}) |
|||
end |
end |
||
return t |
|||
-- See function description |
|||
end |
|||
local base_templatestyles = frame:extensionTag{ |
|||
name = 'templatestyles', args = { src = 'Module:Infobox/styles.css' } |
|||
} |
|||
function Infobox:export() |
|||
local templatestyles = '' |
|||
local root = mw.html.create():tag('table') |
|||
if args['templatestyles'] then |
|||
root:addClass('infobox') |
|||
templatestyles = frame:extensionTag{ |
|||
name = 'templatestyles', args = { src = args['templatestyles'] } |
|||
} |
|||
end |
|||
if self.title then |
|||
local child_templatestyles = '' |
|||
local title = root:tag('caption') |
|||
if args['child templatestyles'] then |
|||
title |
|||
child_templatestyles = frame:extensionTag{ |
|||
:addClass('ib-title') |
|||
name = 'templatestyles', args = { src = args['child templatestyles'] } |
|||
:wikitext(self.title) |
|||
} |
|||
end |
end |
||
if self.above then |
|||
local grandchild_templatestyles = '' |
|||
local above = root:tag('tr'):tag('td') |
|||
if args['grandchild templatestyles'] then |
|||
above |
|||
grandchild_templatestyles = frame:extensionTag{ |
|||
:attr('colspan', 2) |
|||
name = 'templatestyles', args = { src = args['grandchild templatestyles'] } |
|||
:addClass('ib-above') |
|||
} |
|||
:wikitext(self.above) |
|||
end |
end |
||
for _,v in ipairs(self.subheaders) do |
|||
return table.concat({ |
|||
local subheader = root:tag('tr'):tag('td') |
|||
-- hlist -> plainlist -> base is best-effort to preserve old Common.css ordering. |
|||
subheader |
|||
-- this ordering is not a guarantee because the rows of interest invoking |
|||
:attr('colspan', 2) |
|||
-- each class may not be on a specific page |
|||
:addClass('ib-subheader') |
|||
hlist_templatestyles, |
|||
:wikitext(v) |
|||
plainlist_templatestyles, |
|||
base_templatestyles, |
|||
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() |
|||
if args.child ~= 'yes' then |
|||
root = mw.html.create('table') |
|||
root |
|||
:addClass(args.subbox == 'yes' and 'infobox-subbox' or 'infobox') |
|||
:addClass(args.bodyclass) |
|||
-- @deprecated next; target .infobox-<name> |
|||
:cssText(args.bodystyle) |
|||
has_list_class({ args.bodyclass }) |
|||
renderTitle() |
|||
renderAboveRow() |
|||
else |
|||
root = mw.html.create() |
|||
root |
|||
:wikitext(args.title) |
|||
end |
end |
||
structure_infobox_common() |
|||
for _,v in ipairs(self.images) do |
|||
return loadTemplateStyles() .. root |
|||
if v.image then |
|||
end |
|||
local cell = root:tag('tr'):tag('td') |
|||
:attr('colspan', 2) |
|||
-- If the argument exists and isn't blank, add it to the argument table. |
|||
:addClass('ib-image') |
|||
-- Blank arguments are treated as nil to match the behaviour of ParserFunctions. |
|||
:wikitext(v.image) |
|||
local function preprocessSingleArg(argName) |
|||
if origArgs[argName] and origArgs[argName] ~= '' then |
|||
if v.caption then |
|||
args[argName] = origArgs[argName] |
|||
cell |
|||
end |
|||
:tag('div') |
|||
end |
|||
:addClass('ib-image-caption') |
|||
:wikitext(v.caption) |
|||
-- 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) |
|||
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 |
end |
||
end |
end |
||
for _,v in ipairs(self.rows) do |
|||
-- Get arguments with number suffixes. |
|||
if v.header then |
|||
local a = 1 -- Counter variable. |
|||
if v.header ~= '_BLANK_' then |
|||
local moreArgumentsExist = true |
|||
local header = root:tag('tr'):tag('th') |
|||
while moreArgumentsExist == true do |
|||
header:attr('colspan', 2) |
|||
moreArgumentsExist = false |
|||
header:addClass('ib-header') |
|||
for i = a, a + step - 1 do |
|||
header:wikitext(v.header) |
|||
for j,v in ipairs(prefixTable) do |
|||
end |
|||
local prefixArgName = v.prefix .. tostring(i) |
|||
else |
|||
if origArgs[prefixArgName] then |
|||
if v.label and v.data then |
|||
-- Do another loop if any arguments are found, even blank ones. |
|||
local row = root:tag('tr') |
|||
moreArgumentsExist = true |
|||
preprocessSingleArg(prefixArgName) |
|||
local label = row:tag('th') |
|||
end |
|||
label:addClass('ib-label') |
|||
-- Process the depend table if the prefix argument is present |
|||
label:wikitext(v.label) |
|||
-- and not blank, or we are processing "prefix1" and "prefix" is |
|||
-- present and not blank, and if the depend table is present. |
|||
local data = row:tag('td') |
|||
if v.depend and (args[prefixArgName] or (i == 1 and args[v.prefix])) then |
|||
data:addClass('ib-data') |
|||
for j,dependValue in ipairs(v.depend) do |
|||
data:wikitext(v.data) |
|||
local dependArgName = dependValue .. tostring(i) |
|||
end |
|||
preprocessSingleArg(dependArgName) |
|||
if v.data and not v.label then |
|||
end |
|||
local data = root:tag('tr'):tag('td') |
|||
data:attr('colspan', 2) |
|||
data:addClass('ib-data') |
|||
data:wikitext(v.data) |
|||
end |
end |
||
end |
end |
||
a = a + step |
|||
end |
end |
||
if self.below then |
|||
local below = root:tag('tr'):tag('td') |
|||
below |
|||
:attr('colspan', 2) |
|||
:addClass('ib-below') |
|||
:wikitext(self.below) |
|||
end |
|||
local templateStyle = mw.getCurrentFrame():extensionTag( 'templatestyles', '', { src = 'Template:Infobox/styles.css' } ); |
|||
return templateStyle .. tostring(root) |
|||
end |
end |
||
-------------------------------------------------------------------------------- |
|||
-- Parse the data parameters in the same order that the old {{infobox}} did, so |
|||
-- Exports |
|||
-- 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 |
if not getArgs then |
||
getArgs = require('Module:Arguments').getArgs |
|||
origArgs = frame:getParent().args |
|||
else |
|||
origArgs = frame |
|||
end |
end |
||
local box = Infobox.new(getArgs(frame)) |
|||
parseDataParameters() |
|||
box:setParameters() |
|||
return |
return box:export() |
||
end |
end |
||
-- For calling via #invoke within a template |
|||
function p.infoboxTemplate(frame) |
|||
origArgs = {} |
|||
for k,v in pairs(frame.args) do origArgs[k] = mw.text.trim(v) end |
|||
parseDataParameters() |
|||
return _infobox() |
|||
end |
|||
return p |
return p |
Latest revision as of 16:47, 5 February 2024
Documentation for this module may be created at Module:Infobox/doc
-- Load necessary modules.
require('Module:No globals')
local getArgs
local yesno = require('Module:Yesno')
local p = { }
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------
local function union(t1, t2)
local temp = {}
for _, v in pairs(t1) do
temp[v] = true
end
for _, v in pairs(t2) do
temp[v] = true
end
local ret = {}
for k in pairs(temp) do
table.insert(ret, k)
end
table.sort(ret)
return ret
end
local function getArgNums(args, prefix)
local ret = { }
for k in pairs(args) do
local num = string.match(k, "^" .. prefix .. "(%d*)$")
if num then
table.insert(ret, tonumber(num))
end
end
table.sort(ret)
return ret
end
--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------
local Infobox = {}
Infobox.__index = Infobox
function Infobox.new(args)
args = args or {}
local obj = {}
-- Set the arguments
obj.args = args
mw.logObject(obj)
return setmetatable(obj, Infobox)
end
function Infobox:setParameters()
local args = self.args
self.title = args.title
self.above = args.above
self.autoheaders = yesno(args.autoheaders)
if self.autoheaders then
self:removeLoneHeaders()
end
self.subheaders = self:setSubheaders()
self.images = self:setImages()
self.rows = self:setRows()
self.below = args.below
end
function Infobox:setSubheaders()
local args = self.args
local nums = getArgNums(args, 'subheader')
local t = { }
if args.subheader then
table.insert(t, args.subheader)
end
for _,v in pairs(nums) do
table.insert(t, args['subheader' .. v])
end
return t
end
function Infobox:setImages()
local args = self.args
local nums = union(getArgNums(args, 'image'), getArgNums(args, 'caption'))
local t = { }
if args.image or args.caption then
table.insert(t,
{
image = args.image,
caption = args.caption
})
end
for _,v in pairs(nums) do
table.insert(t,
{
image = args['image' .. v],
caption = args['caption' .. v]
})
end
return t
end
function Infobox:removeLoneHeaders()
local args = self.args
local nums = union(getArgNums(args, 'header'), getArgNums(args, 'data'))
table.sort(nums)
local lastHeader
for _, v in pairs(nums) do
if args['header' .. v] then
if lastHeader then
args['header' .. lastHeader] = nil
end
lastHeader = v
else
lastHeader = nil
end
end
if lastHeader then
args['header' .. lastHeader] = nil
end
end
function Infobox:setRows()
local args = self.args
local nums = { }
nums = union(nums, getArgNums(args, 'header'))
nums = union(nums, getArgNums(args, 'label'))
nums = union(nums, getArgNums(args, 'data'))
local t = { }
for _,v in pairs(nums) do
table.insert(t,
{
header = args['header' .. v],
label = args['label' .. v],
data = args['data' .. v]
})
end
return t
end
function Infobox:export()
local root = mw.html.create():tag('table')
root:addClass('infobox')
if self.title then
local title = root:tag('caption')
title
:addClass('ib-title')
:wikitext(self.title)
end
if self.above then
local above = root:tag('tr'):tag('td')
above
:attr('colspan', 2)
:addClass('ib-above')
:wikitext(self.above)
end
for _,v in ipairs(self.subheaders) do
local subheader = root:tag('tr'):tag('td')
subheader
:attr('colspan', 2)
:addClass('ib-subheader')
:wikitext(v)
end
for _,v in ipairs(self.images) do
if v.image then
local cell = root:tag('tr'):tag('td')
:attr('colspan', 2)
:addClass('ib-image')
:wikitext(v.image)
if v.caption then
cell
:tag('div')
:addClass('ib-image-caption')
:wikitext(v.caption)
end
end
end
for _,v in ipairs(self.rows) do
if v.header then
if v.header ~= '_BLANK_' then
local header = root:tag('tr'):tag('th')
header:attr('colspan', 2)
header:addClass('ib-header')
header:wikitext(v.header)
end
else
if v.label and v.data then
local row = root:tag('tr')
local label = row:tag('th')
label:addClass('ib-label')
label:wikitext(v.label)
local data = row:tag('td')
data:addClass('ib-data')
data:wikitext(v.data)
end
if v.data and not v.label then
local data = root:tag('tr'):tag('td')
data:attr('colspan', 2)
data:addClass('ib-data')
data:wikitext(v.data)
end
end
end
if self.below then
local below = root:tag('tr'):tag('td')
below
:attr('colspan', 2)
:addClass('ib-below')
:wikitext(self.below)
end
local templateStyle = mw.getCurrentFrame():extensionTag( 'templatestyles', '', { src = 'Template:Infobox/styles.css' } );
return templateStyle .. tostring(root)
end
--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------
function p.infobox(frame)
if not getArgs then
getArgs = require('Module:Arguments').getArgs
end
local box = Infobox.new(getArgs(frame))
box:setParameters()
return box:export()
end
return p