Difference between revisions of "Module:Navbox"

From Timelines
Jump to: navigation, search
(bodystyle fix)
(update from Module:Navbox/sandbox per talk; this implements automatic striping that applies to a navbox and any subgroup (child) navboxes it contains)
 
(47 intermediate revisions by 14 users not shown)
Line 1: Line 1:
 
--
 
--
-- This module will implement {{Navbox}}
+
-- This module implements {{Navbox}}
 
--
 
--
+
 
 
local p = {}
 
local p = {}
+
 
local HtmlBuilder = require('Module:HtmlBuilder')
+
local navbar = require('Module:Navbar')._navbar
 +
local getArgs -- lazily initialized
  
 
local args
 
local args
local frame
 
 
local tableRowAdded = false
 
local tableRowAdded = false
 
local border
 
local border
 
local listnums = {}
 
local listnums = {}
+
local ODD_EVEN_MARKER = '\127_ODDEVEN_\127'
function trim(s)
+
local RESTART_MARKER = '\127_ODDEVEN0_\127'
    return (mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1"))
+
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 addNewline(s)
 +
if s:match('^[*:;#]') or s:match('^{|') then
 +
return '\n' .. s ..'\n'
 +
else
 +
return s
 +
end
 
end
 
end
+
 
function addTableRow(tbl)
+
local function addTableRow(tbl)
    -- If any other rows have already been added, then we add a 2px gutter row.
+
-- If any other rows have already been added, then we add a 2px gutter row.
    if tableRowAdded then
+
if tableRowAdded then
        tbl
+
tbl
            .tag('tr')
+
:tag('tr')
                .css('height', '2px')
+
:css('height', '2px')
                .tag('td')
+
:tag('td')
    end
+
:attr('colspan',2)
   
+
end
    tableRowAdded = true
+
 
   
+
tableRowAdded = true
    return tbl.tag('tr')
+
 
 +
return tbl:tag('tr')
 
end
 
end
  
 +
local function renderNavBar(titleCell)
 +
 +
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{
 +
args.name,
 +
mini = 1,
 +
fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;'
 +
})
 +
end
 +
 +
end
  
 
--
 
--
 
--  Title row
 
--  Title row
 
--
 
--
function renderTitleRow(tbl)
+
local function renderTitleRow(tbl)
    if not args.title then return end
+
if not args.title then return end
+
 
    local titleRow = addTableRow(tbl)
+
local titleRow = addTableRow(tbl)
   
+
 
    if args.titlegroup then
+
if args.titlegroup then
        titleRow
+
titleRow
            .tag('th')
+
:tag('th')
                .attr('scope', 'row')
+
:attr('scope', 'row')
                .addClass('navbox-group')
+
:addClass('navbox-group')
                .addClass(args.titlegroupclass)
+
:addClass(args.titlegroupclass)
                .cssText(args.basestyle)
+
:cssText(args.basestyle)
                .cssText(args.groupstyle)
+
:cssText(args.groupstyle)
                .cssText(args.titlegroupstyle)
+
:cssText(args.titlegroupstyle)
                .wikitext(args.titlegroup)
+
:wikitext(args.titlegroup)
    end
+
end
   
+
 
    local titleCell = titleRow.tag('th').attr('scope', 'col')
+
local titleCell = titleRow:tag('th'):attr('scope', 'col')
           
+
 
    if args.titlegroup then
+
if args.titlegroup then
        titleCell
+
titleCell
            .css('border-left', '2px solid #fdfdfd')
+
:css('border-left', '2px solid #fdfdfd')
            .css('width', '100%')
+
:css('width', '100%')
    end
+
end
   
+
 
    local titleColspan = 2
+
local titleColspan = 2
    if args.imageleft then titleColspan = titleColspan + 1 end
+
if args.imageleft then titleColspan = titleColspan + 1 end
    if args.image then titleColspan = titleColspan + 1 end
+
if args.image then titleColspan = titleColspan + 1 end
    if args.titlegroup then titleColspan = titleColspan - 1 end
+
if args.titlegroup then titleColspan = titleColspan - 1 end
   
+
 
    titleCell
+
titleCell
        .cssText(args.basestyle)
+
:cssText(args.basestyle)
        .cssText(args.titlestyle)
+
:cssText(args.titlestyle)
        .addClass('navbox-title')
+
:addClass('navbox-title')
        .attr('colspan', titleColspan)
+
:attr('colspan', titleColspan)
 
    renderNavBar(titleCell)
 
 
    titleCell
 
        .tag('div')
 
            .addClass(args.titleclass)
 
            .css('font-size', '110%')
 
            .newline()
 
            .wikitext(args.title)
 
end
 
 
function renderNavBar(titleCell)
 
    -- Depending on the presence of the navbar and/or show/hide link, we may need to add a spacer div on the left
 
    -- or right to keep the title centered.
 
    local spacerSide = nil
 
  
    if args.navbar == 'off' then
+
renderNavBar(titleCell)
        -- 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 args.navbar == 'off' or (not args.name and (border == 'subgroup' or border == 'child' or border == 'none')) then
 
        -- No navbar. Need a spacer on the left to balance out the width of the show/hide link.
 
        if args.state ~= 'plain' then spacerSide = 'left' end
 
    else
 
        -- Will render navbar (or error message). If there's no show/hide link, need a spacer on the right
 
        -- to balance out the width of the navbar.
 
        if args.state == 'plain' then spacerSide = 'right' end
 
  
        if args.name then
+
titleCell
            titleCell.wikitext(mw.getCurrentFrame():expandTemplate{ title = 'navbar', args = {
+
:tag('div')
                args.name,
+
:attr('id', mw.uri.anchorEncode(args.title))
                mini = 1,
+
:addClass(args.titleclass)
                fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') ..  ';background:none transparent;border:none;'
+
:css('font-size', '114%')
            }})
+
:css('margin', '0 4em')
        else
+
:wikitext(addNewline(args.title))
            titleCell
 
                .tag('span')
 
                    .addClass('error')
 
                    .css('float', 'left')
 
                    .css('white-space', 'nowrap')
 
                    .wikitext('Error: No name provided')
 
        end
 
    end
 
   
 
    -- Render the spacer div.
 
    if spacerSide then
 
        titleCell
 
            .tag('span')
 
                .css('float', spacerSide)
 
                .css('width', '6em')
 
                .wikitext(' ')
 
    end
 
 
end
 
end
 
  
 
--
 
--
 
--  Above/Below rows
 
--  Above/Below rows
 
--
 
--
function renderAboveRow(tbl)
+
 
    if not args.above then return end
+
local function getAboveBelowColspan()
+
local ret = 2
    addTableRow(tbl)
+
if args.imageleft then ret = ret + 1 end
        .tag('td')
+
if args.image then ret = ret + 1 end
            .addClass('navbox-abovebelow')
+
return ret
            .addClass(args.aboveclass)
 
            .cssText(args.basestyle)
 
            .cssText(args.abovestyle)
 
            .attr('colspan', getAboveBelowColspan())
 
            .tag('div')
 
                .newline()
 
                .wikitext(args.above)
 
 
end
 
end
  
function renderBelowRow(tbl)
+
local function renderAboveRow(tbl)
    if not args.below then return end
+
if not args.above then return end
   
+
 
    addTableRow(tbl)
+
addTableRow(tbl)
        .tag('td')
+
:tag('td')
            .addClass('navbox-abovebelow')
+
:addClass('navbox-abovebelow')
            .addClass(args.belowclass)
+
:addClass(args.aboveclass)
            .cssText(args.basestyle)
+
:cssText(args.basestyle)
            .cssText(args.belowstyle)
+
:cssText(args.abovestyle)
            .attr('colspan', getAboveBelowColspan())
+
:attr('colspan', getAboveBelowColspan())
            .tag('div')
+
:tag('div')
                .newline()
+
:wikitext(addNewline(args.above))
                .wikitext(args.below)
 
 
end
 
end
  
function getAboveBelowColspan()
+
local function renderBelowRow(tbl)
    local ret = 2
+
if not args.below then return end
    if args.imageleft then ret = ret + 1 end
+
 
    if args.image then ret = ret + 1 end
+
addTableRow(tbl)
    return ret
+
:tag('td')
 +
:addClass('navbox-abovebelow')
 +
:addClass(args.belowclass)
 +
:cssText(args.basestyle)
 +
:cssText(args.belowstyle)
 +
:attr('colspan', getAboveBelowColspan())
 +
:tag('div')
 +
:wikitext(addNewline(args.below))
 
end
 
end
+
 
 
 
--
 
--
 
--  List rows
 
--  List rows
 
--
 
--
function renderListRow(tbl, listnum)
+
local function renderListRow(tbl, index, listnum)
    local row = addTableRow(tbl)
+
local row = addTableRow(tbl)
   
 
    if listnum == 1 and args.imageleft then
 
        row
 
            .tag('td')
 
                .addClass('navbox-image')
 
                .addClass(args.imageclass)
 
                .css('width', '0%')
 
                .css('padding', '0px 2px 0px 0px')
 
                .cssText(args.imageleftstyle)
 
                .attr('rowspan', 2 * #listnums - 1)
 
                .tag('div')
 
                    .newline()
 
                    .wikitext(args.imageleft)
 
    end
 
 
    if args['group' .. listnum] then
 
        local groupCell = row.tag('th')
 
       
 
        groupCell
 
              .attr('scope', 'row')
 
              .addClass('navbox-group')
 
              .addClass(args.groupclass)
 
              .cssText(args.basestyle)
 
             
 
        if args.groupwidth then
 
            groupCell.css('width', args.groupwidth)
 
        end
 
         
 
        groupCell
 
            .cssText(args.groupstyle)
 
            .cssText(args['group' .. listnum .. 'style'])
 
            .wikitext(args['group' .. listnum])
 
    end
 
   
 
    local listCell = row.tag('td')
 
  
    if args['group' .. listnum] then
+
if index == 1 and args.imageleft then
        listCell
+
row
            .css('text-align', 'left')
+
:tag('td')
            .css('border-left-width', '2px')
+
:addClass('navbox-image')
            .css('border-left-style', 'solid')
+
:addClass(args.imageclass)
    else
+
:css('width', '0%')
        listCell.attr('colspan', 2)
+
:css('padding', '0px 2px 0px 0px')
    end
+
:cssText(args.imageleftstyle)
   
+
:attr('rowspan', 2 * #listnums - 1)
    if not args.groupwidth then
+
:tag('div')
        listCell.css('width', '100%')
+
:wikitext(addNewline(args.imageleft))
    end
+
end
   
 
    local isOdd = (listnum % 2) == 1
 
    local rowstyle = args.evenstyle
 
    if isOdd then rowstyle = args.oddstyle end
 
 
    local evenOdd
 
    if args.evenodd == 'swap' then
 
        if isOdd then evenOdd = 'even' else evenOdd = 'odd' end
 
    else
 
        if isOdd then evenOdd = args.evenodd or 'odd' else evenOdd = args.evenodd or 'even' end
 
    end
 
   
 
    listCell
 
        .css('padding', '0px')
 
        .cssText(args.liststyle)
 
        .cssText(rowstyle)
 
        .cssText(args['list' .. listnum .. 'style'])
 
        .addClass('navbox-list')
 
        .addClass('navbox-' .. evenOdd)
 
        .addClass(args.listclass)
 
        .tag('div')
 
            .css('padding', args.listpadding or '0em 0.25em')
 
            .newline()
 
            .wikitext(args['list' .. listnum])
 
  
    if listnum == 1 and args.image then
+
if args['group' .. listnum] then
        row
+
local groupCell = row:tag('th')
            .tag('td')
+
 
                .addClass('navbox-image')
+
groupCell
                .addClass(args.imageclass)
+
:attr('scope', 'row')
                .css('width', '0%')
+
:addClass('navbox-group')
                .css('padding', '0px 0px 0px 2px')
+
:addClass(args.groupclass)
                .cssText(args.imagestyle)
+
:cssText(args.basestyle)
                .attr('rowspan', 2 * #listnums - 1)
+
 
                .tag('div')
+
if args.groupwidth then
                    .newline()
+
groupCell:css('width', args.groupwidth)
                    .wikitext(args.image)
+
end
    end
+
 
 +
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
 +
:css('text-align', 'left')
 +
:css('border-left-width', '2px')
 +
:css('border-left-style', 'solid')
 +
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)
 +
:tag('div')
 +
:css('padding', (index == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
 +
:wikitext(addNewline(listText))
 +
 
 +
if index == 1 and args.image then
 +
row
 +
:tag('td')
 +
:addClass('navbox-image')
 +
:addClass(args.imageclass)
 +
:css('width', '0%')
 +
:css('padding', '0px 0px 0px 2px')
 +
:cssText(args.imagestyle)
 +
:attr('rowspan', 2 * #listnums - 1)
 +
:tag('div')
 +
:wikitext(addNewline(args.image))
 +
end
 
end
 
end
  
Line 263: Line 277:
 
--  Tracking categories
 
--  Tracking categories
 
--
 
--
function renderTrackingCategories(builder)
+
 
    if not frame then return end
+
local function needsHorizontalLists()
   
+
if border == 'subgroup' or args.tracking == 'no' then
    local s = frame:preprocess('{{#ifeq:{{NAMESPACE}}|{{ns:10}}|1|0}}{{SUBPAGENAME}}')
+
return false
    if mw.ustring.sub(s, 1, 1) == '0' then return end -- not in template space
+
end
    local subpage = mw.ustring.lower(mw.ustring.sub(s, 2))
+
local listClasses = {
    if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end
+
['plainlist'] = true, ['hlist'] = true, ['hlist hnum'] = true,
   
+
['hlist hwrap'] = true, ['hlist vcard'] = true, ['vcard hlist'] = true,
    for i, cat in ipairs(getTrackingCategories()) do
+
['hlist vevent'] = true,
        builder.wikitext('[[Category:' .. cat .. ']]')  
+
}
    end
+
return not (listClasses[args.listclass] or listClasses[args.bodyclass])
 
end
 
end
  
function getTrackingCategories()
+
local function hasBackgroundColors()
    local cats = {}
+
for _, key in ipairs({'titlestyle', 'groupstyle', 'basestyle'}) do
    if needsHorizontalLists() then table.insert(cats, 'Navigational boxes without horizontal lists') end
+
if tostring(args[key]):find('background', 1, true) then
    if hasCustomListSpacing() then table.insert(cats, 'Navigational boxes with custom list spacing') end
+
return true
    if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
+
end
    return cats
+
end
 
end
 
end
  
function needsHorizontalLists()
+
local function isIllegible()
    if border == 'child' or border == 'subgroup'  or args.tracking == 'no' then return false end
+
local styleratio = require('Module:Color contrast')._styleratio
   
 
    local listClasses = {'plainlist', 'hlist', 'hlist hnum', 'hlist vcard', 'vcard hlist'}
 
    for i, cls in ipairs(listClasses) do
 
        if args.listclass == cls or args.bodyclass == cls then
 
            return false
 
        end
 
    end
 
  
    return true
+
for key, style in pairs(args) do
 +
if tostring(key):match("style$") then
 +
if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
 +
return true
 +
end
 +
end
 +
end
 +
return false
 
end
 
end
  
function hasCustomListSpacing()
+
local function getTrackingCategories()
    return args.liststyle == 'padding: 0.25em 0; line-height: 1.3em;' or
+
local cats = {}
          args.liststyle == 'padding:0.25em 0; line-height:1.4em; width:auto;' or
+
if needsHorizontalLists() then table.insert(cats, 'Navigational boxes without horizontal lists') end
          args.liststyle == 'padding:0.4em 0; line-height:1.4em;'
+
if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
 +
if isIllegible() then table.insert(cats, 'Potentially illegible navboxes') end
 +
return cats
 
end
 
end
  
function hasBackgroundColors()
+
local function renderTrackingCategories(builder)
    return args.titlestyle or args.groupstyle
+
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 i, cat in ipairs(getTrackingCategories()) do
 +
builder:wikitext('[[Category:' .. cat .. ']]')
 +
end
 
end
 
end
 
  
 
--
 
--
 
--  Main navbox tables
 
--  Main navbox tables
 
--
 
--
function renderMainTable()
+
local function renderMainTable()
    local tbl = HtmlBuilder.create('table')
+
local tbl = mw.html.create('table')
        .attr('cellspacing', 0)
+
:addClass('nowraplinks')
        .addClass('nowraplinks')
+
:addClass(args.bodyclass)
        .addClass(args.bodyclass)
+
 
           
+
if args.title and (args.state ~= 'plain' and args.state ~= 'off') then
    if args.title and (args.state ~= 'plain' and args.state ~= 'off') then
+
tbl
        tbl
+
:addClass('collapsible')
            .addClass('collapsible')
+
:addClass(args.state or 'autocollapse')
            .addClass(args.state or 'autocollapse')
+
end
    end
+
 
+
tbl:css('border-spacing', 0)
    tbl.css('border-spacing', 0)
+
if border == 'subgroup' or border == 'none' then
    if border == 'subgroup' or border == 'child' or border == 'none' then
+
tbl
        tbl
+
:addClass('navbox-subgroup')
            .addClass('navbox-subgroup')
+
:cssText(args.bodystyle)
            .cssText(args.bodystyle)
+
:cssText(args.style)
            .cssText(args.style)
+
else -- regular navbox - bodystyle and style will be applied to the wrapper table
    else -- regular navobx - bodystyle and style will be applied to the wrapper table
+
tbl
        tbl
+
:addClass('navbox-inner')
            .addClass('navbox-inner')
+
:css('background', 'transparent')
            .css('background', 'transparent')
+
:css('color', 'inherit')
            .css('color', 'inherit')
+
end
    end
+
tbl:cssText(args.innerstyle)
    tbl.cssText(args.innerstyle)
+
 
+
renderTitleRow(tbl)
    renderTitleRow(tbl)
+
renderAboveRow(tbl)
    renderAboveRow(tbl)
+
for i, listnum in ipairs(listnums) do
    for i, listnum in ipairs(listnums) do
+
renderListRow(tbl, i, listnum)
        renderListRow(tbl, listnum)  
+
end
    end
+
renderBelowRow(tbl)
    renderBelowRow(tbl)
+
 
   
+
return tbl
    return tbl
 
 
end
 
end
  
 
function p._navbox(navboxArgs)
 
function p._navbox(navboxArgs)
    args = navboxArgs
+
args = navboxArgs
   
+
 
    for k, v in pairs(args) do
+
for k, v in pairs(args) do
        if v == '' then
+
local listnum = ('' .. k):match('^list(%d+)$')
            -- ParserFunctions considers the empty string to be false, so to preserve the previous
+
if listnum then table.insert(listnums, tonumber(listnum)) end
            -- behavior of {{navbox}}, change any empty arguments to nil, so Lua will consider
+
end
            -- them false too.
+
table.sort(listnums)
            args[k] = nil
 
        else
 
            local listnum = ('' .. k):match('^list(%d+)$')
 
            if listnum then table.insert(listnums, tonumber(listnum)) end
 
        end
 
    end
 
    table.sort(listnums)
 
 
    border = trim(args.border or args[1] or '')
 
  
    -- render the main body of the navbox
+
border = mw.text.trim(args.border or args[1] or '')
    local tbl = renderMainTable()
+
if border == 'child' then
 +
border = 'subgroup'
 +
end
  
    -- render the appropriate wrapper around the navbox, depending on the border param
+
-- render the main body of the navbox
    local res = HtmlBuilder.create()
+
local tbl = renderMainTable()
    if border == 'none' then
+
 
        res.node(tbl)
+
-- render the appropriate wrapper around the navbox, depending on the border param
    elseif border == 'subgroup' or border == 'child' then
+
local res = mw.html.create()
        -- We assume that this navbox is being rendered in a list cell of a parent navbox, and is
+
if border == 'none' then
        -- therefore inside a div with padding:0em 0.25em. We start with a </div> to avoid the
+
local nav = res:tag('div')
        -- padding being applied, and at the end add a <div> to balance out the parent's </div>
+
:attr('role', 'navigation')
        res
+
:node(tbl)
            .tag('/div', {unclosed = true})
+
if args.title then
                .done()
+
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
            .node(tbl)
+
else
            .tag('div', {unclosed = true})
+
nav:attr('aria-label', 'Navbox')
    else
+
end
        res
+
elseif border == 'subgroup' then
            .tag('table')
+
-- We assume that this navbox is being rendered in a list cell of a parent navbox, and is
                .attr('cellspacing', 0)
+
-- therefore inside a div with padding:0em 0.25em. We start with a </div> to avoid the
                .addClass('navbox')
+
-- padding being applied, and at the end add a <div> to balance out the parent's </div>
                .css('border-spacing', 0)
+
res
                .cssText(args.bodystyle)
+
:wikitext('</div>')
                .cssText(args.style)
+
:node(tbl)
                .tag('tr')
+
:wikitext('<div>')
                    .tag('td')
+
else
                        .css('padding', '2px')
+
local nav = res:tag('div')
                        .node(tbl)
+
:attr('role', 'navigation')
    end
+
:addClass('navbox')
+
:cssText(args.bodystyle)
    renderTrackingCategories(res)
+
:cssText(args.style)
+
:css('padding', '3px')
    return tostring(res)
+
:node(tbl)
 +
if args.title then
 +
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
 +
else
 +
nav:attr('aria-label', 'Navbox')
 +
end
 +
end
 +
 
 +
renderTrackingCategories(res)
 +
 
 +
return striped(tostring(res))
 
end
 
end
+
 
function p.navbox(frm)
+
function p.navbox(frame)
    frame = frm
+
if not getArgs then
    return p._navbox(frame:getParent().args)
+
getArgs = require('Module:Arguments').getArgs
 +
end
 +
args = getArgs(frame, {wrappers = 'Template:Navbox'})
 +
 
 +
-- Read the arguments in the order they'll be output in, to make references number in the right order.
 +
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
 
end
+
 
 
return p
 
return p

Latest revision as of 16:51, 12 March 2017

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

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

local p = {}

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

local args
local tableRowAdded = false
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 addNewline(s)
	if s:match('^[*:;#]') or s:match('^{|') then
		return '\n' .. s ..'\n'
	else
		return s
	end
end

local function addTableRow(tbl)
	-- If any other rows have already been added, then we add a 2px gutter row.
	if tableRowAdded then
		tbl
			:tag('tr')
				:css('height', '2px')
				:tag('td')
					:attr('colspan',2)
	end

	tableRowAdded = true

	return tbl:tag('tr')
end

local function renderNavBar(titleCell)

	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{
			args.name,
			mini = 1,
			fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;'
		})
	end

end

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

	local titleRow = addTableRow(tbl)

	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.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')
			:attr('id', mw.uri.anchorEncode(args.title))
			:addClass(args.titleclass)
			:css('font-size', '114%')
			:css('margin', '0 4em')
			:wikitext(addNewline(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

	addTableRow(tbl)
		:tag('td')
			:addClass('navbox-abovebelow')
			:addClass(args.aboveclass)
			:cssText(args.basestyle)
			:cssText(args.abovestyle)
			:attr('colspan', getAboveBelowColspan())
			:tag('div')
				:wikitext(addNewline(args.above))
end

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

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

--
--   List rows
--
local function renderListRow(tbl, index, listnum)
	local row = addTableRow(tbl)

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

	if args['group' .. listnum] then
		local groupCell = row:tag('th')

		groupCell
			:attr('scope', 'row')
			:addClass('navbox-group')
			:addClass(args.groupclass)
			:cssText(args.basestyle)

		if args.groupwidth then
			groupCell:css('width', args.groupwidth)
		end

		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
			:css('text-align', 'left')
			:css('border-left-width', '2px')
			:css('border-left-style', 'solid')
	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)
		:tag('div')
			:css('padding', (index == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
			:wikitext(addNewline(listText))

	if index == 1 and args.image then
		row
			:tag('td')
				:addClass('navbox-image')
				:addClass(args.imageclass)
				:css('width', '0%')
				:css('padding', '0px 0px 0px 2px')
				:cssText(args.imagestyle)
				:attr('rowspan', 2 * #listnums - 1)
				:tag('div')
					:wikitext(addNewline(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

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

local function isIllegible()
	local styleratio = require('Module:Color contrast')._styleratio

	for key, style in pairs(args) do
		if tostring(key):match("style$") then
			if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
				return true
			end
		end
	end
	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
	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 i, 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
		tbl
			:addClass('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

	for k, v in pairs(args) do
		local listnum = ('' .. k):match('^list(%d+)$')
		if listnum then table.insert(listnums, tonumber(listnum)) 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()

	-- render the appropriate wrapper around the navbox, depending on the border param
	local res = mw.html.create()
	if border == 'none' then
		local nav = res:tag('div')
			:attr('role', 'navigation')
			:node(tbl)
		if args.title then
			nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
		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>')
			:node(tbl)
			:wikitext('<div>')
	else
		local nav = res:tag('div')
			:attr('role', 'navigation')
			:addClass('navbox')
			:cssText(args.bodystyle)
			:cssText(args.style)
			:css('padding', '3px')
			:node(tbl)
		if args.title then
			nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
		else
			nav:attr('aria-label', 'Navbox')
		end
	end

	renderTrackingCategories(res)

	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'})

	-- 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