Difference between revisions of "Module:Navbox"

From CWS Planet
Jump to navigation Jump to search
m (1 revision imported)
 
m (1 revision imported)
(12 intermediate revisions by 5 users not shown)
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 tableRowAdded = false
local format = string.format
local border
local listnums = {}


local function trim(s)
local function striped(wikitext, border)
    return (mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1"))
-- 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 = cfg.category.orphan
if border == cfg.keyword.border_subgroup and args[cfg.arg.orphan] ~= cfg.keyword.orphan_yes then
-- No change; striping occurs in outermost navbox.
return wikitext .. orphanCat
end
local first, second = cfg.class.navbox_odd_part, cfg.class.navbox_even_part
if args[cfg.arg.evenodd] then
if args[cfg.arg.evenodd] == cfg.keyword.evenodd_swap then
first, second = second, first
else
first = args[cfg.arg.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(cfg.marker.regex, changer)) -- () omits gsub count
end
end


local function addNewline(s)
local function processItem(item, nowrapitems)
    if s:match('^[*:;#]') or s:match('^{|') then
if item:sub(1, 2) == '{|' then
        return '\n' .. s ..'\n'
-- Applying nowrap to lines in a table does not make sense.
    else
-- Add newlines to compensate for trim of x in |parm=x in a template.
        return s
return '\n' .. item ..'\n'
    end
end
if nowrapitems == 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(cfg.pattern.nowrap) then
line = format(cfg.nowrap_item, prefix, content)
end
table.insert(lines, line)
end
item = table.concat(lines, '\n')
end
if item:match('^[*:;#]') then
return '\n' .. item ..'\n'
end
return item
end
end


local function addTableRow(tbl)
-- we will want this later when we want to add tstyles for hlist/plainlist
    -- If any other rows have already been added, then we add a 2px gutter row.
local function has_navbar()
    if tableRowAdded then
return args[cfg.arg.navbar] ~= cfg.keyword.navbar_off
        tbl
and args[cfg.arg.navbar] ~= cfg.keyword.navbar_plain
            :tag('tr')
and (
                :css('height', '2px')
args[cfg.arg.name]
                :tag('td')
or mw.getCurrentFrame():getParent():getTitle():gsub(cfg.pattern.sandbox, '')
                    :attr('colspan',2)
~= cfg.pattern.navbox
    end
)
 
    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
if has_navbar() then
    -- or right to keep the title centered.
titleCell:wikitext(navbar{
    local spacerSide = nil
[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;box-shadow:none;padding:0;'
})
end


    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
        titleCell:wikitext(navbar{
            args.name,
            mini = 1,
            fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') ..  ';background:none transparent;border:none;'
        })
    end
    -- Render the spacer div.
    if spacerSide then
        titleCell
            :tag('span')
                :css('float', spacerSide)
                :css('width', '6em')
                :wikitext(' ')
    end
end
end


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


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


    if args.titlegroup then
local titleCell = titleRow:tag('th'):attr('scope', 'col')
        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 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
titleCell
        titleCell
:cssText(args[cfg.arg.basestyle])
            :css('border-left', '2px solid #fdfdfd')
:cssText(args[cfg.arg.titlestyle])
            :css('width', '100%')
:addClass(cfg.class.navbox_title)
    end
:attr('colspan', titleColspan)


    local titleColspan = 2
renderNavBar(titleCell)
    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
titleCell
        :cssText(args.basestyle)
:tag('div')
        :cssText(args.titlestyle)
-- id for aria-labelledby attribute
        :addClass('navbox-title')
:attr('id', mw.uri.anchorEncode(args[cfg.arg.title]))
        :attr('colspan', titleColspan)
:addClass(args[cfg.arg.titleclass])
 
:css('font-size', '114%')
    renderNavBar(titleCell)
:css('margin', '0 4em')
 
:wikitext(processItem(args[cfg.arg.title]))
    titleCell
        :tag('div')
            :addClass(args.titleclass)
            :css('font-size', '114%')
            :wikitext(addNewline(args.title))
end
end
--
--  Above/Below rows
--


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


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


    addTableRow(tbl)
tbl:tag('tr')
        :tag('td')
:tag('td')
            :addClass('navbox-abovebelow')
:addClass(cfg.class.navbox_abovebelow)
            :addClass(args.aboveclass)
:addClass(args[cfg.arg.aboveclass])
            :cssText(args.basestyle)
:cssText(args[cfg.arg.basestyle])
            :cssText(args.abovestyle)
:cssText(args[cfg.arg.abovestyle])
            :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[cfg.arg.title] and nil or mw.uri.anchorEncode(args[cfg.arg.above]))
:wikitext(processItem(args[cfg.arg.above], args[cfg.arg.nowrapitems]))
end
end


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


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


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


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


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


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


        if args.groupwidth then
groupCell
            groupCell:css('width', args.groupwidth)
:attr('scope', 'row')
        end
:addClass(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%')


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


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


    if args['group' .. listnum] then
if args[group_and_num] then
        listCell
listCell
            :css('text-align', 'left')
:addClass(cfg.class.navbox_list_with_group)
            :css('border-left-width', '2px')
else
            :css('border-left-style', 'solid')
listCell:attr('colspan', 2)
    else
end
        listCell:attr('colspan', 2)
    end


    if not args.groupwidth then
if not args[cfg.arg.groupwidth] then
        listCell:css('width', '100%')
listCell:css('width', '100%')
    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[cfg.arg.oddstyle]
else
rowstyle = args[cfg.arg.evenstyle]
end


    local evenOdd
local list_and_num = format(cfg.arg.list_and_num, listnum)
    if args.evenodd == 'swap' then
local listText = args[list_and_num]
        if isOdd then evenOdd = 'even' else evenOdd = 'odd' end
local oddEven = cfg.marker.oddeven
    else
if listText:sub(1, 12) == '</div><table' then
        if isOdd then evenOdd = args.evenodd or 'odd' else evenOdd = args.evenodd or 'even' end
-- Assume list text is for a subgroup navbox so no automatic striping for this row.
    end
oddEven = listText:find(cfg.pattern.navbox_title) and cfg.marker.restart or cfg.class.navbox_odd_part
end


    listCell
local liststyle_and_num = format(cfg.arg.liststyle_and_num, listnum)
        :css('padding', '0px')
local listclass_and_num = format(cfg.arg.listclass_and_num, listnum)
        :cssText(args.liststyle)
listCell
        :cssText(rowstyle)
:css('padding', '0')
        :cssText(args['list' .. listnum .. 'style'])
:cssText(args[cfg.arg.liststyle])
        :addClass('navbox-list')
:cssText(rowstyle)
        :addClass('navbox-' .. evenOdd)
:cssText(args[liststyle_and_num])
        :addClass(args.listclass)
:addClass(cfg.class.navbox_list)
        :tag('div')
:addClass(cfg.class.navbox_part .. oddEven)
            :css('padding', (listnum == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
:addClass(args[cfg.arg.listclass])
            :wikitext(addNewline(args['list' .. listnum]))
:addClass(args[listclass_and_num])
:tag('div')
:css('padding',
(index == 1 and args[cfg.arg.list1padding]) or args[cfg.arg.listpadding] or '0 0.25em'
)
:wikitext(processItem(listText, args[cfg.arg.nowrapitems]))


    if listnum == 1 and args.image then
if index == 1 and args[cfg.arg.image] then
        row
row
            :tag('td')
:tag('td')
                :addClass('navbox-image')
:addClass(cfg.class.noviewer)
                :addClass(args.imageclass)
:addClass(cfg.class.navbox_image)
                :css('width', '0%')
:addClass(args[cfg.arg.imageclass])
                :css('padding', '0px 0px 0px 2px')
:css('width', '1px')               -- Minimize width
                :cssText(args.imagestyle)
:css('padding', '0 0 0 2px')
                :attr('rowspan', 2 * #listnums - 1)
:cssText(args[cfg.arg.imagestyle])
                :tag('div')
:attr('rowspan', listnums_size)
                    :wikitext(addNewline(args.image))
:tag('div')
    end
:wikitext(processItem(args[cfg.arg.image]))
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)
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)
--  Tracking categories
if border == cfg.keyword.border_subgroup or args[cfg.arg.tracking] == cfg.keyword.tracking_no then
--
return false
end
return not has_list_class(cfg.pattern.hlist) and not has_list_class(cfg.pattern.plainlist)
end


local function needsHorizontalLists()
local function hasBackgroundColors()
    if border == 'child' or border == 'subgroup'  or args.tracking == 'no' then return false end
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 listClasses = {'plainlist', 'hlist', 'hlist hnum', 'hlist hwrap', 'hlist vcard', 'vcard hlist', 'hlist vevent'}
local function hasBorders()
    for i, cls in ipairs(listClasses) do
for _, key in ipairs({cfg.arg.groupstyle, cfg.arg.basestyle,
        if args.listclass == cls or args.bodyclass == cls then
cfg.arg.abovestyle, cfg.arg.belowstyle}) do
            return false
if tostring(args[key]):find('border', 1, true) then
        end
return true
    end
end
end
return false
end


    return true
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
end
end
return false
end
end


local function hasBackgroundColors()
local function getTrackingCategories(border)
    return mw.ustring.match(args.titlestyle or '','background') or mw.ustring.match(args.groupstyle or '','background') or mw.ustring.match(args.basestyle or '','background')
local cats = {}
if needsHorizontalLists(border) then table.insert(cats, cfg.category.horizontal_lists) end
if hasBackgroundColors() then table.insert(cats, cfg.category.background_colors) end
if isIllegible() then table.insert(cats, cfg.category.illegible) end
if hasBorders() then table.insert(cats, cfg.category.borders) end
return cats
end
end


local function isIllegible()
local function renderTrackingCategories(builder, border)
    local styleratio = require('Module:Color contrast')._styleratio
local title = mw.title.getCurrentTitle()
if title.namespace ~= 10 then return end -- not in template space
local subpage = title.subpageText
if subpage == cfg.keyword.subpage_doc or subpage == cfg.keyword.subpage_sandbox
or subpage == cfg.keyword.subpage_testcases then return end


    for key, style in pairs(args) do
for _, cat in ipairs(getTrackingCategories(border)) do
        if tostring(key):match("style$") then
builder:wikitext('[[Category:' .. cat .. ']]')
            if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
end
                return true
            end
        end
    end
    return false
end
end


local function getTrackingCategories()
local function renderMainTable(border, listnums)
    local cats = {}
local tbl = mw.html.create('table')
    if needsHorizontalLists() then table.insert(cats, 'Navigational boxes without horizontal lists') end
:addClass(cfg.class.nowraplinks)
    if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
:addClass(args[cfg.arg.bodyclass])
    if isIllegible() then table.insert(cats, 'Potentially illegible navboxes') end
    return cats
end


local function renderTrackingCategories(builder)
local state = args[cfg.arg.state]
    local title = mw.title.getCurrentTitle()
if args[cfg.arg.title] and state ~= cfg.keyword.state_plain and state ~= cfg.keyword.state_off then
    if title.namespace ~= 10 then return end -- not in template space
if state == cfg.keyword.state_collapsed then
    local subpage = title.subpageText
state = cfg.class.collapsed
    if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end
end
tbl
:addClass(cfg.class.collapsible)
:addClass(state or cfg.class.autocollapse)
end


    for i, cat in ipairs(getTrackingCategories()) do
tbl:css('border-spacing', 0)
        builder:wikitext('[[Category:' .. cat .. ']]')
if border == cfg.keyword.border_subgroup or border == cfg.keyword.border_none then
    end
tbl
end
:addClass(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(cfg.class.navbox_inner)
:css('background', 'transparent')
:css('color', 'inherit')
end
tbl:cssText(args[cfg.arg.innerstyle])


--
renderTitleRow(tbl)
--  Main navbox tables
renderAboveRow(tbl)
--
local listnums_size = #listnums
local function renderMainTable()
for i, listnum in ipairs(listnums) do
    local tbl = mw.html.create('table')
renderListRow(tbl, i, listnum, listnums_size)
        :addClass('nowraplinks')
end
        :addClass(args.bodyclass)
renderBelowRow(tbl)


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


    tbl:css('border-spacing', 0)
local function add_navbox_styles()
    if border == 'subgroup' or border == 'child' or border == 'none' then
local frame = mw.getCurrentFrame()
        tbl
-- This is a lambda so that it doesn't need the frame as a parameter
            :addClass('navbox-subgroup')
local function add_user_styles(templatestyles)
            :cssText(args.bodystyle)
if templatestyles and templatestyles ~= '' then
            :cssText(args.style)
return frame:extensionTag{
    else -- regular navobx - bodystyle and style will be applied to the wrapper table
name = 'templatestyles', args = { src = templatestyles }
        tbl
}
            :addClass('navbox-inner')
end
            :css('background', 'transparent')
return ''
            :css('color', 'inherit')
end
    end
    tbl:cssText(args.innerstyle)


    renderTitleRow(tbl)
-- get templatestyles. load base from config so that Lua only needs to do
    renderAboveRow(tbl)
-- the work once of parser tag expansion
    for i, listnum in ipairs(listnums) do
local base_templatestyles = cfg.templatestyles
        renderListRow(tbl, listnum)
local templatestyles = add_user_styles(args[cfg.arg.templatestyles])
    end
local child_templatestyles = add_user_styles(args[cfg.arg.child_templatestyles])
    renderBelowRow(tbl)


     return tbl
-- 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 = {}


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


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


    -- render the main body of the navbox
-- render the main body of the navbox
    local tbl = renderMainTable()
local tbl = renderMainTable(border, listnums)


    -- render the appropriate wrapper around the navbox, depending on the border param
local res = mw.html.create()
    local res = mw.html.create()
-- render the appropriate wrapper for the navbox, based on the border param
    if border == 'none' then
        res:node(tbl)
    elseif border == 'subgroup' or border == 'child' 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>') -- XXX: hack due to lack of unclosed support in mw.html.
            :node(tbl)
            :wikitext('<div>') -- XXX: hack due to lack of unclosed support in mw.html.
    else
        res
            :tag('table')
                :addClass('navbox')
                :css('border-spacing', 0)
                :cssText(args.bodystyle)
                :cssText(args.style)
                :tag('tr')
                    :tag('td')
                        :css('padding', '2px')
                        :node(tbl)
    end


    renderTrackingCategories(res)
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[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', cfg.aria_label)
end
elseif border == 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>')
:node(tbl)
:wikitext('<div>')
else
res:node(add_navbox_styles())
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', cfg.aria_label)
end
end


    return tostring(res)
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
end


function p.navbox(frame)
function p.navbox(frame)
    if not getArgs then
if not getArgs then
        getArgs = require('Module:Arguments').getArgs
getArgs = require('Module:Arguments').getArgs
    end
end
    args = getArgs(frame, {wrappers = 'Template:Navbox'})
args = getArgs(frame, {wrappers = {cfg.pattern.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
    local _
-- number in the right order.
    _ = args.title
local _
    _ = args.above
_ = args[cfg.arg.title]
    for i = 1, 20 do
_ = args[cfg.arg.above]
        _ = args["group" .. tostring(i)]
-- Limit this to 20 as covering 'most' cases (that's a SWAG) and because
        _ = args["list" .. tostring(i)]
-- iterator approach won't work here
    end
for i = 1, 20 do
    _ = args.below
_ = args[format(cfg.arg.group_and_num, i)]
_ = args[format(cfg.arg.list_and_num, i)]
end
_ = args[cfg.arg.below]


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


return p
return p

Revision as of 15:29, 14 July 2022

Documentation for this module may be created at Module:Navbox/doc

local p = {}
local navbar = require('Module:Navbar')._navbar
local cfg = mw.loadData('Module:Navbox/configuration')
local getArgs -- lazily initialized
local args
local format = 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 = cfg.category.orphan
	if border == cfg.keyword.border_subgroup and args[cfg.arg.orphan] ~= cfg.keyword.orphan_yes then
		-- No change; striping occurs in outermost navbox.
		return wikitext .. orphanCat
	end
	local first, second = cfg.class.navbox_odd_part, cfg.class.navbox_even_part
	if args[cfg.arg.evenodd] then
		if args[cfg.arg.evenodd] == cfg.keyword.evenodd_swap then
			first, second = second, first
		else
			first = args[cfg.arg.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(cfg.marker.regex, 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 == 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(cfg.pattern.nowrap) then
				line = format(cfg.nowrap_item, prefix, content)
			end
			table.insert(lines, line)
		end
		item = table.concat(lines, '\n')
	end
	if item:match('^[*:;#]') then
		return '\n' .. item ..'\n'
	end
	return item
end

-- we will want this later when we want to add tstyles for hlist/plainlist
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 has_navbar() 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;box-shadow:none;padding:0;'
		})
	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

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

	renderNavBar(titleCell)

	titleCell
		: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(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', 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')
		:tag('td')
			:addClass(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')

	if index == 1 and args[cfg.arg.imageleft] then
		row
			:tag('td')
				:addClass(cfg.class.noviewer)
				:addClass(cfg.class.navbox_image)
				:addClass(args[cfg.arg.imageclass])
				:css('width', '1px')               -- Minimize width
				:css('padding', '0 2px 0 0')
				:cssText(args[cfg.arg.imageleftstyle])
				:attr('rowspan', listnums_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_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(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%')

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

	local listCell = row:tag('td')

	if args[group_and_num] then
		listCell
			:addClass(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_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(cfg.pattern.navbox_title) and cfg.marker.restart or 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', '0')
		:cssText(args[cfg.arg.liststyle])
		:cssText(rowstyle)
		:cssText(args[liststyle_and_num])
		:addClass(cfg.class.navbox_list)
		:addClass(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 '0 0.25em'
			)
			:wikitext(processItem(listText, args[cfg.arg.nowrapitems]))

	if index == 1 and args[cfg.arg.image] then
		row
			:tag('td')
				:addClass(cfg.class.noviewer)
				:addClass(cfg.class.navbox_image)
				:addClass(args[cfg.arg.imageclass])
				:css('width', '1px')               -- Minimize width
				:css('padding', '0 0 0 2px')
				:cssText(args[cfg.arg.imagestyle])
				: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
		return false
	end
	return not has_list_class(cfg.pattern.hlist) and not has_list_class(cfg.pattern.plainlist)
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
		end
	end
	return false
end

local function getTrackingCategories(border)
	local cats = {}
	if needsHorizontalLists(border) then table.insert(cats, cfg.category.horizontal_lists) end
	if hasBackgroundColors() then table.insert(cats, cfg.category.background_colors) end
	if isIllegible() then table.insert(cats, cfg.category.illegible) 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 == cfg.keyword.subpage_doc or subpage == cfg.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)
	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 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(state or cfg.class.autocollapse)
	end

	tbl:css('border-spacing', 0)
	if border == cfg.keyword.border_subgroup or border == cfg.keyword.border_none then
		tbl
			:addClass(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(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(cfg.pattern.listnum)
			if listnum then table.insert(listnums, tonumber(listnum)) end
		end
	end
	table.sort(listnums)

	local border = mw.text.trim(args[cfg.arg.border] or args[1] or '')
	if border == cfg.keyword.border_child then
		border = 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 == 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[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', cfg.aria_label)
		end
	elseif border == 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>')
			:node(tbl)
			:wikitext('<div>')
	else
		res:node(add_navbox_styles())
		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', 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

function p.navbox(frame)
	if not getArgs then
		getArgs = require('Module:Arguments').getArgs
	end
	args = getArgs(frame, {wrappers = {cfg.pattern.navbox}})

	-- 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[format(cfg.arg.group_and_num, i)]
		_ = args[format(cfg.arg.list_and_num, i)]
	end
	_ = args[cfg.arg.below]

	return p._navbox(args)
end

return p