Omniversalis

Module:Navbox: Difference between revisions

Module Discussion

Module:Navbox (edit)

Revision as of 01:14, 3 April 2022

4,285 bytes added ,  2 years ago
no edit summary
(update from Module:Navbox/sandbox per Template talk:Navbox#Merging nowrap navbox to implement nowrapitems=yes to nowrap listN + above + below text)
 
en>Centrist16
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1:
--
-- This module implements {{Navbox}}
--
 
local p = {}
 
local navbar = require('Module:Navbar')._navbar
local cfg = mw.loadData('Module:Navbox/configuration')
local getArgs -- lazily initialized
 
local args
local tableRowAddedformat = falsestring.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)
-- 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
Line 54 ⟶ 44:
end
local regex = orphanCat:gsub('([%[%]])', '%%%1')
return (wikitext:gsub(regex, ''):gsub(REGEX_MARKERcfg.marker.regex, changer)) -- () omits gsub count
end
 
Line 63 ⟶ 53:
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 = prefix .format(cfg.nowrap_item, '<span class="nowrap">' ..prefix, content .. '</span>')
end
table.insert(lines, line)
Line 80 ⟶ 70:
end
 
-- we will want this later when we want to add tstyles for hlist/plainlist
local function addTableRow(tbl)
local function has_navbar()
-- If any other rows have already been added, then we add a 2px gutter row.
return args[cfg.arg.navbar] ~= cfg.keyword.navbar_off
if tableRowAdded then
and args[cfg.arg.navbar] ~= cfg.keyword.navbar_plain
tbl
:tagand ('tr')
args[cfg.arg.name]
:css('height', '2px')
or mw.getCurrentFrame():getParent():getTitle():gsub(cfg.pattern.sandbox, '')
:tag('td')
~= cfg.pattern.navbox
:attr('colspan',2)
)
end
 
tableRowAdded = true
 
return tbl:tag('tr')
end
 
local function renderNavBar(titleCell)
if has_navbar() then
 
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{
[cfg.navbar.name] = args[cfg.arg.name],
[cfg.navbar.mini] = 1,
[cfg.navbar.fontstyle] = (args[cfg.arg.basestyle] or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;'
(args[cfg.arg.titlestyle] or '') ..
';background:none transparent;border:none;box-shadow:none;padding:0;'
})
end
Line 107 ⟶ 94:
end
 
--
-- Title row
--
local function renderTitleRow(tbl)
if not args[cfg.arg.title] then return end
 
local titleRow = addTableRow(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
:css('border-left', '2px solid #fdfdfd')
:css('width', '100%')
end
 
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)
 
Line 150 ⟶ 115:
titleCell
:tag('div')
-- id for aria-labelledby attribute
:attr('id', mw.uri.anchorEncode(args.title))
:attr('id', mw.uri.anchorEncode(args[cfg.arg.title]))
:addClass(args.titleclass)
:addClass(args[cfg.arg.titleclass])
:css('font-size', '114%')
:css('margin', '0 4em')
:wikitext(processItem(args[cfg.arg.title]))
end
 
--
-- Above/Below rows
--
 
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')
addTableRow(tbl)
: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
:wikitext(processItem(args.above, args.nowrapitems))
:attr('id', args[cfg.arg.title] and nil or mw.uri.anchorEncode(args[cfg.arg.above]))
: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')
addTableRow(tbl)
: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 function renderListRow(tbl, index, listnum, listnums_size)
--
local row = tbl:tag('tr')
-- List rows
--
local function renderListRow(tbl, index, listnum)
local row = addTableRow(tbl)
 
if index == 1 and args[cfg.arg.imageleft] then
row
:tag('td')
:addClass('navbox-image'cfg.class.noviewer)
:addClass(argscfg.imageclassclass.navbox_image)
:addClass(args[cfg.arg.imageclass])
:css('width', '0%')
:css('paddingwidth', '0px1px') 2px 0px 0px') -- Minimize width
:css('padding', '0 2px 0 0')
:cssText(args.imageleftstyle)
:cssText(args[cfg.arg.imageleftstyle])
:attr('rowspan', 2 * #listnums - 1)
:attr('rowspan', listnums_size)
:tag('div')
:wikitext(processItem(args[cfg.arg.imageleft]))
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')
 
-- 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
 
if :css('width', args[cfg.arg.groupwidth] or then'1%')
groupCell:css('width', args.groupwidth)
end
 
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
:addClass(cfg.class.navbox_list_with_group)
:css('text-align', 'left')
:css('border-left-width', '2px')
:css('border-left-style', 'solid')
else
listCell:attr('colspan', 2)
end
 
if not args[cfg.arg.groupwidth] then
listCell:css('width', '100%')
end
Line 251 ⟶ 217:
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 listTextlist_and_num = args['list' format(cfg.arg.list_and_num, listnum])
local oddEvenlistText = ODD_EVEN_MARKERargs[list_and_num]
local oddEven = cfg.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_MARKERcfg.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',
: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
row
:tag('td')
:addClass('navbox-image'cfg.class.noviewer)
:addClass(argscfg.imageclassclass.navbox_image)
:addClass(args[cfg.arg.imageclass])
:css('width', '0%')
:css('paddingwidth', '0px1px') 0px 0px 2px') -- Minimize width
:css('padding', '0 0 0 2px')
:cssText(args.imagestyle)
:cssText(args[cfg.arg.imagestyle])
:attr('rowspan', 2 * #listnums - 1)
:attr('rowspan', listnums_size)
:tag('div')
:wikitext(processItem(args[cfg.arg.image]))
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)
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,
cfg.arg.groupclass, cfg.arg.imageclass
}
local patterns = {
'^' .. htmlclass .. '$',
'%s' .. htmlclass .. '$',
'^' .. htmlclass .. '%s',
'%s' .. htmlclass .. '%s'
}
for _, arg in ipairs(class_args) do
for _, pattern in ipairs(patterns) do
if mw.ustring.find(args[arg] or '', pattern) then
return true
end
end
end
return false
end
 
local function needsHorizontalLists(border)
--
if border == cfg.keyword.border_subgroup or args[cfg.arg.tracking] == cfg.keyword.tracking_no then
-- Tracking categories
--
 
local function needsHorizontalLists()
if border == 'subgroup' or args.tracking == 'no' then
return false
end
return not has_list_class(cfg.pattern.hlist) and not has_list_class(cfg.pattern.plainlist)
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 function hasBackgroundColors()
for _, key in ipairs({'cfg.arg.titlestyle', 'cfg.arg.groupstyle', 'basestyle'}) do
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
Line 326:
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, 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' or subpage == 'testcases' then return endcfg.keyword.subpage_sandbox
or subpage == cfg.keyword.subpage_testcases then return end
 
for _, cat in ipairs(getTrackingCategories(border)) do
builder:wikitext('[[Category:' .. cat .. ']]')
end
end
 
local function renderMainTable(border, listnums)
--
-- Main navbox tables
--
local function renderMainTable()
local tbl = mw.html.create('table')
:addClass('cfg.class.nowraplinks')
:addClass(args[cfg.arg.bodyclass])
 
iflocal args.title and (args.state ~= 'plain' and args[cfg.arg.state ~= 'off') then]
if args[cfg.arg.title] and state ~= cfg.keyword.state_plain and state ~= cfg.keyword.state_off then
if state == 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()
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
 
function p._navbox(navboxArgs)
args = navboxArgs
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
Line 394 ⟶ 429:
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)
 
-- render the appropriate wrapper around the navbox, depending on the border param
local res = mw.html.create()
-- render the appropriate wrapper for the navbox, based on the border param
if border == 'none' then
 
if border == cfg.keyword.border_none then
res:node(add_navbox_styles())
local nav = res:tag('div')
:attr('role', 'navigation')
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
if args.title then
if args[cfg.arg.title] or args[cfg.arg.above] or (args[cfg.arg.group1]
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
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
-- 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 theWe endstart addwith a </div> to balance outavoid the parent'spadding </div>being applied, and at the
-- end add a <div> to balance out the parent's </div>
res
:wikitext('</div>')
Line 422 ⟶ 467:
:wikitext('<div>')
else
res:node(add_navbox_styles())
local nav = res:tag('div')
:attr('role', 'navigation')
:addClass('cfg.class.navbox')
:cssTextaddClass(args[cfg.bodystylearg.navboxclass])
:cssText(args[cfg.stylearg.bodystyle])
:cssText(args[cfg.arg.style])
:css('padding', '3px')
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
if args.title then
if args[cfg.arg.title] or args[cfg.arg.above]
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
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)
renderTrackingCategories(res, border)
 
end
return striped(tostring(res))
return striped(tostring(res), border)
end
 
Line 445 ⟶ 498:
getArgs = require('Module:Arguments').getArgs
end
args = getArgs(frame, {wrappers = 'Template:Navbox'{cfg.pattern.navbox}})
 
-- 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 _
_ = 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.group_and_num, tostring(i)]
_ = args["list" format(cfg.arg.list_and_num, tostring(i)]
end
_ = args[cfg.arg.below]
 
return p._navbox(args)
Anonymous user
Retrieved from "https://en.omniversalis.org/wiki/Special:MobileDiff/59...10964"