Módulo:Navbox

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

local p = {}

local navbar = require('Módulo:Navbar')._navbar
local getArgs -- lazily initialized

local args
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 = '[[Categoria:!Navecaixas órfãs]]'
    local argsOrphan = args.orphan or args['órfã']
    if border == 'subgroup' and argsOrphan ~= 'yes' and argsOrphan ~= 'sim' or border == 'subgrupo' and argsOrphan ~= 'yes' and argsOrphan ~= 'sim' then
        -- No change; striping occurs in outermost navbox.
        return wikitext .. orphanCat
    end
    local first, second = 'odd', 'even'
    if args.evenodd or args['pares-ímpares'] then
        if args.evenodd == 'swap' or args.evenodd == 'trocar' or args['pares-ímpares'] == 'swap' or args['pares-ímpares'] == 'trocar' then
            first, second = second, first
        else
            first = args.evenodd or args['pares-ímpares']
            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 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 == 'yes' or nowrapitems == 'sim' then
        local lines = {}
        for line in (item .. '\n'):gmatch('([^\n]*)\n') do
            local prefix, content = line:match('^([*:;#]+)%s*(.*)')
            if prefix and not content:match('^<span class="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

local function renderNavBar(titleCell)

    local argsName = args.name or args.nome
    if args.navbar ~= 'off' and args.navbar ~= 'desligada' and args.navbar ~= 'desligado' and args.navbar ~= 'desligar' and args.navbar ~= 'plain' and args.navbar ~= 'simples' and not (not argsName and mw.getCurrentFrame():getParent():getTitle():gsub('/Testes$', '') == 'Predefinição:Navbox') then
        titleCell:wikitext(navbar{
            argsName,
            mini = 1,
            fontstyle = (args.basestyle or args['estilo-base'] or '') .. ';' .. (args.titlestyle or args['estilo-título'] or '') .. ';background:none transparent;border:none;-moz-box-shadow:none;-webkit-box-shadow:none;box-shadow:none; padding:0;'
        })
    end

end

--
--   Title row
--
local function renderTitleRow(tbl)
    if not args.title and not args['título'] then return end

    local titleRow = tbl:tag('tr')

    if args.titlegroup or args['grupo-título'] then
        titleRow
            :tag('th')
                :attr('scope', 'row')
                :addClass('navbox-group')
                :addClass(args.titlegroupclass or args['classe-grupo-título'])
                :cssText(args.basestyle or args['estilo-base'])
                :cssText(args.groupstyle or args['estilo-grupo'])
                :cssText(args.titlegroupstyle or args['estilo-grupo-título'])
                :wikitext(args.titlegroup or args['grupo-título'])
    end

    local titleCell = titleRow:tag('th'):attr('scope', 'col')

    if args.titlegroup or args['grupo-título'] then
        titleCell
            :css('border-left', '2px solid #fdfdfd')
            :css('width', '100%')
    end

    local titleColspan = 2
    if args.imageleft or args['imagem-esquerda'] then titleColspan = titleColspan + 1 end
    if args.image or args.imagem then titleColspan = titleColspan + 1 end
    if args.titlegroup or args['grupo-título'] then titleColspan = titleColspan - 1 end

    titleCell
        :cssText(args.basestyle or args['estilo-base'])
        :cssText(args.titlestyle or args['estilo-título'])
        :addClass('navbox-title')
        :attr('colspan', titleColspan)

    renderNavBar(titleCell)

    -- CORREÇÃO LINTER: Proteção anti-id duplicado no Título literal
    local titleId = args.title or args['título']
    if titleId and titleId:match('^{{{.-}}}$') then
        titleId = 'navbox-title-' .. math.random(1, 100000)
    else
        titleId = mw.uri.anchorEncode(titleId or '')
    end

    titleCell
        :tag('div')
            -- id for aria-labelledby attribute
            :attr('id', titleId)
            :addClass(args.titleclass or args['classe-título'])
            :css('font-size', '114%')
            :css('margin', '0 4em')
            :wikitext(processItem(args.title or args['título']))
end

--
--   Above/Below rows
--

local function getAboveBelowColspan()
    local ret = 2
    if args.imageleft or args['imagem-esquerda'] then ret = ret + 1 end
    if args.image or args.imagem then ret = ret + 1 end
    return ret
end

-- CORREÇÃO LINTER: Proteção anti-id duplicado na seção Acima
local function renderAboveRow(tbl)
    if not args.above and not args.acima then return end

    local aboveId = args.above or args.acima
    if aboveId and aboveId:match('^{{{.-}}}$') then
        aboveId = 'navbox-above-' .. math.random(1, 100000)
    else
        aboveId = mw.uri.anchorEncode(aboveId or '')
    end

    tbl:tag('tr')
        :tag('td')
            :addClass('navbox-abovebelow')
            :addClass(args.aboveclass or args['classe-acima'])
            :cssText(args.basestyle or args['estilo-base'])
            :cssText(args.abovestyle or args['estilo-acima'])
            :attr('colspan', getAboveBelowColspan())
            :tag('div')
                -- id for aria-labelledby attribute, if no title
                :attr('id', args.title and nil or args['título'] and nil or aboveId)
                :wikitext(processItem(args.above or args.acima, args.nowrapitems or args['nowrap-itens']))
end

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

    tbl:tag('tr')
        :tag('td')
            :addClass('navbox-abovebelow')
            :addClass(args.belowclass or args['classe-abaixo'])
            :cssText(args.basestyle or args['estilo-base'])
            :cssText(args.belowstyle or args['estilo-abaixo'])
            :attr('colspan', getAboveBelowColspan())
            :tag('div')
                :wikitext(processItem(args.below or args.abaixo, args.nowrapitems or args['nowrap-itens']))
end

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

    if index == 1 and args.imageleft or index == 1 and args['imagem-esquerda'] then
        row
            :tag('td')
                :addClass('navbox-image')
                :addClass(args.imageclass or args['classe-imagem'])
                :css('width', '1px')               -- Minimize width
                :css('padding', '0px 2px 0px 0px')
                :cssText(args.imageleftstyle or args['estilo-imagem-esquerda'])
                :attr('rowspan', #listnums)
                :tag('div')
                    :wikitext(processItem(args.imageleft or args['imagem-esquerda']))
    end

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

        -- CORREÇÃO LINTER: Proteção anti-id duplicado no Primeiro Grupo solitário
        if listnum == 1 and not (args.title or args['título'] or args.above or args.acima or args.group2 or args.grupo2) then
            local group1Id = args.group1 or args.grupo1
            if group1Id and group1Id:match('^{{{.-}}}$') then
                group1Id = 'navbox-group1-' .. math.random(1, 100000)
            else
                group1Id = mw.uri.anchorEncode(group1Id or '')
            end
            groupCell:attr('id', group1Id)
        end

        groupCell
            :attr('scope', 'row')
            :addClass('navbox-group')
            :addClass(args.groupclass or args['classe-grupo'])
            :cssText(args.basestyle or args['estilo-base'])
            :css('width', args.groupwidth or args['largura-grupo'] or '1%') -- If groupwidth not specified, minimize width

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

    local listCell = row:tag('td')

    if args['group' .. listnum] or args['grupo' .. 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 and not args['largura-grupo'] then
        listCell:css('width', '100%')
    end

    local rowstyle  -- usually nil so cssText(rowstyle) usually adds nothing
    if index % 2 == 1 then
        rowstyle = args.oddstyle or args['estilo-ímpares']
    else
        rowstyle = args.evenstyle or args['estilo-pares']
    end

    local listText = args['list' .. listnum] or args['lista' .. 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 or args['estilo-lista'])
        :cssText(rowstyle)
        :cssText(args['list' .. listnum .. 'style'] or args['estilo-lista' .. listnum])
        :addClass('navbox-list')
        :addClass('navbox-' .. oddEven)
        :addClass(args.listclass or args['classe-lista'])
        :addClass(args['list' .. listnum .. 'class'] or args['classe-lista' .. listnum])
        :tag('div')
            :css('padding', (index == 1 and args.list1padding) or (index == 1 and args['padding-lista1']) or args.listpadding or args['padding-lista'] or '0em 0.25em')
            :wikitext(processItem(listText, args.nowrapitems or args['nowrap-itens']))

    if index == 1 and args.image or index == 1 and args.imagem then
        row
            :tag('td')
                :addClass('navbox-image')
                :addClass(args.imageclass or args['classe-imagem'])
                :css('width', '1px')               -- Minimize width
                :css('padding', '0px 0px 0px 2px')
                :cssText(args.imagestyle or args['estilo-imagem'])
                :attr('rowspan', #listnums)
                :tag('div')
                    :wikitext(processItem(args.image or args.imagem))
    end
end


--
--   Tracking categories
--

local function needsHorizontalLists()
    if border == 'subgroup' or border == 'subgrupo' or args.tracking == 'no' or args.tracking == 'não' or args['monitoramento'] == 'no' or args['monitoramento'] == 'não' 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['classe-lista']] or listClasses[args.bodyclass] or listClasses[args['classe-corpo']] or listClasses[args.class] or listClasses[args.classe])
end

local function hasBackgroundColors()
    for _, key in ipairs({'titlestyle', 'estilo-título', 'groupstyle', 'estilo-grupo', 'basestyle', 'estilo-base', 'abovestyle', 'estilo-acima', 'belowstyle', 'estilo-abaixo'}) do
        if tostring(args[key]):find('background', 1, true) then
            return true
        end
    end
end

local function hasBorders()
    for _, key in ipairs({'groupstyle', 'estilo-grupo', 'basestyle', 'estilo-base', 'abovestyle', 'estilo-acima', 'belowstyle', 'estilo-abaixo'}) do
        if tostring(args[key]):find('border', 1, true) then
            return true
        end
    end
end

local function isIllegible()
    local styleratio = require('Módulo:Color contrast')._styleratio

    for key, style in pairs(args) do
        if tostring(key):match("style$") or tostring(key):match("^estilo") 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, '!Navecaixas sem listas horizontais') end
    if hasBackgroundColors() then table.insert(cats, '!Navecaixas usando cores de fundo') end
    if isIllegible() then table.insert(cats, '!Navecaixas potencialmente ilegíveis') end
    if hasBorders() then table.insert(cats, '!Navecaixas usando bordas') 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 == 'Testes' or subpage == 'Exemplos para testes' then return end

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

--
--   Main navbox tables
--
local function renderMainTable()
    local argsTitle = args.title or args['título']
    local argsState = args.state or args.estado
    local tbl = mw.html.create('table')
        :addClass('nowraplinks')
        :addClass(args.bodyclass or args['classe-corpo'] or args['class'] or args['classe'])

    if argsTitle and (argsState ~= 'plain' and argsState ~= 'simples' and argsState ~= 'off' and argsState ~= 'desligada' and argsState ~= 'desligado' and argsState ~= 'desligar') then
        tbl
            :addClass('collapsible')
            :addClass(argsState or 'autocollapse')
    end

    tbl:css('border-spacing', 0)
    if border == 'subgroup' or border == 'subgrupo' or border == 'none' or border == 'nenhuma' then
        tbl
            :addClass('navbox-subgroup')
            :cssText(args.bodystyle or args['estilo-corpo'])
            :cssText(args.style or args.estilo)
    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 or args['estilo-interno'])

    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
    listnums = {}

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

    local argsGroup1 = args.group1 or args.grupo1
    local argsGroup2 = args.group2 or args.grupo2

    border = mw.text.trim(args.border or args.borda or args[1] or '')
    if border == 'child' or border == 'filho' or border == 'filha' 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' or border == 'nenhuma' then
        local nav = res:tag('div')
            :attr('role', 'navigation')
            :node(tbl)
        -- aria-labelledby title, otherwise above, otherwise lone group
        if args.title or args['título'] or args.above or args.acima or (argsGroup1 and not argsGroup2) then
            nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args['título'] or args.above or args.acima or args.group1 or args.grupo1))
        else
            nav:attr('aria-label', 'Navbox')
        end
    elseif border == 'subgroup' or border == 'subgrupo' 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')
            :addClass(args.navboxclass or args['classe-navbox'])
            :cssText(args.bodystyle or args['estilo-corpo'])
            :cssText(args.style or args.estilo)
            :css('padding', '3px')
            :node(tbl)
        -- aria-labelledby title, otherwise above, otherwise lone group
        if args.title or args['título'] or args.above or args.acima or (argsGroup1 and not argsGroup2) then
            nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args['título'] or args.above or args.acima or args.group1 or args.grupo1))
        else
            nav:attr('aria-label', 'Navbox')
        end
    end

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

function p.navbox(frame)
    if not getArgs then
        getArgs = require('Módulo:Arguments').getArgs
    end
    args = getArgs(frame, {wrappers = {'Predefinição:Navbox', 'Predefinição:Navbox/lua', 'Predefinição:Navbox subgroup'}})
    if frame.args.border then
        -- This allows Template:Navbox_subgroup to use {{#invoke:Navbox|navbox|border=...}}.
        args.border = frame.args.border or frame.args.borda
    end

    -- Read the arguments in the order they'll be output in, to make references number in the right order.
    local _
    _ = args.title or args['título']
    _ = args.above or args.acima
    for i = 1, 20 do
        _ = args["group" .. tostring(i)] or args["grupo" .. tostring(i)]
        _ = args["list" .. tostring(i)] or args["lista" .. tostring(i)]
    end
    _ = args.below or args.abaixo

    return p._navbox(args)
end

return p
Módulo:Navbox

Descrição

Uso
