Wikihussain

Module:Navbox: Difference between revisions

Module Discussion

Module:Navbox (edit)

Revision as of 19:33, 26 October 2018

1,087 bytes added ,  26 October 2018
per discussion at WT:Lua, this needs to be initialized in a non-global context
(صفحه‌ای تازه حاوی «-- -- This module will implement {{Navbox}} -- local p = {} local HtmlBuilder = require('Module:HtmlBuilder') local Navbar = require('Mod...» ایجاد کرد)
 
(per discussion at WT:Lua, this needs to be initialized in a non-global context)
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 Navbar = require('Module:Navbar')
local getArgs -- lazily initialized


local args
local args
local frame
local tableRowAdded = false
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'


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


function addTableRow(tbl)
local function processItem(item, nowrapitems)
    -- If any other rows have already been added, then we add a 2px gutter row.
if item:sub(1, 2) == '{|' then
    if tableRowAdded then
-- Applying nowrap to lines in a table does not make sense.
        tbl
-- Add newlines to compensate for trim of x in |parm=x in a template.
            .tag('tr')
return '\n' .. item ..'\n'
                .css('height', '2px')
end
                .tag('td')
if nowrapitems == 'yes' then
    end
local lines = {}
for line in (item .. '\n'):gmatch('([^\n]*)\n') do
local prefix, content = line:match('^([*:;#]+)%s*(.*)')
if prefix and not content:match('^<span class="nowrap">') then
line = prefix .. '<span class="nowrap">' .. content .. '</span>'
end
table.insert(lines, line)
end
item = table.concat(lines, '\n')
end
if item:match('^[*:;#]') then
return '\n' .. item ..'\n'
end
return item
end


    tableRowAdded = true
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;-moz-box-shadow:none;-webkit-box-shadow:none;box-shadow:none; padding:0;'
})
end


    return tbl.tag('tr')
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 = tbl:tag('tr')


    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')
            .addClass(args.titleclass)
-- id for aria-labelledby attribute
            .css('font-size', '110%')
:attr('id', mw.uri.anchorEncode(args.title))
            .newline()
:addClass(args.titleclass)
            .wikitext(args.title)
:css('font-size', '114%')
:css('margin', '0 4em')
:wikitext(processItem(args.title))
end
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
        -- 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
        titleCell.wikitext(Navbar.navbar({
            args.name,
            mini = 1,
            fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') ..  ';background:none transparent;border:none;'
        }))
    end
    -- Render the spacer div.
    --            .css('float', spacerSide)
    if spacerSide then
        titleCell
            .tag('span')
   
                .css('float', 'right')
                .css('width', '6em')
                .wikitext('&nbsp;')
    end
end


--
--
--  Above/Below rows
--  Above/Below rows
--
--
function renderAboveRow(tbl)
    if not args.above then return end


    addTableRow(tbl)
local function getAboveBelowColspan()
        .tag('td')
local ret = 2
            .addClass('navbox-abovebelow')
if args.imageleft then ret = ret + 1 end
            .addClass(args.aboveclass)
if args.image then ret = ret + 1 end
            .cssText(args.basestyle)
return ret
            .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)
tbl:tag('tr')
        .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()
-- id for aria-labelledby attribute, if no title
                .wikitext(args.below)
:attr('id', args.title and nil or mw.uri.anchorEncode(args.above))
:wikitext(processItem(args.above, args.nowrapitems))
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
tbl:tag('tr')
    return ret
:tag('td')
:addClass('navbox-abovebelow')
:addClass(args.belowclass)
:cssText(args.basestyle)
:cssText(args.belowstyle)
:attr('colspan', getAboveBelowColspan())
:tag('div')
:wikitext(processItem(args.below, args.nowrapitems))
end
end


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


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


    if args['group' .. listnum] then
if args['group' .. listnum] then
        local groupCell = row.tag('th')
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.title or args.above or args.group2) then
              .addClass('navbox-group')
groupCell
              .addClass(args.groupclass)
:attr('id', mw.uri.anchorEncode(args.group1))
              .cssText(args.basestyle)
end


        if args.groupwidth then
groupCell
            groupCell.css('width', args.groupwidth)
:attr('scope', 'row')
        end
:addClass('navbox-group')
:addClass(args.groupclass)
:cssText(args.basestyle)
:css('width', args.groupwidth or '1%') -- If groupwidth not specified, minimize width


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


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


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


    if not args.groupwidth then
if not args.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.oddstyle
else
rowstyle = args.evenstyle
end


    local evenOdd
local listText = args['list' .. listnum]
    if args.evenodd == 'swap' then
local oddEven = ODD_EVEN_MARKER
        if isOdd then evenOdd = 'even' else evenOdd = 'odd' end
if listText:sub(1, 12) == '</div><table' then
    else
-- Assume list text is for a subgroup navbox so no automatic striping for this row.
        if isOdd then evenOdd = args.evenodd or 'odd' else evenOdd = args.evenodd or 'even' end
oddEven = listText:find('<th[^>]*"navbox%-title"') and RESTART_MARKER or 'odd'
    end
end
listCell
:css('padding', '0px')
:cssText(args.liststyle)
:cssText(rowstyle)
:cssText(args['list' .. listnum .. 'style'])
:addClass('navbox-list')
:addClass('navbox-' .. oddEven)
:addClass(args.listclass)
:addClass(args['list' .. listnum .. 'class'])
:tag('div')
:css('padding', (index == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
:wikitext(processItem(listText, args.nowrapitems))


    listCell
if index == 1 and args.image then
        .css('padding', '0px')
row
        .cssText(args.liststyle)
:tag('td')
        .cssText(rowstyle)
:addClass('navbox-image')
        .cssText(args['list' .. listnum .. 'style'])
:addClass(args.imageclass)
        .addClass('navbox-list')
:css('width', '1px')               -- Minimize width
        .addClass('navbox-' .. evenOdd)
:css('padding', '0px 0px 0px 2px')
        .addClass(args.listclass)
:cssText(args.imagestyle)
        .tag('div')
:attr('rowspan', #listnums)
            .css('padding', (listnum == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
:tag('div')
            .newline()
:wikitext(processItem(args.image))
            .wikitext(args['list' .. listnum])
end
 
    if listnum == 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')
                    .newline()
                    .wikitext(args.image)
    end
end
end


Line 257: Line 283:
--  Tracking categories
--  Tracking categories
--
--
function renderTrackingCategories(builder)
    local frame = mw.getCurrentFrame()


    if not frame then return end
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 s = frame:preprocess('{{#ifeq:{{NAMESPACE}}|{{ns:10}}|1|0}}{{SUBPAGENAME}}')
local function hasBackgroundColors()
    if mw.ustring.sub(s, 1, 1) == '0' then return end -- not in template space
for _, key in ipairs({'titlestyle', 'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
    local subpage = mw.ustring.lower(mw.ustring.sub(s, 2))
if tostring(args[key]):find('background', 1, true) then
    if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end
return true
 
end
    for i, cat in ipairs(getTrackingCategories()) do
end
        builder.wikitext('')
    end
end
end


function getTrackingCategories()
local function hasBorders()
    local cats = {}
for _, key in ipairs({'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
    if needsHorizontalLists() then table.insert(cats, 'Navigational boxes without horizontal lists') end
if tostring(args[key]):find('border', 1, true) then
    if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
return true
    return cats
end
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 hwrap', 'hlist vcard', 'vcard hlist', 'hlist vevent'}
for key, style in pairs(args) do
    for i, cls in ipairs(listClasses) do
if tostring(key):match("style$") then
        if args.listclass == cls or args.bodyclass == cls then
if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
            return false
return true
        end
end
    end
end
end
return false
end


    return true
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
if hasBorders() then table.insert(cats, 'Navboxes using borders') 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 _, 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 == '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
 
listnums = {}
    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 = trim(args.border or args[1] or '')
for k, _ in pairs(args) do
if type(k) == 'string' then
local listnum = k:match('^list(%d+)$')
if listnum then table.insert(listnums, tonumber(listnum)) end
end
end
table.sort(listnums)


    -- 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)
    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
            .tag('/div', {unclosed = true})
                .done()
            .node(tbl)
            .tag('div', {unclosed = true})
    else
        res
            .tag('table')
                .attr('cellspacing', 0)
                .addClass('navbox')
                .css('border-spacing', 0)
                .cssText(args.bodystyle)
                .cssText(args.style)
                .tag('tr')
                    .tag('td')
                        .css('padding', '2px')
                        .node(tbl)
    end


    renderTrackingCategories(res)
-- 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)
-- aria-labelledby title, otherwise above, otherwise lone group
if args.title or args.above or (args.group1 and not args.group2) then
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args.above or args.group1))
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)
-- aria-labelledby title, otherwise above, otherwise lone group
if args.title or args.above or (args.group1 and not args.group2) then
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args.above or args.group1))
else
nav:attr('aria-label', 'Navbox')
end
end


    return tostring(res)
if (args.nocat or 'false'):lower() == 'false' then
renderTrackingCategories(res)
end
return striped(tostring(res))
end
end


function p.navbox(frame)
function p.navbox(frame)
    -- ParserFunctions considers the empty string to be false, so to preserve the previous
if not getArgs then
    -- behavior of {{navbox}}, change any empty arguments to nil, so Lua will consider
getArgs = require('Module:Arguments').getArgs
    -- them false too.
end
    local args = {}
args = getArgs(frame, {wrappers = {'Template:Navbox', 'Template:Navbox subgroup'}})
    local parent_args = frame:getParent().args;
if frame.args.border then
-- This allows Template:Navbox_subgroup to use {{#invoke:Navbox|navbox|border=...}}.
args.border = frame.args.border
end


    -- Out of order parsing bug.
-- Read the arguments in the order they'll be output in, to make references number in the right order.
    local temp;
local _
    temp = parent_args.title;
_ = args.title
    temp = parent_args.above;
_ = args.above
    for i = 1, 20 do
for i = 1, 20 do
        temp = parent_args["group" .. tostring(i)];
_ = args["group" .. tostring(i)]
        temp = parent_args["list" .. tostring(i)];
_ = args["list" .. tostring(i)]
    end
end
    temp = parent_args.below;
_ = args.below


    for k, v in pairs(parent_args) do
return p._navbox(args)
        if v ~= '' then
            args[k] = v
        end
    end
    return p._navbox(args)
end
end


return p
return p
Anonymous user
Retrieved from "https://en.wikihussain.com/view/Special:MobileDiff/8769"