Difference between revisions of "Module:Navbox"

From Timelines
Jump to: navigation, search
(missed an option)
(edit for succinctness)
Line 82: Line 82:
  
  
function formNavBar( div, args )
+
function formNavBar( args )
     local class = 'noprint plainlinks hlist navbar';
+
     if not args[1] then
 +
        local span = HtmlBuilder.create('span')
 +
 
 +
        span
 +
            .addClass('error')
 +
            .css('float', 'left')
 +
            .css('white-space', 'nowrap')
 +
            .wikitext('Error: No name provided')
 +
       
 +
        return span
 +
    end
 +
   
 
     local title;
 
     local title;
     args[1] = trim( args[1] or '' );
+
     local pageName = trim( args[1] )
   
+
     if pageName:sub(1,1) == ':' then
     if args[1] == '' then
+
         title = mw.title.new( pageName:sub(2) );
        title = mw.title.new( '' );
 
    elseif args[1]:sub(1,1) == ':' then
 
         title = mw.title.new( args[1]:sub(2) );
 
 
     else
 
     else
         title = mw.title.new( args[1] );
+
         title = mw.title.new( pageName );
 
         if title.namespace == 0 then
 
         if title.namespace == 0 then
             title = mw.title.new( 'Template:' .. args[1] );
+
             title = mw.title.makeTitle( 'Template', pageName );
         end      
+
         end  
 
     end       
 
     end       
 
      
 
      
     local mainpage, talkpage, editurl;
+
     local mainpage = title.fullText;
    mainpage = title.fullText;
+
     local talkpage = title.talkPageTitle and title.talkPageTitle.fullText or ''
     talkpage = title.talkPageTitle;
+
     local editurl = title:fullUrl( 'action=edit' );  
    talkpage = talkpage.fullText or '';
 
     editurl = title:fullUrl( 'action=edit' );  
 
 
      
 
      
     if args.mini ~= nil then
+
    local viewLink, talkLink, editLink = 'view', 'talk', 'edit'
         class = class .. ' mini';
+
     if args.mini then
 +
         viewLink, talkLink, editLink = 'v', 't', 'e'
 
     end
 
     end
 
+
   
 +
    local div = HtmlBuilder.create( 'div' )
 
     div
 
     div
         .addClass( class )
+
         .addClass( 'noprint' )
         .cssText( args.style or '' )
+
        .addClass( 'plainlinks' )
 +
        .addClass( 'hlist' )
 +
        .addClass( 'navbar')
 +
         .cssText( args.style )
 +
   
 +
    if args.mini then div.addClass('mini') end
 
      
 
      
     if args.mini == nil and args.plain == nil then
+
     if not (args.mini or args.plain) then
         div.tag( 'span' )
+
         div
            .css( 'word-spacing', 0 )
+
            .tag( 'span' )
            .cssText( args.fontstyle or '' )
+
                .css( 'word-spacing', 0 )
            .wikitext( args.text or 'This box:' );
+
                .cssText( args.fontstyle )
 +
                .wikitext( args.text or 'This box:' )
 +
                .wikitext( ' ' )
 
     end
 
     end
 
      
 
      
     if args.brackets ~= nil then
+
     if args.brackets then
         div.wikitext(' ');
+
         div
        div.tag('span')
+
            .tag('span')
            .css('margin-right', '-0.125em')
+
                .css('margin-right', '-0.125em')
            .cssText( args.fontstyle or '' )
+
                .cssText( args.fontstyle )
            .wikitext( '[' )
+
                .wikitext( '[' )
            .newline();
+
                .newline();
 
     end
 
     end
 
      
 
      
 
     local ul = div.tag('ul');
 
     local ul = div.tag('ul');
    local inner
 
    if args.mini ~= nil then
 
        inner = 'v';
 
    else
 
        inner = 'view';
 
    end
 
 
      
 
      
     ul.tag( 'li' )
+
     ul
        .addClass( 'nv-view' )
+
        .tag( 'li' )
        .wikitext( '[[' .. mainpage .. '|' )
+
            .addClass( 'nv-view' )
        .tag( 'span ' )
+
            .wikitext( '[[' .. mainpage .. '|' )
            .attr( 'title', 'View this template' )
+
            .tag( 'span ' )
            .cssText( args.fontstyle or '' )
+
                .attr( 'title', 'View this template' )
             .wikitext( inner )
+
                .cssText( args.fontstyle or '' )
 +
                .wikitext( viewLink )
 +
                .done()
 +
             .wikitext( ']]' )
 
             .done()
 
             .done()
         .wikitext( ']]' );
+
         .tag( 'li' )
 
+
            .addClass( 'nv-talk' )
    if args.mini ~= nil then
+
            .wikitext( '[[' .. talkpage .. '|' )
        inner = 't';
 
    else
 
        inner = 'talk';
 
    end
 
   
 
    ul.tag( 'li' )
 
        .addClass( 'nv-talk' )
 
        .wikitext( '[[' .. talkpage .. '|' )
 
        .tag( 'span ' )
 
            .attr( 'title', 'Discuss this template' )
 
            .cssText( args.fontstyle or '' )
 
            .wikitext( inner )
 
            .done()
 
        .wikitext( ']]' );
 
 
 
    if args.noedit == nil then
 
        if args.mini ~= nil then
 
            inner = 'e';
 
        else
 
            inner = 'edit';
 
        end
 
       
 
        ul.tag( 'li' )
 
            .addClass( 'nv-edit' )
 
            .wikitext( '[' .. editurl .. ' ' )
 
 
             .tag( 'span ' )
 
             .tag( 'span ' )
                 .attr( 'title', 'Edit this template' )
+
                 .attr( 'title', 'Discuss this template' )
 
                 .cssText( args.fontstyle or '' )
 
                 .cssText( args.fontstyle or '' )
                 .wikitext( inner )
+
                 .wikitext( talkLink )
 
                 .done()
 
                 .done()
             .wikitext( ']' );
+
             .wikitext( ']]' );
 +
 
 +
    if not args.noedit then
 +
        ul
 +
            .tag( 'li' )
 +
                .addClass( 'nv-edit' )
 +
                .wikitext( '[' .. editurl .. ' ' )
 +
                .tag( 'span ' )
 +
                    .attr( 'title', 'Edit this template' )
 +
                    .cssText( args.fontstyle or '' )
 +
                    .wikitext( editLink )
 +
                    .done()
 +
                .wikitext( ']' );
 
     end
 
     end
 
      
 
      
     if args.brackets ~= nil then
+
     if args.brackets then
         div.tag('span')
+
         div
            .css('margin-left', '-0.125em')
+
            .tag('span')
            .cssText( args.fontstyle or '' )
+
                .css('margin-left', '-0.125em')
            .wikitext( ']' )
+
                .cssText( args.fontstyle or '' )
            .newline();
+
                .wikitext( ']' )
 +
                .newline();
 
     end
 
     end
  
Line 208: Line 208:
 
         if args.state == 'plain' then spacerSide = 'right' end
 
         if args.state == 'plain' then spacerSide = 'right' end
  
         if args.name then
+
         titleCell.node(formNavBar({
            local div = HtmlBuilder.create('div');
+
             args.name,  
             local args = {
+
            mini = 1,  
                args.name,  
+
            fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') ..  ';background:none transparent;border:none;'
                mini = 1,  
+
        }))
                fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') ..  ';background:none transparent;border:none;'
 
            };
 
       
 
            div = formNavBar( div, args );
 
            titleCell.node( div )
 
        else
 
            titleCell
 
                .tag('span')
 
                    .addClass('error')
 
                    .css('float', 'left')
 
                    .css('white-space', 'nowrap')
 
                    .wikitext('Error: No name provided')
 
        end
 
 
     end
 
     end
 
      
 
      
Line 532: Line 519:
 
         end
 
         end
 
     end
 
     end
    local div = HtmlBuilder.create('div')
+
     return tostring( formNavBar( args ) )
     return tostring( formNavBar( div, args ) )
 
 
end
 
end
 
   
 
   
 
return p
 
return p

Revision as of 18:45, 15 March 2013

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

--
-- This module will implement {{Navbox}}
--
 
local p = {}
 
local HtmlBuilder = require('Module:HtmlBuilder')

local args
local frame
local tableRowAdded = false
local border
local listnums = {}
 
function trim(s)
    return (mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1"))
end

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


--
--   Title row
--
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')
             .addClass(args.titleclass)
             .css('font-size', '110%')
             .newline()
             .wikitext(args.title)
end


function formNavBar( args )
    if not args[1] then
        local span = HtmlBuilder.create('span')

        span
            .addClass('error')
            .css('float', 'left')
            .css('white-space', 'nowrap')
            .wikitext('Error: No name provided')
        
        return span
    end
    
    local title;
    local pageName = trim( args[1] )
    if pageName:sub(1,1) == ':' then
        title = mw.title.new( pageName:sub(2) );
    else
        title = mw.title.new( pageName );
        if title.namespace == 0 then
            title = mw.title.makeTitle( 'Template', pageName );
        end    
    end       
    
    local mainpage = title.fullText;
    local talkpage = title.talkPageTitle and title.talkPageTitle.fullText or ''
    local editurl = title:fullUrl( 'action=edit' ); 
    
    local viewLink, talkLink, editLink = 'view', 'talk', 'edit'
    if args.mini then
        viewLink, talkLink, editLink = 'v', 't', 'e'
    end
    
    local div = HtmlBuilder.create( 'div' )
    div
        .addClass( 'noprint' )
        .addClass( 'plainlinks' )
        .addClass( 'hlist' )
        .addClass( 'navbar')
        .cssText( args.style )
    
    if args.mini then div.addClass('mini') end
    
    if not (args.mini or args.plain) then
        div
            .tag( 'span' )
                .css( 'word-spacing', 0 )
                .cssText( args.fontstyle )
                .wikitext( args.text or 'This box:' )
                .wikitext( ' ' )
    end
    
    if args.brackets then
        div
            .tag('span')
                .css('margin-right', '-0.125em')
                .cssText( args.fontstyle )
                .wikitext( '[' )
                .newline();
    end
    
    local ul = div.tag('ul');
    
    ul
        .tag( 'li' )
            .addClass( 'nv-view' )
            .wikitext( '[[' .. mainpage .. '|' )
            .tag( 'span ' )
                .attr( 'title', 'View this template' )
                .cssText( args.fontstyle or '' )
                .wikitext( viewLink )
                .done()
            .wikitext( ']]' )
            .done()
        .tag( 'li' )
            .addClass( 'nv-talk' )
            .wikitext( '[[' .. talkpage .. '|' )
            .tag( 'span ' )
                .attr( 'title', 'Discuss this template' )
                .cssText( args.fontstyle or '' )
                .wikitext( talkLink )
                .done()
            .wikitext( ']]' );

    if not args.noedit then 
        ul
            .tag( 'li' )
                .addClass( 'nv-edit' )
                .wikitext( '[' .. editurl .. ' ' )
                .tag( 'span ' )
                    .attr( 'title', 'Edit this template' )
                    .cssText( args.fontstyle or '' )
                    .wikitext( editLink )
                    .done()
                .wikitext( ']' );
    end
    
    if args.brackets then
        div
            .tag('span')
                .css('margin-left', '-0.125em')
                .cssText( args.fontstyle or '' )
                .wikitext( ']' )
                .newline();
    end

    return div;
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.node(formNavBar({ 
            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


--
--   Above/Below rows
--
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')
                .newline()
                .wikitext(args.above)
end

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')
                .newline()
                .wikitext(args.below)
end

function getAboveBelowColspan()
    local ret = 2
    if args.imageleft then ret = ret + 1 end
    if args.image then ret = ret + 1 end
    return ret
end
 
 
--
--   List rows
--
function renderListRow(tbl, listnum)
    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
        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 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', (listnum == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
            .newline()
            .wikitext(args['list' .. listnum])

    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


--
--   Tracking categories
--
function renderTrackingCategories(builder)
    local frame = mw.getCurrentFrame()
    
    if not frame then return end
    
    local s = frame:preprocess('{{#ifeq:{{NAMESPACE}}|{{ns:10}}|1|0}}{{SUBPAGENAME}}')
    if mw.ustring.sub(s, 1, 1) == '0' then return end -- not in template space
    local subpage = mw.ustring.lower(mw.ustring.sub(s, 2))
    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

function getTrackingCategories()
    local cats = {}
    if needsHorizontalLists() then table.insert(cats, 'Navigational boxes without horizontal lists') end
    if hasCustomListSpacing() then table.insert(cats, 'Navigational boxes with custom list spacing') end
    if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
    return cats
end

function needsHorizontalLists()
    if border == 'child' or border == 'subgroup'  or args.tracking == 'no' then return false end
    
    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
end

function hasCustomListSpacing()
    return args.liststyle == 'padding: 0.25em 0; line-height: 1.3em;' or 
           args.liststyle == 'padding:0.25em 0; line-height:1.4em; width:auto;' or 
           args.liststyle == 'padding:0.4em 0; line-height:1.4em;'
end

function hasBackgroundColors()
    return args.titlestyle or args.groupstyle
end


--
--   Main navbox tables
--
function renderMainTable()
    local tbl = HtmlBuilder.create('table')
        .attr('cellspacing', 0)
        .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 == 'child' or border == 'none' then
        tbl
            .addClass('navbox-subgroup')
            .cssText(args.bodystyle)
            .cssText(args.style)
    else -- regular navobx - 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, 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 = trim(args.border or args[1] or '')

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

    -- render the appropriate wrapper around the navbox, depending on the border param
    local res = HtmlBuilder.create()
    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)
 
    return tostring(res)
end
 
function p.navbox(frame)
    -- ParserFunctions considers the empty string to be false, so to preserve the previous 
    -- behavior of {{navbox}}, change any empty arguments to nil, so Lua will consider
    -- them false too.
    local args = {}
    for k, v in pairs(frame:getParent().args) do
        if v ~= '' then
            args[k] = v
        end
    end
    return p._navbox(args)
end
 
function p.navbar(frame)
    -- ParserFunctions considers the empty string to be false, so to preserve the previous 
    -- behavior of {{navbox}}, change any empty arguments to nil, so Lua will consider
    -- them false too.
    local args = {}
    for k, v in pairs(frame:getParent().args) do
        if v ~= '' then
            args[k] = v
        end
    end
    return tostring( formNavBar( args ) )
end
 
return p