17,626
edits
Changes
we don't have the strict module yet
---- This module implements {{Navbox}}--require('strict')
local p = {}
local navbar = require('Module:Navbar')._navbar
local cfg = mw.loadData('Module:Navbox/configuration')
local getArgs -- lazily initialized
local args
local borderlocal listnums format = {}local ODD_EVEN_MARKER = '\127_ODDEVEN_\127'local RESTART_MARKER = '\127_ODDEVEN0_\127'local REGEX_MARKER = '\127_ODDEVEN(%d?)_\127'string.format
local function striped(wikitext, border)
-- 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]]'cfg.category.orphan if border == 'subgroup' cfg.keyword.border_subgroup and args[cfg.arg.orphan ] ~= 'yes' cfg.keyword.orphan_yes then
-- No change; striping occurs in outermost navbox.
return wikitext .. orphanCat
end
local first, second = 'odd'cfg.class.navbox_odd_part, 'even'cfg.class.navbox_even_part if args[cfg.arg.evenodd ] then if args[cfg.arg.evenodd ] == 'swap' cfg.keyword.evenodd_swap then
first, second = second, first
else
first = args[cfg.arg.evenodd]
second = first
end
end
local regex = orphanCat:gsub('([%[%]])', '%%%1')
return (wikitext:gsub(regex, ''):gsub(REGEX_MARKERcfg.marker.regex, changer)) -- () omits gsub count
end
return '\n' .. item ..'\n'
end
if nowrapitems == 'yes' cfg.keyword.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="cfg.pattern.nowrap">') then line = format(cfg.nowrap_item, prefix .. '<span class="nowrap">' .. , content .. '</span>')
end
table.insert(lines, line)
end
return item
end
local function has_navbar()
return args[cfg.arg.navbar] ~= cfg.keyword.navbar_off
and args[cfg.arg.navbar] ~= cfg.keyword.navbar_plain
and (
args[cfg.arg.name]
or mw.getCurrentFrame():getParent():getTitle():gsub(cfg.pattern.sandbox, '')
~= cfg.pattern.navbox
)
end
local function renderNavBar(titleCell)
if args.navbar ~= 'off' and args.navbar ~= 'plain' and not has_navbar(not args.name and mw.getCurrentFrame():getParent():getTitle():gsub('/sandbox$', '') == 'Template:Navbox') then
titleCell:wikitext(navbar{
[cfg.navbar.name] = args[cfg.arg.name], [cfg.navbar.mini ] = 1, [cfg.navbar.fontstyle ] = (args[cfg.arg.basestyle ] or '') .. ';' .. (args[cfg.arg.titlestyle ] or '') .. ';background:none transparent;border:none;-moz-box-shadow:none;-webkit-box-shadowpadding:none;box-shadow:none0;'
})
end
end
local function renderTitleRow(tbl)
if not args[cfg.arg.title ] then return end
local titleRow = tbl:tag('tr')
local titleCell = titleRow:tag('th'):attr('scope', 'col')
local titleColspan = 2
if args[cfg.arg.imageleft ] then titleColspan = titleColspan + 1 end if args[cfg.arg.image ] then titleColspan = titleColspan + 1 end if args.titlegroup then titleColspan = titleColspan - 1 end
titleCell
:cssText(args[cfg.arg.basestyle]) :cssText(args[cfg.arg.titlestyle]) :addClass('navbox-title'cfg.class.navbox_title)
:attr('colspan', titleColspan)
:tag('div')
-- id for aria-labelledby attribute
:attr('id', mw.uri.anchorEncode(args[cfg.arg.title])) :addClass(args[cfg.arg.titleclass])
:css('font-size', '114%')
:css('margin', '0 4em')
:wikitext(processItem(args[cfg.arg.title]))
end
local function getAboveBelowColspan()
local ret = 2
if args[cfg.arg.imageleft ] then ret = ret + 1 end if args[cfg.arg.image ] then ret = ret + 1 end
return ret
end
local function renderAboveRow(tbl)
if not args[cfg.arg.above ] then return end
tbl:tag('tr')
:tag('td')
:addClass('navbox-abovebelow'cfg.class.navbox_abovebelow) :addClass(args[cfg.arg.aboveclass]) :cssText(args[cfg.arg.basestyle]) :cssText(args[cfg.arg.abovestyle])
:attr('colspan', getAboveBelowColspan())
:tag('div')
-- id for aria-labelledby attribute, if no title
:attr('id', (not args[cfg.arg.title ]) and nil or mw.uri.anchorEncode(args[cfg.arg.above])or nil) :wikitext(processItem(args[cfg.arg.above], args[cfg.arg.nowrapitems]))
end
local function renderBelowRow(tbl)
if not args[cfg.arg.below ] then return end
tbl:tag('tr')
:tag('td')
:addClass('navbox-abovebelow'cfg.class.navbox_abovebelow) :addClass(args[cfg.arg.belowclass]) :cssText(args[cfg.arg.basestyle]) :cssText(args[cfg.arg.belowstyle])
:attr('colspan', getAboveBelowColspan())
:tag('div')
:wikitext(processItem(args[cfg.arg.below], args[cfg.arg.nowrapitems]))
end
local row = tbl:tag('tr')
if index == 1 and args[cfg.arg.imageleft ] then
row
:tag('td')
:addClass('navbox-image'cfg.class.noviewer) :addClass(cfg.class.navbox_image) :addClass(args[cfg.arg.imageclass])
:css('width', '1px') -- Minimize width
:css('padding', '0px 0 2px 0px 0px0 0') :cssText(args[cfg.arg.imageleftstyle]) :attr('rowspan', #listnumslistnums_size)
:tag('div')
:wikitext(processItem(args[cfg.arg.imageleft]))
end
local group_and_num = format(cfg.arg.group_and_num, listnum) local groupstyle_and_num = format(cfg.arg.groupstyle_and_num, listnum) if args['group' .. listnumgroup_and_num] 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[cfg.arg.title ] or args[cfg.arg.above ] or args[cfg.arg.group2]) then
groupCell
:attr('id', mw.uri.anchorEncode(args[cfg.arg.group1]))
end
groupCell
:attr('scope', 'row')
:addClass('navbox-group'cfg.class.navbox_group) :addClass(args[cfg.arg.groupclass]) :cssText(args[cfg.arg.basestyle]) -- If groupwidth not specified, minimize width :css('width', args[cfg.arg.groupwidth ] or '1%') -- If groupwidth not specified, minimize width
groupCell
:cssText(args[cfg.arg.groupstyle]) :cssText(args['group' .. listnum .. 'style'groupstyle_and_num]) :wikitext(args['group' .. listnumgroup_and_num])
end
local listCell = row:tag('td')
if args['group' .. listnumgroup_and_num] then
listCell
:cssaddClass('text-align', 'left') :css('border-left-width', '2px') :css('border-left-style', 'solid'cfg.class.navbox_list_with_group)
else
listCell:attr('colspan', 2)
end
if not args[cfg.arg.groupwidth ] then
listCell:css('width', '100%')
end
local rowstyle -- usually nil so cssText(rowstyle) usually adds nothing
if index % 2 == 1 then
rowstyle = args[cfg.arg.oddstyle]
else
rowstyle = args[cfg.arg.evenstyle]
end
local list_and_num = format(cfg.arg.list_and_num, listnum) local listText = args['list' .. listnumlist_and_num] local oddEven = ODD_EVEN_MARKERcfg.marker.oddeven
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"'cfg.pattern.navbox_title) and RESTART_MARKER cfg.marker.restart or 'odd'cfg.class.navbox_odd_part
end
local liststyle_and_num = format(cfg.arg.liststyle_and_num, listnum)
local listclass_and_num = format(cfg.arg.listclass_and_num, listnum)
listCell
:css('padding', '0px0') :cssText(args[cfg.arg.liststyle])
:cssText(rowstyle)
:cssText(args['list' .. listnum .. 'style'liststyle_and_num]) :addClass('navbox-list'cfg.class.navbox_list) :addClass('navbox-' cfg.class.navbox_part .. oddEven) :addClass(args[cfg.arg.listclass]) :addClass(args[listclass_and_num])
:tag('div')
:css('padding', (index == 1 and args[cfg.arg.list1padding]) or args[cfg.arg.listpadding ] or '0em 0 0.25em' ) :wikitext(processItem(listText, args[cfg.arg.nowrapitems]))
if index == 1 and args[cfg.arg.image ] then
row
:tag('td')
:addClass('navbox-image'cfg.class.noviewer) :addClass(cfg.class.navbox_image) :addClass(args[cfg.arg.imageclass])
:css('width', '1px') -- Minimize width
:css('padding', '0px 0px 0px 0 0 0 2px') :cssText(args[cfg.arg.imagestyle]) :attr('rowspan', #listnumslistnums_size)
:tag('div')
:wikitext(processItem(args[cfg.arg.image]))
end
end
local function has_list_class(htmlclass)
local patterns = {
'^' .. htmlclass .. '$',
'%s' .. htmlclass .. '$',
'^' .. htmlclass .. '%s',
'%s' .. htmlclass .. '%s'
}
for arg, _ in pairs(args) do
if type(arg) == 'string' and mw.ustring.find(arg, cfg.pattern.class) then
for _, pattern in ipairs(patterns) do
if mw.ustring.find(args[arg] or '', pattern) then
return true
end
end
end
end
return false
end
--there are a lot of list classes in the wild, so we add their TemplateStyleslocal function add_list_styles() local frame = mw.getCurrentFrame() local function add_list_templatestyles(htmlclass, templatestyles) if has_list_class(htmlclass) then return frame:extensionTag{ name = 'templatestyles', args = { src = templatestyles } } else return '' end end local hlist_styles = add_list_templatestyles('hlist', cfg.hlist_templatestyles) local plainlist_styles = add_list_templatestyles('plainlist', cfg.plainlist_templatestyles) -- Tracking categoriesa second workaround for [[phab:T303378]] --when that issue is fixed, we can actually use has_navbar not to emit the -- tag here if we want if has_navbar() and hlist_styles == '' then hlist_styles = frame:extensionTag{ name = 'templatestyles', args = { src = cfg.hlist_templatestyles } } end -- hlist -> plainlist is best-effort to preserve old Common.css ordering. -- this ordering is not a guarantee because most navboxes will emit only -- one of these classes [hlist_note] return hlist_styles .. plainlist_stylesend
local function needsHorizontalLists(border) if border == 'subgroup' cfg.keyword.border_subgroup or args[cfg.arg.tracking ] == 'no' cfg.keyword.tracking_no then
return false
end
end
local function hasBackgroundColors()
for _, key in ipairs({'cfg.arg.titlestyle', 'cfg.arg.groupstyle', ' cfg.arg.basestyle', 'cfg.arg.abovestyle', 'cfg.arg.belowstyle'}) do
if tostring(args[key]):find('background', 1, true) then
return true
end
end
return false
end
local function hasBorders()
for _, key in ipairs({'cfg.arg.groupstyle', 'cfg.arg.basestyle', ' cfg.arg.abovestyle', 'cfg.arg.belowstyle'}) do
if tostring(args[key]):find('border', 1, true) then
return true
end
end
return false
end
local function isIllegible()
local styleratio = require('Module:Color contrast')._styleratio
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
local function getTrackingCategories(border)
local cats = {}
if needsHorizontalLists(border) then table.insert(cats, 'Navigational boxes without horizontal lists'cfg.category.horizontal_lists) end if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours'cfg.category.background_colors) end if isIllegible() then table.insert(cats, 'Potentially cfg.category.illegible navboxes') end if hasBorders() then table.insert(cats, 'Navboxes using cfg.category.borders') end
return cats
end
local function renderTrackingCategories(builder, border)
local title = mw.title.getCurrentTitle()
if title.namespace ~= 10 then return end -- not in template space
local subpage = title.subpageText
if subpage == 'doc' cfg.keyword.subpage_doc or subpage == 'sandbox' cfg.keyword.subpage_sandbox or subpage == 'testcases' cfg.keyword.subpage_testcases then return end
for _, cat in ipairs(getTrackingCategories(border)) do
builder:wikitext('[[Category:' .. cat .. ']]')
end
end
local tbl = mw.html.create('table')
:addClass('cfg.class.nowraplinks') :addClass(args[cfg.arg.bodyclass])
local state = args[cfg.arg.state] if args[cfg.arg.title ] and (argsstate ~= cfg.keyword.state_plain and state ~= 'plain' and argscfg.keyword.state_off then if state ~= 'off') = cfg.keyword.state_collapsed then state = cfg.class.collapsed end
tbl
:addClass('cfg.class.collapsible') :addClass(args.state or 'cfg.class.autocollapse')
end
tbl:css('border-spacing', 0)
if border == 'subgroup' cfg.keyword.border_subgroup or border == 'none' cfg.keyword.border_none then
tbl
:addClass('navbox-subgroup'cfg.class.navbox_subgroup) :cssText(args[cfg.arg.bodystyle]) :cssText(args[cfg.arg.style])
else -- regular navbox - bodystyle and style will be applied to the wrapper table
tbl
:addClass('navbox-inner'cfg.class.navbox_inner)
:css('background', 'transparent')
:css('color', 'inherit')
end
tbl:cssText(args[cfg.arg.innerstyle])
renderTitleRow(tbl)
renderAboveRow(tbl)
local listnums_size = #listnums
for i, listnum in ipairs(listnums) do
renderListRow(tbl, i, listnum, listnums_size)
end
renderBelowRow(tbl)
return tbl
end
local function add_navbox_styles(hiding_templatestyles)
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 to wrap the styles to work around T200206
-- more elegantly. Instead of combinatorial rules, this ends up being linear
-- number of CSS rules.
return mw.html.create('div')
:addClass(cfg.class.navbox_styles)
:wikitext(
add_list_styles() .. -- see [hlist_note] applied to 'before base_templatestyles'
base_templatestyles ..
templatestyles ..
child_templatestyles ..
table.concat(hiding_templatestyles)
)
:done()
end
-- work around [[phab:T303378]]
-- for each arg: find all the templatestyles strip markers, insert them into a
-- table. then remove all templatestyles markers from the arg
local function move_hiding_templatestyles(args)
local gfind = string.gfind
local gsub = string.gsub
local templatestyles_markers = {}
local strip_marker_pattern = '(\127[^\127]*UNIQ%-%-templatestyles%-%x+%-QINU[^\127]*\127)'
for k, arg in pairs(args) do
for marker in gfind(arg, strip_marker_pattern) do
table.insert(templatestyles_markers, marker)
end
args[k] = gsub(arg, strip_marker_pattern, '')
end
return templatestyles_markers
end
function p._navbox(navboxArgs)
args = navboxArgs
local hiding_templatestyles = move_hiding_templatestyles(args)
local listnums = {}
for k, _ in pairs(args) do
if type(k) == 'string' then
local listnum = k:match('^list(%d+)$'cfg.pattern.listnum)
if listnum then table.insert(listnums, tonumber(listnum)) end
end
table.sort(listnums)
local border = mw.text.trim(args[cfg.arg.border ] or args[1] or '') if border == 'child' cfg.keyword.border_child then border = 'subgroup'cfg.keyword.border_subgroup
end
-- render the main body of the navbox
local tbl = renderMainTable(border, listnums)
local res = mw.html.create()
-- render the appropriate wrapper for the navbox, based on the border param if border == 'none' cfg.keyword.border_none then res:node(add_navbox_styles(hiding_templatestyles))
local nav = res:tag('div')
:attr('role', 'navigation')
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
if args[cfg.arg.title ] or args[cfg.arg.above ] or (args[cfg.arg.group1 ] and not args[cfg.arg.group2]) then nav:attr( 'aria-labelledby', mw.uri.anchorEncode( args[cfg.arg.title ] or args[cfg.arg.above ] or args[cfg.arg.group1] ) )
else
nav:attr('aria-label', 'Navbox'cfg.aria_label)
end
elseif border == 'subgroup' cfg.keyword.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('<div>')
else
res:node(add_navbox_styles(hiding_templatestyles))
local nav = res:tag('div')
:attr('role', 'navigation')
:addClass('cfg.class.navbox') :addClass(args[cfg.arg.navboxclass]) :cssText(args[cfg.arg.bodystyle]) :cssText(args[cfg.arg.style])
:css('padding', '3px')
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
if args[cfg.arg.title ] or args[cfg.arg.above ] or (args[cfg.arg.group1 ] and not args[cfg.arg.group2]) then nav:attr( 'aria-labelledby', mw.uri.anchorEncode(args[cfg.arg.title ] or args[cfg.arg.above ] or args[cfg.arg.group1]) )
else
nav:attr('aria-label', 'Navbox'cfg.aria_label)
end
end
if (args[cfg.arg.nocat] or cfg.keyword.nocat_false):lower() == cfg.keyword.nocat_false then renderTrackingCategories(res, border) end return striped(tostring(res), border)
end
getArgs = require('Module:Arguments').getArgs
end
args = getArgs(frame, {wrappers = {'Template:Navbox', 'Template:Navbox subgroup'}}) if framecfg.argspattern.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[cfg.arg.title] _ = args[cfg.arg.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
_ = args["group" format(cfg.arg. tostring(group_and_num, i)] _ = args["list" format(cfg.arg. tostring(list_and_num, i)]
end
_ = args[cfg.arg.below]
return p._navbox(args)
