Module:Navbox: Difference between revisions

2,074 bytes added ,  2 years ago
m
12 revisions imported from wikipedia:Module:Navbox: see Topic:Vtixlm0q28eo6jtf
m>Izkala
(Add colour tracking per ER)
m (12 revisions imported from wikipedia:Module:Navbox: see Topic:Vtixlm0q28eo6jtf)
 
(34 intermediate revisions by 21 users not shown)
Line 9: Line 9:


local args
local args
local tableRowAdded = false
local border
local border
local listnums = {}
local listnums
local ODD_EVEN_MARKER = '\127_ODDEVEN_\127'
local RESTART_MARKER = '\127_ODDEVEN0_\127'
local REGEX_MARKER = '\127_ODDEVEN(%d?)_\127'


local function trim(s)
local function striped(wikitext)
return (mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1"))
-- Return wikitext with markers replaced for odd/even striping.
end
-- Child (subgroup) navboxes are flagged with a category that is removed
 
-- by parent navboxes. The result is that the category shows all pages
local function addNewline(s)
-- where a child navbox is not contained in a parent navbox.
if s:match('^[*:;#]') or s:match('^{|') then
local orphanCat = '[[Category:Navbox orphans]]'
return '\n' .. s ..'\n'
if border == 'subgroup' and args.orphan ~= 'yes' then
-- No change; striping occurs in outermost navbox.
return wikitext .. orphanCat
end
local first, second = 'odd', 'even'
if args.evenodd then
if args.evenodd == 'swap' then
first, second = second, first
else
first = args.evenodd
second = first
end
end
local changer
if first == second then
changer = first
else
else
return s
local index = 0
changer = function (code)
if code == '0' then
-- Current occurrence is for a group before a nested table.
-- Set it to first as a valid although pointless class.
-- The next occurrence will be the first row after a title
-- in a subgroup and will also be first.
index = 0
return first
end
index = index + 1
return index % 2 == 1 and first or second
end
end
end
local regex = orphanCat:gsub('([%[%]])', '%%%1')
return (wikitext:gsub(regex, ''):gsub(REGEX_MARKER, changer))  -- () omits gsub count
end
end


local function addTableRow(tbl)
local function processItem(item, nowrapitems)
-- If any other rows have already been added, then we add a 2px gutter row.
if item:sub(1, 2) == '{|' then
if tableRowAdded then
-- Applying nowrap to lines in a table does not make sense.
tbl
-- Add newlines to compensate for trim of x in |parm=x in a template.
:tag('tr')
return '\n' .. item ..'\n'
:css('height', '2px')
end
:tag('td')
if nowrapitems == 'yes' then
:attr('colspan',2)
local lines = {}
for line in (item .. '\n'):gmatch('([^\n]*)\n') do
local prefix, content = line:match('^([*:;#]+)%s*(.*)')
if prefix and not content:match('^<span class="nowrap">') then
line = prefix .. '<span class="nowrap">' .. content .. '</span>'
end
table.insert(lines, line)
end
item = table.concat(lines, '\n')
end
if item:match('^[*:;#]') then
return '\n' .. item ..'\n'
end
end
 
return item
tableRowAdded = true
 
return tbl:tag('tr')
end
end


local function renderNavBar(titleCell)
local function renderNavBar(titleCell)
-- Depending on the presence of the navbar and/or show/hide link, we may need to add a spacer div on the left
-- or right to keep the title centered.
local spacerSide = nil
if args.navbar == 'off' then
-- No navbar, and client wants no spacer, i.e. wants the title to be shifted to the left. If there's
-- also no show/hide link, then we need a spacer on the right to achieve the left shift.
if args.state == 'plain' then spacerSide = 'right' end
elseif args.navbar == 'plain' or (not args.name and mw.getCurrentFrame():getParent():getTitle():gsub('/sandbox$', '') == 'Template:Navbox') then
-- No navbar. Need a spacer on the left to balance out the width of the show/hide link.
if args.state ~= 'plain' then spacerSide = 'left' end
else
-- Will render navbar (or error message). If there's no show/hide link, need a spacer on the right
-- to balance out the width of the navbar.
if args.state == 'plain' then spacerSide = 'right' end


if args.navbar ~= 'off' and args.navbar ~= 'plain' and not (not args.name and mw.getCurrentFrame():getParent():getTitle():gsub('/sandbox$', '') == 'Template:Navbox') then
titleCell:wikitext(navbar{
titleCell:wikitext(navbar{
args.name,
args.name,
mini = 1,
mini = 1,
fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;'
fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;box-shadow:none;padding:0;'
})
})
end
end


-- Render the spacer div.
if spacerSide then
titleCell
:tag('span')
:css('float', spacerSide)
:css('width', '6em')
:wikitext('&nbsp;')
end
end
end


Line 80: Line 97:
if not args.title then return end
if not args.title then return end


local titleRow = addTableRow(tbl)
local titleRow = tbl:tag('tr')


if args.titlegroup then
if args.titlegroup then
Line 116: Line 133:


titleCell
titleCell
:tag('div')
:tag('div')
:addClass(args.titleclass)
-- id for aria-labelledby attribute
:css('font-size', '110%')
:attr('id', mw.uri.anchorEncode(args.title))
:wikitext(addNewline(args.title))
:addClass(args.titleclass)
:css('font-size', '114%')
:css('margin', '0 4em')
:wikitext(processItem(args.title))
end
end


Line 136: Line 156:
if not args.above then return end
if not args.above then return end


addTableRow(tbl)
tbl:tag('tr')
:tag('td')
:tag('td')
:addClass('navbox-abovebelow')
:addClass('navbox-abovebelow')
Line 144: Line 164:
:attr('colspan', getAboveBelowColspan())
:attr('colspan', getAboveBelowColspan())
:tag('div')
:tag('div')
:wikitext(addNewline(args.above))
-- id for aria-labelledby attribute, if no title
:attr('id', args.title and nil or mw.uri.anchorEncode(args.above))
:wikitext(processItem(args.above, args.nowrapitems))
end
end


Line 150: Line 172:
if not args.below then return end
if not args.below then return end


addTableRow(tbl)
tbl:tag('tr')
:tag('td')
:tag('td')
:addClass('navbox-abovebelow')
:addClass('navbox-abovebelow')
Line 158: Line 180:
:attr('colspan', getAboveBelowColspan())
:attr('colspan', getAboveBelowColspan())
:tag('div')
:tag('div')
:wikitext(addNewline(args.below))
:wikitext(processItem(args.below, args.nowrapitems))
end
end


Line 164: Line 186:
--  List rows
--  List rows
--
--
local function renderListRow(tbl, listnum)
local function renderListRow(tbl, index, listnum)
local row = addTableRow(tbl)
local row = tbl:tag('tr')


if listnum == 1 and args.imageleft then
if index == 1 and args.imageleft then
row
row
:tag('td')
:tag('td')
:addClass('noviewer')
:addClass('navbox-image')
:addClass('navbox-image')
:addClass(args.imageclass)
:addClass(args.imageclass)
:css('width', '0%')
:css('width', '1px')               -- Minimize width
:css('padding', '0px 2px 0px 0px')
:css('padding', '0px 2px 0px 0px')
:cssText(args.imageleftstyle)
:cssText(args.imageleftstyle)
:attr('rowspan', 2 * #listnums - 1)
:attr('rowspan', #listnums)
:tag('div')
:tag('div')
:wikitext(addNewline(args.imageleft))
:wikitext(processItem(args.imageleft))
end
end


if args['group' .. listnum] then
if args['group' .. listnum] then
local groupCell = row:tag('th')
local groupCell = row:tag('th')
-- id for aria-labelledby attribute, if lone group with no title or above
if listnum == 1 and not (args.title or args.above or args.group2) then
groupCell
:attr('id', mw.uri.anchorEncode(args.group1))
end


groupCell
groupCell
Line 188: Line 217:
:addClass(args.groupclass)
:addClass(args.groupclass)
:cssText(args.basestyle)
:cssText(args.basestyle)
 
:css('width', args.groupwidth or '1%') -- If groupwidth not specified, minimize width
if args.groupwidth then
groupCell:css('width', args.groupwidth)
end


groupCell
groupCell
Line 214: Line 240:
end
end


local isOdd = (listnum % 2) == 1
local rowstyle  -- usually nil so cssText(rowstyle) usually adds nothing
local rowstyle = args.evenstyle
if index % 2 == 1 then
if isOdd then rowstyle = args.oddstyle end
rowstyle = args.oddstyle
 
local evenOdd
if args.evenodd == 'swap' then
if isOdd then evenOdd = 'even' else evenOdd = 'odd' end
else
else
if isOdd then evenOdd = args.evenodd or 'odd' else evenOdd = args.evenodd or 'even' end
rowstyle = args.evenstyle
end
end


local listText = args['list' .. listnum]
local oddEven = ODD_EVEN_MARKER
if listText:sub(1, 12) == '</div><table' then
-- Assume list text is for a subgroup navbox so no automatic striping for this row.
oddEven = listText:find('<th[^>]*"navbox%-title"') and RESTART_MARKER or 'odd'
end
listCell
listCell
:css('padding', '0px')
:css('padding', '0px')
Line 231: Line 259:
:cssText(args['list' .. listnum .. 'style'])
:cssText(args['list' .. listnum .. 'style'])
:addClass('navbox-list')
:addClass('navbox-list')
:addClass('navbox-' .. evenOdd)
:addClass('navbox-' .. oddEven)
:addClass(args.listclass)
:addClass(args.listclass)
:addClass(args['list' .. listnum .. 'class'])
:tag('div')
:tag('div')
:css('padding', (listnum == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
:css('padding', (index == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
:wikitext(addNewline(args['list' .. listnum]))
:wikitext(processItem(listText, args.nowrapitems))


if listnum == 1 and args.image then
if index == 1 and args.image then
row
row
:tag('td')
:tag('td')
:addClass('noviewer')
:addClass('navbox-image')
:addClass('navbox-image')
:addClass(args.imageclass)
:addClass(args.imageclass)
:css('width', '0%')
:css('width', '1px')               -- Minimize width
:css('padding', '0px 0px 0px 2px')
:css('padding', '0px 0px 0px 2px')
:cssText(args.imagestyle)
:cssText(args.imagestyle)
:attr('rowspan', 2 * #listnums - 1)
:attr('rowspan', #listnums)
:tag('div')
:tag('div')
:wikitext(addNewline(args.image))
:wikitext(processItem(args.image))
end
end
end
end
Line 257: Line 287:


local function needsHorizontalLists()
local function needsHorizontalLists()
if border == 'child' or border == 'subgroup' or args.tracking == 'no' then return false end
if border == 'subgroup' or args.tracking == 'no' then
return false
end
local listClasses = {
['plainlist'] = true, ['hlist'] = true, ['hlist hnum'] = true,
['hlist hwrap'] = true, ['hlist vcard'] = true, ['vcard hlist'] = true,
['hlist vevent'] = true,
}
return not (listClasses[args.listclass] or listClasses[args.bodyclass])
end


local listClasses = {'plainlist', 'hlist', 'hlist hnum', 'hlist hwrap', 'hlist vcard', 'vcard hlist', 'hlist vevent'}
local function hasBackgroundColors()
for i, cls in ipairs(listClasses) do
for _, key in ipairs({'titlestyle', 'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
if args.listclass == cls or args.bodyclass == cls then
if tostring(args[key]):find('background', 1, true) then
return false
return true
end
end
end
end
return true
end
end


local function hasBackgroundColors()
local function hasBorders()
return mw.ustring.match(args.titlestyle or '','background') or mw.ustring.match(args.groupstyle or '','background') or mw.ustring.match(args.basestyle or '','background')
for _, key in ipairs({'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
if tostring(args[key]):find('border', 1, true) then
return true
end
end
end
end


Line 277: Line 318:


for key, style in pairs(args) do
for key, style in pairs(args) do
if key:match("style$") then
if tostring(key):match("style$") then
if styleratio { style, "black", "white" } < 4.5 then
if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
return true
return true
end
end
end
end
end
end
return false
return false
end
end
Line 292: Line 332:
if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
if isIllegible() then table.insert(cats, 'Potentially illegible navboxes') end
if isIllegible() then table.insert(cats, 'Potentially illegible navboxes') end
if hasBorders() then table.insert(cats, 'Navboxes using borders') end
return cats
return cats
end
end
Line 301: Line 342:
if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end
if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end


for i, cat in ipairs(getTrackingCategories()) do
for _, cat in ipairs(getTrackingCategories()) do
builder:wikitext('[[Category:' .. cat .. ']]')
builder:wikitext('[[Category:' .. cat .. ']]')
end
end
Line 315: Line 356:


if args.title and (args.state ~= 'plain' and args.state ~= 'off') then
if args.title and (args.state ~= 'plain' and args.state ~= 'off') then
if args.state == 'collapsed' then args.state = 'mw-collapsed' end
tbl
tbl
:addClass('mw-collapsible')
:addClass('mw-collapsible')
-- mw-collapsible doesn't have an "autocollapse" feature, so fall back on collapsed by default for now
:addClass(args.state or 'autocollapse')
:addClass(args.state and 'mw-' .. args.state or 'mw-collapsed')
end
end


tbl:css('border-spacing', 0)
tbl:css('border-spacing', 0)
if border == 'subgroup' or border == 'child' or border == 'none' then
if border == 'subgroup' or border == 'none' then
tbl
tbl
:addClass('navbox-subgroup')
:addClass('navbox-subgroup')
:cssText(args.bodystyle)
:cssText(args.bodystyle)
:cssText(args.style)
:cssText(args.style)
else -- regular navbox - bodystyle and style will be applied to the wrapper table
else -- regular navbox - bodystyle and style will be applied to the wrapper table
tbl
tbl
:addClass('navbox-inner')
:addClass('navbox-inner')
Line 338: Line 379:
renderAboveRow(tbl)
renderAboveRow(tbl)
for i, listnum in ipairs(listnums) do
for i, listnum in ipairs(listnums) do
renderListRow(tbl, listnum)
renderListRow(tbl, i, listnum)
end
end
renderBelowRow(tbl)
renderBelowRow(tbl)
Line 347: Line 388:
function p._navbox(navboxArgs)
function p._navbox(navboxArgs)
args = navboxArgs
args = navboxArgs
listnums = {}


local nowraplist = args.nowraplists and require('Module:Nowrap list')._main
for k, _ in pairs(args) do
for k, v in pairs(args) do
if type(k) == 'string' then
local listnum = string.match(k, '^list(%d+)$')
local listnum = k:match('^list(%d+)$')
if listnum then table.insert(listnums, tonumber(listnum)) end
if listnum then table.insert(listnums, tonumber(listnum)) end
-- preprocess lists in listX, above, and below if nowraplists has been set
if nowraplist and (listnum or string.match(k, '^above') or string.match(k, '^below')) then
args[k] = nowraplist(v)
end
end
end
end
table.sort(listnums)
table.sort(listnums)


border = trim(args.border or args[1] or '')
border = mw.text.trim(args.border or args[1] or '')
if border == 'child' then
border = 'subgroup'
end


-- render the main body of the navbox
-- render the main body of the navbox
Line 367: Line 409:
local res = mw.html.create()
local res = mw.html.create()
if border == 'none' then
if border == 'none' then
res:node(tbl)
local nav = res:tag('div')
elseif border == 'subgroup' or border == 'child' then
:attr('role', 'navigation')
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
if args.title or args.above or (args.group1 and not args.group2) then
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args.above or args.group1))
else
nav:attr('aria-label', 'Navbox')
end
elseif border == 'subgroup' then
-- We assume that this navbox is being rendered in a list cell of a parent navbox, and is
-- We assume that this navbox is being rendered in a list cell of a parent navbox, and is
-- therefore inside a div with padding:0em 0.25em. We start with a </div> to avoid the
-- therefore inside a div with padding:0em 0.25em. We start with a </div> to avoid the
-- padding being applied, and at the end add a <div> to balance out the parent's </div>
-- padding being applied, and at the end add a <div> to balance out the parent's </div>
res
res
:wikitext('</div>') -- XXX: hack due to lack of unclosed support in mw.html.
:wikitext('</div>')
:node(tbl)
:node(tbl)
:wikitext('<div>') -- XXX: hack due to lack of unclosed support in mw.html.
:wikitext('<div>')
else
else
res
local nav = res:tag('div')
:tag('table')
:attr('role', 'navigation')
:addClass('navbox')
:addClass('navbox')
:css('border-spacing', 0)
:addClass(args.navboxclass)
:cssText(args.bodystyle)
:cssText(args.bodystyle)
:cssText(args.style)
:cssText(args.style)
:tag('tr')
:css('padding', '3px')
:tag('td')
:node(tbl)
:css('padding', '2px')
-- aria-labelledby title, otherwise above, otherwise lone group
:node(tbl)
if args.title or args.above or (args.group1 and not args.group2) then
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args.above or args.group1))
else
nav:attr('aria-label', 'Navbox')
end
end
end


renderTrackingCategories(res)
if (args.nocat or 'false'):lower() == 'false' then
 
renderTrackingCategories(res)
return tostring(res)
end
return striped(tostring(res))
end
end


Line 398: Line 453:
getArgs = require('Module:Arguments').getArgs
getArgs = require('Module:Arguments').getArgs
end
end
args = getArgs(frame, {wrappers = 'Template:Navbox'})
args = getArgs(frame, {wrappers = {'Template:Navbox'}})


-- Read the arguments in the order they'll be output in, to make references number in the right order.
-- Read the arguments in the order they'll be output in, to make references number in the right order.