Jump to content

Module:Navbox: Difference between revisions

Module:Navbox (edit)

Revision as of 23:51, 12 March 2017

1,318 bytes removed ,  7 years ago
update from Module:Navbox/sandbox per talk; this implements automatic striping that applies to a navbox and any subgroup (child) navboxes it contains
m>Jc86035
(Undid revision 768706907 by Jc86035 (talk) too inefficient to work properly)
m>Johnuniq
(update from Module:Navbox/sandbox per talk; this implements automatic striping that applies to a navbox and any subgroup (child) navboxes it contains)
Line 12: Line 12:
local border
local border
local listnums = {}
local listnums = {}
local ODD_EVEN_MARKER = '\127_ODDEVEN_\127'
local RESTART_MARKER = '\127_ODDEVEN0_\127'
local REGEX_MARKER = '\127_ODDEVEN(%d?)_\127'


local function trim(s)
local function striped(wikitext)
    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 = '[[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
end


local function addNewline(s)
local function addNewline(s)
    if s:match('^[*:;#]') or s:match('^{|') then
if s:match('^[*:;#]') or s:match('^{|') then
        return '\n' .. s ..'\n'
return '\n' .. s ..'\n'
    else
else
        return s
return s
    end
end
end
end


local 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')
                    :attr('colspan',2)
:attr('colspan',2)
    end
end


    tableRowAdded = true
tableRowAdded = true


    return tbl:tag('tr')
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
    -- or right to keep the title centered.
    local spacerSide = nil


    if args.navbar == 'off' then
if args.navbar ~= 'off' and args.navbar ~= 'plain' and not (not args.name and mw.getCurrentFrame():getParent():getTitle():gsub('/sandbox$', '') == 'Template:Navbox') then
        -- No navbar, and client wants no spacer, i.e. wants the title to be shifted to the left. If there's
titleCell:wikitext(navbar{
        -- also no show/hide link, then we need a spacer on the right to achieve the left shift.
args.name,
        if args.state == 'plain' then spacerSide = 'right' end
mini = 1,
    elseif args.navbar == 'plain' or (not args.name and mw.getCurrentFrame():getParent():getTitle():gsub('/sandbox$', '') == 'Template:Navbox') then
fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;'
        -- 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
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


Line 78: Line 96:
--
--
local 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)
renderNavBar(titleCell)


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


Line 128: Line 147:


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


local function renderAboveRow(tbl)
local function renderAboveRow(tbl)
    if not args.above 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.aboveclass)
:addClass(args.aboveclass)
            :cssText(args.basestyle)
:cssText(args.basestyle)
            :cssText(args.abovestyle)
:cssText(args.abovestyle)
            :attr('colspan', getAboveBelowColspan())
:attr('colspan', getAboveBelowColspan())
            :tag('div')
:tag('div')
                :wikitext(addNewline(args.above))
:wikitext(addNewline(args.above))
end
end


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


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


Line 165: Line 184:
--  List rows
--  List rows
--
--
local 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')
                    :wikitext(addNewline(args.imageleft))
    end


    if args['group' .. listnum] then
if index == 1 and args.imageleft then
        local groupCell = row:tag('th')
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


        groupCell
if args['group' .. listnum] then
            :attr('scope', 'row')
local groupCell = row:tag('th')
            :addClass('navbox-group')
            :addClass(args.groupclass)
            :cssText(args.basestyle)


        if args.groupwidth then
groupCell
            groupCell:css('width', args.groupwidth)
:attr('scope', 'row')
        end
:addClass('navbox-group')
:addClass(args.groupclass)
:cssText(args.basestyle)


        groupCell
if args.groupwidth then
            :cssText(args.groupstyle)
groupCell:css('width', args.groupwidth)
            :cssText(args['group' .. listnum .. 'style'])
end
            :wikitext(args['group' .. listnum])
    end


    local listCell = row:tag('td')
groupCell
:cssText(args.groupstyle)
:cssText(args['group' .. listnum .. 'style'])
:wikitext(args['group' .. listnum])
end


    if args['group' .. listnum] then
local listCell = row:tag('td')
        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
if args['group' .. listnum] then
        listCell:css('width', '100%')
listCell
    end
:css('text-align', 'left')
:css('border-left-width', '2px')
:css('border-left-style', 'solid')
else
listCell:attr('colspan', 2)
end


    local isOdd = (listnum % 2) == 1
if not args.groupwidth then
    local rowstyle = args.evenstyle
listCell:css('width', '100%')
    if isOdd then rowstyle = args.oddstyle end
end


    local evenOdd
local rowstyle  -- usually nil so cssText(rowstyle) usually adds nothing
    if args.evenodd == 'swap' then
if index % 2 == 1 then
        if isOdd then evenOdd = 'even' else evenOdd = 'odd' end
rowstyle = args.oddstyle
    else
else
        if isOdd then evenOdd = args.evenodd or 'odd' else evenOdd = args.evenodd or 'even' end
rowstyle = args.evenstyle
    end
end


    listCell
local listText = args['list' .. listnum]
        :css('padding', '0px')
local oddEven = ODD_EVEN_MARKER
        :cssText(args.liststyle)
if listText:sub(1, 12) == '</div><table' then
        :cssText(rowstyle)
-- Assume list text is for a subgroup navbox so no automatic striping for this row.
        :cssText(args['list' .. listnum .. 'style'])
oddEven = listText:find('<th[^>]*"navbox%-title"') and RESTART_MARKER or 'odd'
        :addClass('navbox-list')
end
        :addClass('navbox-' .. evenOdd)
listCell
        :addClass(args.listclass)
:css('padding', '0px')
        :tag('div')
:cssText(args.liststyle)
            :css('padding', (listnum == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
:cssText(rowstyle)
            :wikitext(addNewline(args['list' .. listnum]))
: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 listnum == 1 and args.image then
if index == 1 and args.image then
        row
row
            :tag('td')
:tag('td')
                :addClass('navbox-image')
:addClass('navbox-image')
                :addClass(args.imageclass)
:addClass(args.imageclass)
                :css('width', '0%')
:css('width', '0%')
                :css('padding', '0px 0px 0px 2px')
:css('padding', '0px 0px 0px 2px')
                :cssText(args.imagestyle)
:cssText(args.imagestyle)
                :attr('rowspan', 2 * #listnums - 1)
:attr('rowspan', 2 * #listnums - 1)
                :tag('div')
:tag('div')
                    :wikitext(addNewline(args.image))
:wikitext(addNewline(args.image))
    end
end
end
end


Line 258: Line 279:


local function needsHorizontalLists()
local function needsHorizontalLists()
    if border == 'child' or border == 'subgroup' or args.tracking == 'no' then return false end
if border == 'subgroup' or args.tracking == 'no' then
 
return false
    local listClasses = {'plainlist', 'hlist', 'hlist hnum', 'hlist hwrap', 'hlist vcard', 'vcard hlist', 'hlist vevent'}
end
    for i, cls in ipairs(listClasses) do
local listClasses = {
        if args.listclass == cls or args.bodyclass == cls then
['plainlist'] = true, ['hlist'] = true, ['hlist hnum'] = true,
            return false
['hlist hwrap'] = true, ['hlist vcard'] = true, ['vcard hlist'] = true,
        end
['hlist vevent'] = true,
    end
}
 
return not (listClasses[args.listclass] or listClasses[args.bodyclass])
    return true
end
end


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


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


    for key, style in pairs(args) do
for key, style in pairs(args) do
        if tostring(key):match("style$") then
if tostring(key):match("style$") then
            if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
                return true  
return true
            end
end
        end
end
    end
end
    return false
return false
end
end


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


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


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


Line 310: Line 334:
--
--
local function renderMainTable()
local function renderMainTable()
    local tbl = mw.html.create('table')
local tbl = mw.html.create('table')
        :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 == 'child' or border == 'none' then
if border == 'subgroup' 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 navobx - bodystyle and style will be applied to the wrapper table
else -- regular navbox - bodystyle and style will be applied to the wrapper table
        tbl
tbl
            :addClass('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, listnum)
renderListRow(tbl, i, 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
        local listnum = ('' .. k):match('^list(%d+)$')
local listnum = ('' .. k):match('^list(%d+)$')
        if listnum then table.insert(listnums, tonumber(listnum)) end
if listnum then table.insert(listnums, tonumber(listnum)) end
    end
end
    table.sort(listnums)
table.sort(listnums)


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


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


    -- render the appropriate wrapper around the navbox, depending on the border param
-- render the appropriate wrapper around the navbox, depending on the border param
    local res = mw.html.create()
local res = mw.html.create()
    if border == 'none' then
if border == 'none' then
        local nav = res:tag('div')
local nav = res:tag('div')
            :attr('role', 'navigation')
:attr('role', 'navigation')
            :node(tbl)
:node(tbl)
        if args.title then
if args.title then
            nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
        else
else
            nav:attr('aria-label', 'Navbox')
nav:attr('aria-label', 'Navbox')
        end
end
    elseif border == 'subgroup' or border == 'child' then
elseif border == 'subgroup' then
        -- We assume that this navbox is being rendered in a list cell of a parent navbox, and is
-- 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
-- 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>
-- padding being applied, and at the end add a <div> to balance out the parent's </div>
        res
res
            :wikitext('</div>') -- XXX: hack due to lack of unclosed support in mw.html.
:wikitext('</div>')
            :node(tbl)
:node(tbl)
            :wikitext('<div>') -- XXX: hack due to lack of unclosed support in mw.html.
:wikitext('<div>')
    else
else
        local nav = res:tag('div')
local nav = res:tag('div')
            :attr('role', 'navigation')
:attr('role', 'navigation')
            :addClass('navbox')
:addClass('navbox')
            :cssText(args.bodystyle)
:cssText(args.bodystyle)
            :cssText(args.style)
:cssText(args.style)
            :css('padding', '3px')
:css('padding', '3px')
            :node(tbl)
:node(tbl)
        if args.title then
if args.title then
            nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
        else
else
            nav:attr('aria-label', 'Navbox')
nav:attr('aria-label', 'Navbox')
        end
end
    end
end


    renderTrackingCategories(res)
renderTrackingCategories(res)


    return tostring(res)
return striped(tostring(res))
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 = 'Template: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 number in the right order.
    local _
local _
    _ = args.title
_ = args.title
    _ = args.above
_ = args.above
    for i = 1, 20 do
for i = 1, 20 do
        _ = args["group" .. tostring(i)]
_ = args["group" .. tostring(i)]
        _ = args["list" .. tostring(i)]
_ = args["list" .. tostring(i)]
    end
end
    _ = args.below
_ = args.below


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


return p
return p
Anonymous user
Retrieved from "https://nonbinary.wiki/wiki/Special:MobileDiff/20567"
Cookies help us deliver our services. By using our services, you agree to our use of cookies.
More information