Module:Navbox: Difference between revisions

From LPFM Wiki
Jump to navigation Jump to search
en>Izno
(remove titlegroup per templatestyles section on talk page)
m (1 revision imported)
Line 1: Line 1:
--
-- This module implements {{Navbox}}
--
local p = {}
local p = {}
local navbar = require('Module:Navbar')._navbar
local navbar = require('Module:Navbar')._navbar
local cfg = mw.loadData('Module:Navbox/configuration')
local getArgs -- lazily initialized
local getArgs -- lazily initialized
local args
local args
local format = string.format
local border
local listnums
local ODD_EVEN_MARKER = '\127_ODDEVEN_\127'
local RESTART_MARKER = '\127_ODDEVEN0_\127'
local REGEX_MARKER = '\127_ODDEVEN(%d?)_\127'


local function striped(wikitext, border)
local function striped(wikitext)
-- Return wikitext with markers replaced for odd/even striping.
-- Return wikitext with markers replaced for odd/even striping.
-- Child (subgroup) navboxes are flagged with a category that is removed
-- Child (subgroup) navboxes are flagged with a category that is removed
-- by parent navboxes. The result is that the category shows all pages
-- by parent navboxes. The result is that the category shows all pages
-- where a child navbox is not contained in a parent navbox.
-- where a child navbox is not contained in a parent navbox.
local orphanCat = cfg.category.orphan
local orphanCat = '[[Category:Navbox orphans]]'
if border == cfg.keyword.border_subgroup and args[cfg.arg.orphan] ~= cfg.keyword.orphan_yes then
if border == 'subgroup' and args.orphan ~= 'yes' then
-- No change; striping occurs in outermost navbox.
-- No change; striping occurs in outermost navbox.
return wikitext .. orphanCat
return wikitext .. orphanCat
end
end
local first, second = cfg.class.navbox_odd_part, cfg.class.navbox_even_part
local first, second = 'odd', 'even'
if args[cfg.arg.evenodd] then
if args.evenodd then
if args[cfg.arg.evenodd] == cfg.keyword.evenodd_swap then
if args.evenodd == 'swap' then
first, second = second, first
first, second = second, first
else
else
first = args[cfg.arg.evenodd]
first = args.evenodd
second = first
second = first
end
end
Line 44: Line 53:
end
end
local regex = orphanCat:gsub('([%[%]])', '%%%1')
local regex = orphanCat:gsub('([%[%]])', '%%%1')
return (wikitext:gsub(regex, ''):gsub(cfg.marker.regex, changer)) -- () omits gsub count
return (wikitext:gsub(regex, ''):gsub(REGEX_MARKER, changer)) -- () omits gsub count
end
end


Line 53: Line 62:
return '\n' .. item ..'\n'
return '\n' .. item ..'\n'
end
end
if nowrapitems == cfg.keyword.nowrapitems_yes then
if nowrapitems == 'yes' then
local lines = {}
local lines = {}
for line in (item .. '\n'):gmatch('([^\n]*)\n') do
for line in (item .. '\n'):gmatch('([^\n]*)\n') do
local prefix, content = line:match('^([*:;#]+)%s*(.*)')
local prefix, content = line:match('^([*:;#]+)%s*(.*)')
if prefix and not content:match(cfg.pattern.nowrap) then
if prefix and not content:match('^<span class="nowrap">') then
line = format(cfg.nowrap_item, prefix, content)
line = prefix .. '<span class="nowrap">' .. content .. '</span>'
end
end
table.insert(lines, line)
table.insert(lines, line)
Line 70: Line 79:
end
end


-- we will want this later when we want to add tstyles for hlist/plainlist
-- Separate function so that we can evaluate properly whether hlist should
-- be added by the module
local function has_navbar()
local function has_navbar()
return args[cfg.arg.navbar] ~= cfg.keyword.navbar_off
return args.navbar ~= 'off' and args.navbar ~= 'plain' and
and args[cfg.arg.navbar] ~= cfg.keyword.navbar_plain
(args.name or mw.getCurrentFrame():getParent():getTitle():gsub('/sandbox$', '') ~= 'Template:Navbox')
and (
args[cfg.arg.name]
or mw.getCurrentFrame():getParent():getTitle():gsub(cfg.pattern.sandbox, '')
~= cfg.pattern.navbox
)
end
end


local function renderNavBar(titleCell)
local function renderNavBar(titleCell)
if has_navbar() then
if has_navbar() then
titleCell:wikitext(navbar{
titleCell:wikitext(navbar{
[cfg.navbar.name] = args[cfg.arg.name],
args.name,
[cfg.navbar.mini] = 1,
-- we depend on this being mini = 1 when the navbox module decides
[cfg.navbar.fontstyle] = (args[cfg.arg.basestyle] or '') .. ';' ..
-- to add hlist templatestyles. we also depend on navbar outputting
(args[cfg.arg.titlestyle] or '') ..
-- a copy of the hlist templatestyles.
';background:none transparent;border:none;box-shadow:none;padding:0;'
mini = 1,
fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;box-shadow:none; padding:0;'
})
})
end
end
Line 94: Line 101:
end
end


--
--  Title row
--
local function renderTitleRow(tbl)
local function renderTitleRow(tbl)
if not args[cfg.arg.title] then return end
if not args.title then return end


local titleRow = tbl:tag('tr')
local titleRow = tbl:tag('tr')
if args.titlegroup then
titleRow
:tag('th')
:attr('scope', 'row')
:addClass('navbox-group')
:addClass(args.titlegroupclass)
:cssText(args.basestyle)
:cssText(args.groupstyle)
:cssText(args.titlegroupstyle)
:wikitext(args.titlegroup)
end


local titleCell = titleRow:tag('th'):attr('scope', 'col')
local titleCell = titleRow:tag('th'):attr('scope', 'col')
if args.titlegroup then
titleCell
:addClass('navbox-title1')
end


local titleColspan = 2
local titleColspan = 2
if args[cfg.arg.imageleft] then titleColspan = titleColspan + 1 end
if args.imageleft then titleColspan = titleColspan + 1 end
if args[cfg.arg.image] then titleColspan = titleColspan + 1 end
if args.image then titleColspan = titleColspan + 1 end
if args.titlegroup then titleColspan = titleColspan - 1 end


titleCell
titleCell
:cssText(args[cfg.arg.basestyle])
:cssText(args.basestyle)
:cssText(args[cfg.arg.titlestyle])
:cssText(args.titlestyle)
:addClass(cfg.class.navbox_title)
:addClass('navbox-title')
:attr('colspan', titleColspan)
:attr('colspan', titleColspan)


Line 116: Line 144:
:tag('div')
:tag('div')
-- id for aria-labelledby attribute
-- id for aria-labelledby attribute
:attr('id', mw.uri.anchorEncode(args[cfg.arg.title]))
:attr('id', mw.uri.anchorEncode(args.title))
:addClass(args[cfg.arg.titleclass])
:addClass(args.titleclass)
:css('font-size', '114%')
:css('font-size', '114%')
:css('margin', '0 4em')
:css('margin', '0 4em')
:wikitext(processItem(args[cfg.arg.title]))
:wikitext(processItem(args.title))
end
end
--
--  Above/Below rows
--


local function getAboveBelowColspan()
local function getAboveBelowColspan()
local ret = 2
local ret = 2
if args[cfg.arg.imageleft] then ret = ret + 1 end
if args.imageleft then ret = ret + 1 end
if args[cfg.arg.image] then ret = ret + 1 end
if args.image then ret = ret + 1 end
return ret
return ret
end
end


local function renderAboveRow(tbl)
local function renderAboveRow(tbl)
if not args[cfg.arg.above] then return end
if not args.above then return end


tbl:tag('tr')
tbl:tag('tr')
:tag('td')
:tag('td')
:addClass(cfg.class.navbox_abovebelow)
:addClass('navbox-abovebelow')
:addClass(args[cfg.arg.aboveclass])
:addClass(args.aboveclass)
:cssText(args[cfg.arg.basestyle])
:cssText(args.basestyle)
:cssText(args[cfg.arg.abovestyle])
:cssText(args.abovestyle)
:attr('colspan', getAboveBelowColspan())
:attr('colspan', getAboveBelowColspan())
:tag('div')
:tag('div')
-- id for aria-labelledby attribute, if no title
-- id for aria-labelledby attribute, if no title
:attr('id', args[cfg.arg.title] and nil or mw.uri.anchorEncode(args[cfg.arg.above]))
:attr('id', args.title and nil or mw.uri.anchorEncode(args.above))
:wikitext(processItem(args[cfg.arg.above], args[cfg.arg.nowrapitems]))
:wikitext(processItem(args.above, args.nowrapitems))
end
end


local function renderBelowRow(tbl)
local function renderBelowRow(tbl)
if not args[cfg.arg.below] then return end
if not args.below then return end


tbl:tag('tr')
tbl:tag('tr')
:tag('td')
:tag('td')
:addClass(cfg.class.navbox_abovebelow)
:addClass('navbox-abovebelow')
:addClass(args[cfg.arg.belowclass])
:addClass(args.belowclass)
:cssText(args[cfg.arg.basestyle])
:cssText(args.basestyle)
:cssText(args[cfg.arg.belowstyle])
:cssText(args.belowstyle)
:attr('colspan', getAboveBelowColspan())
:attr('colspan', getAboveBelowColspan())
:tag('div')
:tag('div')
:wikitext(processItem(args[cfg.arg.below], args[cfg.arg.nowrapitems]))
:wikitext(processItem(args.below, args.nowrapitems))
end
end


local function renderListRow(tbl, index, listnum, listnums_size)
--
--  List rows
--
local function renderListRow(tbl, index, listnum)
local row = tbl:tag('tr')
local row = tbl:tag('tr')


if index == 1 and args[cfg.arg.imageleft] then
if index == 1 and args.imageleft then
row
row
:tag('td')
:tag('td')
:addClass(cfg.class.noviewer)
:addClass('navbox-image')
:addClass(cfg.class.navbox_image)
:addClass(args.imageclass)
:addClass(args[cfg.arg.imageclass])
:css('width', '1px')              -- Minimize width
:css('width', '1px')              -- Minimize width
:css('padding', '0 2px 0 0')
:css('padding', '0px 2px 0px 0px')
:cssText(args[cfg.arg.imageleftstyle])
:cssText(args.imageleftstyle)
:attr('rowspan', listnums_size)
:attr('rowspan', #listnums)
:tag('div')
:tag('div')
:wikitext(processItem(args[cfg.arg.imageleft]))
:wikitext(processItem(args.imageleft))
end
end


local group_and_num = format(cfg.arg.group_and_num, listnum)
if args['group' .. listnum] then
local groupstyle_and_num = format(cfg.arg.groupstyle_and_num, listnum)
if args[group_and_num] then
local groupCell = row:tag('th')
local groupCell = row:tag('th')


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


groupCell
groupCell
:attr('scope', 'row')
:attr('scope', 'row')
:addClass(cfg.class.navbox_group)
:addClass('navbox-group')
:addClass(args[cfg.arg.groupclass])
:addClass(args.groupclass)
:cssText(args[cfg.arg.basestyle])
:cssText(args.basestyle)
-- If groupwidth not specified, minimize width
:css('width', args.groupwidth or '1%') -- If groupwidth not specified, minimize width
:css('width', args[cfg.arg.groupwidth] or '1%')


groupCell
groupCell
:cssText(args[cfg.arg.groupstyle])
:cssText(args.groupstyle)
:cssText(args[groupstyle_and_num])
:cssText(args['group' .. listnum .. 'style'])
:wikitext(args[group_and_num])
:wikitext(args['group' .. listnum])
end
end


local listCell = row:tag('td')
local listCell = row:tag('td')


if args[group_and_num] then
if args['group' .. listnum] then
listCell
listCell
:addClass(cfg.class.navbox_list_with_group)
:addClass('navbox-list1')
else
else
listCell:attr('colspan', 2)
listCell:attr('colspan', 2)
end
end


if not args[cfg.arg.groupwidth] then
if not args.groupwidth then
listCell:css('width', '100%')
listCell:css('width', '100%')
end
end
Line 217: Line 248:
local rowstyle  -- usually nil so cssText(rowstyle) usually adds nothing
local rowstyle  -- usually nil so cssText(rowstyle) usually adds nothing
if index % 2 == 1 then
if index % 2 == 1 then
rowstyle = args[cfg.arg.oddstyle]
rowstyle = args.oddstyle
else
else
rowstyle = args[cfg.arg.evenstyle]
rowstyle = args.evenstyle
end
end


local list_and_num = format(cfg.arg.list_and_num, listnum)
local listText = args['list' .. listnum]
local listText = args[list_and_num]
local oddEven = ODD_EVEN_MARKER
local oddEven = cfg.marker.oddeven
if listText:sub(1, 12) == '</div><table' then
if listText:sub(1, 12) == '</div><table' then
-- Assume list text is for a subgroup navbox so no automatic striping for this row.
-- Assume list text is for a subgroup navbox so no automatic striping for this row.
oddEven = listText:find(cfg.pattern.navbox_title) and cfg.marker.restart or cfg.class.navbox_odd_part
oddEven = listText:find('<th[^>]*"navbox%-title"') and RESTART_MARKER or 'odd'
end
end
local liststyle_and_num = format(cfg.arg.liststyle_and_num, listnum)
local listclass_and_num = format(cfg.arg.listclass_and_num, listnum)
listCell
listCell
:css('padding', '0')
:css('padding', '0px')
:cssText(args[cfg.arg.liststyle])
:cssText(args.liststyle)
:cssText(rowstyle)
:cssText(rowstyle)
:cssText(args[liststyle_and_num])
:cssText(args['list' .. listnum .. 'style'])
:addClass(cfg.class.navbox_list)
:addClass('navbox-list')
:addClass(cfg.class.navbox_part .. oddEven)
:addClass('navbox-' .. oddEven)
:addClass(args[cfg.arg.listclass])
:addClass(args.listclass)
:addClass(args[listclass_and_num])
:addClass(args['list' .. listnum .. 'class'])
:tag('div')
:tag('div')
:css('padding',
:css('padding', (index == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
(index == 1 and args[cfg.arg.list1padding]) or args[cfg.arg.listpadding] or '0 0.25em'
:wikitext(processItem(listText, args.nowrapitems))
)
:wikitext(processItem(listText, args[cfg.arg.nowrapitems]))


if index == 1 and args[cfg.arg.image] then
if index == 1 and args.image then
row
row
:tag('td')
:tag('td')
:addClass(cfg.class.noviewer)
:addClass('navbox-image')
:addClass(cfg.class.navbox_image)
:addClass(args.imageclass)
:addClass(args[cfg.arg.imageclass])
:css('width', '1px')              -- Minimize width
:css('width', '1px')              -- Minimize width
:css('padding', '0 0 0 2px')
:css('padding', '0px 0px 0px 2px')
:cssText(args[cfg.arg.imagestyle])
:cssText(args.imagestyle)
:attr('rowspan', listnums_size)
:attr('rowspan', #listnums)
:tag('div')
:tag('div')
:wikitext(processItem(args[cfg.arg.image]))
:wikitext(processItem(args.image))
end
end
end
end


-- uses this now to make the needHlistCategory correct
 
-- to use later for when we add list styles via navbox
--
local function has_list_class(htmlclass)
--   Tracking categories
local class_args = { -- rough order of probability of use
--
cfg.arg.bodyclass, cfg.arg.listclass, cfg.arg.aboveclass,
 
cfg.arg.belowclass, cfg.arg.titleclass, cfg.arg.navboxclass,
local function needsHorizontalLists()
cfg.arg.groupclass, cfg.arg.imageclass
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,
}
}
local patterns = {
return not (listClasses[args.listclass] or listClasses[args.bodyclass])
'^' .. htmlclass .. '$',
end
'%s' .. htmlclass .. '$',
 
'^' .. htmlclass .. '%s',
-- there are a lot of list classes in the wild, so we have a function to find
'%s' .. htmlclass .. '%s'
-- them and add their TemplateStyles
}
local function addListStyles()
local frame = mw.getCurrentFrame()
for _, arg in ipairs(class_args) do
-- TODO?: Should maybe take a table of classes for e.g. hnum, hwrap as above
for _, pattern in ipairs(patterns) do
-- I'm going to do the stupid thing first though
if mw.ustring.find(args[arg] or '', pattern) then
-- Also not sure hnum and hwrap are going to live in the same TemplateStyles
return true
-- as hlist
local function _addListStyles(htmlclass, templatestyles)
local class_args = { -- rough order of probability of use
'bodyclass', 'listclass', 'aboveclass', 'belowclass', 'titleclass',
'navboxclass', 'groupclass', 'titlegroupclass', 'imageclass'
}
local patterns = {
'^' .. htmlclass .. '$',
'%s' .. htmlclass .. '$',
'^' .. htmlclass .. '%s',
'%s' .. htmlclass .. '%s'
}
local found = false
for _, arg in ipairs(class_args) do
for _, pattern in ipairs(patterns) do
if mw.ustring.find(args[arg] or '', pattern) then
found = true
break
end
end
end
if found then break end
end
if found then
return frame:extensionTag{
name = 'templatestyles', args = { src = templatestyles }
}
else
return ''
end
end
end
end
return false
end
local hlist_styles = ''
 
-- navbar always has mini = 1, so here (on this wiki) we can assume that
local function needsHorizontalLists(border)
-- we don't need to output hlist styles in navbox again.
if border == cfg.keyword.border_subgroup or args[cfg.arg.tracking] == cfg.keyword.tracking_no then
if not has_navbar() then
return false
hlist_styles = _addListStyles('hlist', 'Flatlist/styles.css')
end
end
return not has_list_class(cfg.pattern.hlist) and not has_list_class(cfg.pattern.plainlist)
local plainlist_styles = _addListStyles('plainlist', 'Plainlist/styles.css')
return hlist_styles .. plainlist_styles
end
end


local function hasBackgroundColors()
local function hasBackgroundColors()
for _, key in ipairs({cfg.arg.titlestyle, cfg.arg.groupstyle,
for _, key in ipairs({'titlestyle', 'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
cfg.arg.basestyle, cfg.arg.abovestyle, cfg.arg.belowstyle}) do
if tostring(args[key]):find('background', 1, true) then
if tostring(args[key]):find('background', 1, true) then
return true
return true
end
end
end
end
return false
end
end


local function hasBorders()
local function hasBorders()
for _, key in ipairs({cfg.arg.groupstyle, cfg.arg.basestyle,
for _, key in ipairs({'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
cfg.arg.abovestyle, cfg.arg.belowstyle}) do
if tostring(args[key]):find('border', 1, true) then
if tostring(args[key]):find('border', 1, true) then
return true
return true
end
end
end
end
return false
end
end


local function isIllegible()
local function isIllegible()
local styleratio = require('Module:Color contrast')._styleratio
-- require('Module:Color contrast') absent on mediawiki.org
for key, style in pairs(args) do
if tostring(key):match(cfg.pattern.style) then
if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
return true
end
end
end
return false
return false
end
end


local function getTrackingCategories(border)
local function getTrackingCategories()
local cats = {}
local cats = {}
if needsHorizontalLists(border) then table.insert(cats, cfg.category.horizontal_lists) end
if needsHorizontalLists() then table.insert(cats, 'Navigational boxes without horizontal lists') end
if hasBackgroundColors() then table.insert(cats, cfg.category.background_colors) end
if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
if isIllegible() then table.insert(cats, cfg.category.illegible) end
if isIllegible() then table.insert(cats, 'Potentially illegible navboxes') end
if hasBorders() then table.insert(cats, cfg.category.borders) end
if hasBorders() then table.insert(cats, 'Navboxes using borders') end
return cats
return cats
end
end


local function renderTrackingCategories(builder, border)
local function renderTrackingCategories(builder)
local title = mw.title.getCurrentTitle()
local title = mw.title.getCurrentTitle()
if title.namespace ~= 10 then return end -- not in template space
if title.namespace ~= 10 then return end -- not in template space
local subpage = title.subpageText
local subpage = title.subpageText
if subpage == cfg.keyword.subpage_doc or subpage == cfg.keyword.subpage_sandbox
if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end
or subpage == cfg.keyword.subpage_testcases then return end


for _, cat in ipairs(getTrackingCategories(border)) do
for _, cat in ipairs(getTrackingCategories()) do
builder:wikitext('[[Category:' .. cat .. ']]')
builder:wikitext('[[Category:' .. cat .. ']]')
end
end
end
end


local function renderMainTable(border, listnums)
--
--  Main navbox tables
--
local function renderMainTable()
local tbl = mw.html.create('table')
local tbl = mw.html.create('table')
:addClass(cfg.class.nowraplinks)
:addClass('nowraplinks')
:addClass(args[cfg.arg.bodyclass])
:addClass(args.bodyclass)


local state = args[cfg.arg.state]
if args.title and (args.state ~= 'plain' and args.state ~= 'off') then
if args[cfg.arg.title] and state ~= cfg.keyword.state_plain and state ~= cfg.keyword.state_off then
if args.state == 'collapsed' then args.state = 'mw-collapsed' end
if state == cfg.keyword.state_collapsed then
state = cfg.class.collapsed
end
tbl
tbl
:addClass(cfg.class.collapsible)
:addClass('mw-collapsible')
:addClass(state or cfg.class.autocollapse)
:addClass(args.state or 'autocollapse')
end
end


tbl:css('border-spacing', 0)
tbl:css('border-spacing', 0)
if border == cfg.keyword.border_subgroup or border == cfg.keyword.border_none then
if border == 'subgroup' or border == 'none' then
tbl
tbl
:addClass(cfg.class.navbox_subgroup)
:addClass('navbox-subgroup')
:cssText(args[cfg.arg.bodystyle])
:cssText(args.bodystyle)
:cssText(args[cfg.arg.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(cfg.class.navbox_inner)
:addClass('navbox-inner')
:css('background', 'transparent')
:css('background', 'transparent')
:css('color', 'inherit')
:css('color', 'inherit')
end
end
tbl:cssText(args[cfg.arg.innerstyle])
tbl:cssText(args.innerstyle)


renderTitleRow(tbl)
renderTitleRow(tbl)
renderAboveRow(tbl)
renderAboveRow(tbl)
local listnums_size = #listnums
for i, listnum in ipairs(listnums) do
for i, listnum in ipairs(listnums) do
renderListRow(tbl, i, listnum, listnums_size)
renderListRow(tbl, i, listnum)
end
end
renderBelowRow(tbl)
renderBelowRow(tbl)


return tbl
return tbl
end
local function add_navbox_styles()
local frame = mw.getCurrentFrame()
-- This is a lambda so that it doesn't need the frame as a parameter
local function add_user_styles(templatestyles)
if templatestyles and templatestyles ~= '' then
return frame:extensionTag{
name = 'templatestyles', args = { src = templatestyles }
}
end
return ''
end
-- get templatestyles. load base from config so that Lua only needs to do
-- the work once of parser tag expansion
local base_templatestyles = cfg.templatestyles
local templatestyles = add_user_styles(args[cfg.arg.templatestyles])
local child_templatestyles = add_user_styles(args[cfg.arg.child_templatestyles])
-- The 'navbox-styles' div exists for two reasons:
--  1. To wrap the styles to work around T200206 more elegantly. Instead
--    of combinatorial rules, this ends up being linear number of CSS rules.
--  2. To allow MobileFrontend to rip the styles out with 'nomobile' such that
--    they are not dumped into the mobile view.
return mw.html.create('div')
:addClass(cfg.class.navbox_styles)
:addClass(cfg.class.nomobile)
:wikitext(base_templatestyles .. templatestyles .. child_templatestyles)
:done()
end
end


function p._navbox(navboxArgs)
function p._navbox(navboxArgs)
args = navboxArgs
args = navboxArgs
local listnums = {}
listnums = {}


for k, _ in pairs(args) do
for k, _ in pairs(args) do
if type(k) == 'string' then
if type(k) == 'string' then
local listnum = k:match(cfg.pattern.listnum)
local listnum = k:match('^list(%d+)$')
if listnum then table.insert(listnums, tonumber(listnum)) end
if listnum then table.insert(listnums, tonumber(listnum)) end
end
end
Line 429: Line 445:
table.sort(listnums)
table.sort(listnums)


local border = mw.text.trim(args[cfg.arg.border] or args[1] or '')
border = mw.text.trim(args.border or args[1] or '')
if border == cfg.keyword.border_child then
if border == 'child' then
border = cfg.keyword.border_subgroup
border = 'subgroup'
end
end


-- render the main body of the navbox
-- render the main body of the navbox
local tbl = renderMainTable(border, listnums)
local tbl = renderMainTable()
 
-- get templatestyles
local frame = mw.getCurrentFrame()
local base_templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = 'Module:Navbox/styles.css' }
}
local templatestyles = ''
if args.templatestyles and args.templatestyles ~= '' then
templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = args.templatestyles }
}
end
local res = mw.html.create()
local res = mw.html.create()
-- render the appropriate wrapper for the navbox, based on the border param
-- 'navbox-styles' exists for two reasons:
 
--  1. To wrap the styles to work around phab: T200206 more elegantly. Instead
if border == cfg.keyword.border_none then
--   of combinatorial rules, this ends up being linear number of CSS rules.
res:node(add_navbox_styles())
--  2. To allow MobileFrontend to rip the styles out with 'nomobile' such that
--    they are not dumped into the mobile view.
res:tag('div')
:addClass('navbox-styles')
:addClass('nomobile')
:wikitext(base_templatestyles .. templatestyles)
:done()
-- render the appropriate wrapper around the navbox, depending on the border param
if border == 'none' then
local nav = res:tag('div')
local nav = res:tag('div')
:attr('role', 'navigation')
:attr('role', 'navigation')
:wikitext(addListStyles())
:node(tbl)
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
-- aria-labelledby title, otherwise above, otherwise lone group
if args[cfg.arg.title] or args[cfg.arg.above] or (args[cfg.arg.group1]
if args.title or args.above or (args.group1 and not args.group2) then
and not args[cfg.arg.group2]) then
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args.above or args.group1))
nav:attr(
'aria-labelledby',
mw.uri.anchorEncode(
args[cfg.arg.title] or args[cfg.arg.above] or args[cfg.arg.group1]
)
)
else
else
nav:attr('aria-label', cfg.aria_label)
nav:attr('aria-label', 'Navbox')
end
end
elseif border == cfg.keyword.border_subgroup then
elseif border == 'subgroup' then
-- We assume that this navbox is being rendered in a list cell of a
-- 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.
-- parent navbox, and is therefore inside a div with padding:0em 0.25em.
Line 464: Line 496:
res
res
:wikitext('</div>')
:wikitext('</div>')
:wikitext(addListStyles())
:node(tbl)
:node(tbl)
:wikitext('<div>')
:wikitext('<div>')
else
else
res:node(add_navbox_styles())
local nav = res:tag('div')
local nav = res:tag('div')
:attr('role', 'navigation')
:attr('role', 'navigation')
:addClass(cfg.class.navbox)
:addClass('navbox')
:addClass(args[cfg.arg.navboxclass])
:addClass(args.navboxclass)
:cssText(args[cfg.arg.bodystyle])
:cssText(args.bodystyle)
:cssText(args[cfg.arg.style])
:cssText(args.style)
:css('padding', '3px')
:css('padding', '3px')
:wikitext(addListStyles())
:node(tbl)
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
-- aria-labelledby title, otherwise above, otherwise lone group
if args[cfg.arg.title] or args[cfg.arg.above]
if args.title or args.above or (args.group1 and not args.group2) then
or (args[cfg.arg.group1] and not args[cfg.arg.group2]) then
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args.above or args.group1))
nav:attr(
'aria-labelledby',
mw.uri.anchorEncode(args[cfg.arg.title] or args[cfg.arg.above] or args[cfg.arg.group1])
)
else
else
nav:attr('aria-label', cfg.aria_label)
nav:attr('aria-label', 'Navbox')
end
end
end
end


if (args[cfg.arg.nocat] or cfg.keyword.nocat_false):lower() == cfg.keyword.nocat_false then
if (args.nocat or 'false'):lower() == 'false' then
renderTrackingCategories(res, border)
renderTrackingCategories(res)
end
end
return striped(tostring(res), border)
 
return striped(tostring(res))
end
end


Line 498: Line 528:
getArgs = require('Module:Arguments').getArgs
getArgs = require('Module:Arguments').getArgs
end
end
args = getArgs(frame, {wrappers = {cfg.pattern.navbox}})
args = getArgs(frame, {wrappers = {'Template:Navbox', 'Template:Navbox subgroup'}})
if frame.args.border then
-- This allows Template:Navbox_subgroup to use {{#invoke:Navbox|navbox|border=...}}.
args.border = frame.args.border
end


-- Read the arguments in the order they'll be output in, to make references
-- Read the arguments in the order they'll be output in, to make references number in the right order.
-- number in the right order.
local _
local _
_ = args[cfg.arg.title]
_ = args.title
_ = args[cfg.arg.above]
_ = args.above
-- Limit this to 20 as covering 'most' cases (that's a SWAG) and because
-- iterator approach won't work here
for i = 1, 20 do
for i = 1, 20 do
_ = args[format(cfg.arg.group_and_num, i)]
_ = args["group" .. tostring(i)]
_ = args[format(cfg.arg.list_and_num, i)]
_ = args["list" .. tostring(i)]
end
end
_ = args[cfg.arg.below]
_ = args.below


return p._navbox(args)
return p._navbox(args)

Revision as of 12:27, 28 July 2022

See Template:Navbox


--
-- This module implements {{Navbox}}
--

local p = {}

local navbar = require('Module:Navbar')._navbar
local getArgs -- lazily initialized

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

local function striped(wikitext)
	-- Return wikitext with markers replaced for odd/even striping.
	-- Child (subgroup) navboxes are flagged with a category that is removed
	-- by parent navboxes. The result is that the category shows all pages
	-- where a child navbox is not contained in a parent navbox.
	local orphanCat = '[[Category:Navbox orphans]]'
	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
		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
	local regex = orphanCat:gsub('([%[%]])', '%%%1')
	return (wikitext:gsub(regex, ''):gsub(REGEX_MARKER, changer))  -- () omits gsub count
end

local function processItem(item, nowrapitems)
	if item:sub(1, 2) == '{|' then
		-- Applying nowrap to lines in a table does not make sense.
		-- Add newlines to compensate for trim of x in |parm=x in a template.
		return '\n' .. item ..'\n'
	end
	if nowrapitems == 'yes' then
		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
	return item
end

-- Separate function so that we can evaluate properly whether hlist should
-- be added by the module
local function has_navbar()
	return args.navbar ~= 'off' and args.navbar ~= 'plain' and
		(args.name or mw.getCurrentFrame():getParent():getTitle():gsub('/sandbox$', '') ~= 'Template:Navbox')
end

local function renderNavBar(titleCell)

	if has_navbar() then
		titleCell:wikitext(navbar{
			args.name,
			-- we depend on this being mini = 1 when the navbox module decides
			-- to add hlist templatestyles. we also depend on navbar outputting
			-- a copy of the hlist templatestyles.
			mini = 1,
			fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;box-shadow:none; padding:0;'
		})
	end

end

--
--   Title row
--
local function renderTitleRow(tbl)
	if not args.title then return end

	local titleRow = tbl:tag('tr')

	if args.titlegroup then
		titleRow
			:tag('th')
				:attr('scope', 'row')
				:addClass('navbox-group')
				:addClass(args.titlegroupclass)
				:cssText(args.basestyle)
				:cssText(args.groupstyle)
				:cssText(args.titlegroupstyle)
				:wikitext(args.titlegroup)
	end

	local titleCell = titleRow:tag('th'):attr('scope', 'col')

	if args.titlegroup then
		titleCell
			:addClass('navbox-title1')
	end

	local titleColspan = 2
	if args.imageleft then titleColspan = titleColspan + 1 end
	if args.image then titleColspan = titleColspan + 1 end
	if args.titlegroup then titleColspan = titleColspan - 1 end

	titleCell
		:cssText(args.basestyle)
		:cssText(args.titlestyle)
		:addClass('navbox-title')
		:attr('colspan', titleColspan)

	renderNavBar(titleCell)

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

--
--   Above/Below rows
--

local function getAboveBelowColspan()
	local ret = 2
	if args.imageleft then ret = ret + 1 end
	if args.image then ret = ret + 1 end
	return ret
end

local function renderAboveRow(tbl)
	if not args.above then return end

	tbl:tag('tr')
		:tag('td')
			:addClass('navbox-abovebelow')
			:addClass(args.aboveclass)
			:cssText(args.basestyle)
			:cssText(args.abovestyle)
			:attr('colspan', getAboveBelowColspan())
			:tag('div')
				-- 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

local function renderBelowRow(tbl)
	if not args.below then return end

	tbl:tag('tr')
		:tag('td')
			:addClass('navbox-abovebelow')
			:addClass(args.belowclass)
			:cssText(args.basestyle)
			:cssText(args.belowstyle)
			:attr('colspan', getAboveBelowColspan())
			:tag('div')
				:wikitext(processItem(args.below, args.nowrapitems))
end

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

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

	if args['group' .. listnum] then
		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
			:attr('scope', 'row')
			:addClass('navbox-group')
			:addClass(args.groupclass)
			:cssText(args.basestyle)
			:css('width', args.groupwidth or '1%') -- If groupwidth not specified, minimize width

		groupCell
			:cssText(args.groupstyle)
			:cssText(args['group' .. listnum .. 'style'])
			:wikitext(args['group' .. listnum])
	end

	local listCell = row:tag('td')

	if args['group' .. listnum] then
		listCell
			:addClass('navbox-list1')
	else
		listCell:attr('colspan', 2)
	end

	if not args.groupwidth then
		listCell:css('width', '100%')
	end

	local rowstyle  -- usually nil so cssText(rowstyle) usually adds nothing
	if index % 2 == 1 then
		rowstyle = args.oddstyle
	else
		rowstyle = args.evenstyle
	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
		:css('padding', '0px')
		:cssText(args.liststyle)
		:cssText(rowstyle)
		:cssText(args['list' .. listnum .. 'style'])
		:addClass('navbox-list')
		:addClass('navbox-' .. oddEven)
		:addClass(args.listclass)
		:addClass(args['list' .. listnum .. 'class'])
		:tag('div')
			:css('padding', (index == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
			:wikitext(processItem(listText, args.nowrapitems))

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


--
--   Tracking categories
--

local function needsHorizontalLists()
	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

-- there are a lot of list classes in the wild, so we have a function to find
-- them and add their TemplateStyles
local function addListStyles()
	local frame = mw.getCurrentFrame()
	-- TODO?: Should maybe take a table of classes for e.g. hnum, hwrap as above
	-- I'm going to do the stupid thing first though
	-- Also not sure hnum and hwrap are going to live in the same TemplateStyles
	-- as hlist
	local function _addListStyles(htmlclass, templatestyles)
		local class_args = { -- rough order of probability of use
			'bodyclass', 'listclass', 'aboveclass', 'belowclass', 'titleclass',
			'navboxclass', 'groupclass', 'titlegroupclass', 'imageclass'
		}
		local patterns = {
			'^' .. htmlclass .. '$',
			'%s' .. htmlclass .. '$',
			'^' .. htmlclass .. '%s',
			'%s' .. htmlclass .. '%s'
		}
		
		local found = false
		for _, arg in ipairs(class_args) do
			for _, pattern in ipairs(patterns) do
				if mw.ustring.find(args[arg] or '', pattern) then
					found = true
					break
				end
			end
			if found then break end
		end
		if found then
			return frame:extensionTag{
				name = 'templatestyles', args = { src = templatestyles }
			}
		else
			return ''
		end
	end
	
	local hlist_styles = ''
	-- navbar always has mini = 1, so here (on this wiki) we can assume that
	-- we don't need to output hlist styles in navbox again.
	if not has_navbar() then
		hlist_styles = _addListStyles('hlist', 'Flatlist/styles.css')
	end
	local plainlist_styles = _addListStyles('plainlist', 'Plainlist/styles.css')
	
	return hlist_styles .. plainlist_styles
end

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

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

local function isIllegible()
	-- require('Module:Color contrast') absent on mediawiki.org
	return false
end

local function getTrackingCategories()
	local cats = {}
	if needsHorizontalLists() then table.insert(cats, 'Navigational boxes without horizontal lists') end
	if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
	if isIllegible() then table.insert(cats, 'Potentially illegible navboxes') end
	if hasBorders() then table.insert(cats, 'Navboxes using borders') end
	return cats
end

local function renderTrackingCategories(builder)
	local title = mw.title.getCurrentTitle()
	if title.namespace ~= 10 then return end -- not in template space
	local subpage = title.subpageText
	if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end

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

--
--   Main navbox tables
--
local function renderMainTable()
	local tbl = mw.html.create('table')
		:addClass('nowraplinks')
		:addClass(args.bodyclass)

	if args.title and (args.state ~= 'plain' and args.state ~= 'off') then
		if args.state == 'collapsed' then args.state = 'mw-collapsed' end
		tbl
			:addClass('mw-collapsible')
			:addClass(args.state or 'autocollapse')
	end

	tbl:css('border-spacing', 0)
	if border == 'subgroup' or border == 'none' then
		tbl
			:addClass('navbox-subgroup')
			:cssText(args.bodystyle)
			:cssText(args.style)
	else  -- regular navbox - bodystyle and style will be applied to the wrapper table
		tbl
			:addClass('navbox-inner')
			:css('background', 'transparent')
			:css('color', 'inherit')
	end
	tbl:cssText(args.innerstyle)

	renderTitleRow(tbl)
	renderAboveRow(tbl)
	for i, listnum in ipairs(listnums) do
		renderListRow(tbl, i, listnum)
	end
	renderBelowRow(tbl)

	return tbl
end

function p._navbox(navboxArgs)
	args = navboxArgs
	listnums = {}

	for k, _ in pairs(args) do
		if type(k) == 'string' then
			local listnum = k:match('^list(%d+)$')
			if listnum then table.insert(listnums, tonumber(listnum)) end
		end
	end
	table.sort(listnums)

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

	-- render the main body of the navbox
	local tbl = renderMainTable()
	
	-- get templatestyles
	local frame = mw.getCurrentFrame()
	local base_templatestyles = frame:extensionTag{
		name = 'templatestyles', args = { src = 'Module:Navbox/styles.css' }
	}
	local templatestyles = ''
	if args.templatestyles and args.templatestyles ~= '' then
		templatestyles = frame:extensionTag{
			name = 'templatestyles', args = { src = args.templatestyles }
		}
	end
	
	local res = mw.html.create()
	-- 'navbox-styles' exists for two reasons:
	--  1. To wrap the styles to work around phab: T200206 more elegantly. Instead
	--	   of combinatorial rules, this ends up being linear number of CSS rules.
	--  2. To allow MobileFrontend to rip the styles out with 'nomobile' such that
	--     they are not dumped into the mobile view.
	res:tag('div')
		:addClass('navbox-styles')
		:addClass('nomobile')
		:wikitext(base_templatestyles .. templatestyles)
		:done()
	
	-- render the appropriate wrapper around the navbox, depending on the border param
	if border == 'none' then
		local nav = res:tag('div')
			:attr('role', 'navigation')
			:wikitext(addListStyles())
			: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 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>
		res
			:wikitext('</div>')
			:wikitext(addListStyles())
			:node(tbl)
			:wikitext('<div>')
	else
		local nav = res:tag('div')
			:attr('role', 'navigation')
			:addClass('navbox')
			:addClass(args.navboxclass)
			:cssText(args.bodystyle)
			:cssText(args.style)
			:css('padding', '3px')
			:wikitext(addListStyles())
			: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
	end

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

	return striped(tostring(res))
end

function p.navbox(frame)
	if not getArgs then
		getArgs = require('Module:Arguments').getArgs
	end
	args = getArgs(frame, {wrappers = {'Template:Navbox', 'Template:Navbox subgroup'}})
	if frame.args.border then
		-- This allows Template:Navbox_subgroup to use {{#invoke:Navbox|navbox|border=...}}.
		args.border = frame.args.border
	end

	-- Read the arguments in the order they'll be output in, to make references number in the right order.
	local _
	_ = args.title
	_ = args.above
	for i = 1, 20 do
		_ = args["group" .. tostring(i)]
		_ = args["list" .. tostring(i)]
	end
	_ = args.below

	return p._navbox(args)
end

return p