Difference between revisions of "Module:Sidebar"

From LIMSWiki
Jump to navigationJump to search
(Created as needed.)
 
(Attempting update of Navbox code to Lua)
Line 2: Line 2:
-- This module implements {{Sidebar}}
-- This module implements {{Sidebar}}
--
--
require('Module:No globals')
 
local p = {}
local p = {}
 
local HtmlBuilder = require('Module:HtmlBuilder')
local getArgs = require('Module:Arguments').getArgs
local Navbar = require('Module:Navbar')
local navbar = require('Module:Navbar')._navbar
 
local function trimAndAddAutomaticNewline(s)
local function trimAndAddAutomaticNewline(s)
    -- For compatibility with the original {{sidebar with collapsible lists}}  
-- For compatibility with the original {{sidebar with collapsible lists}}
    -- implementation, which passed some parameters through {{#if}} to trim
-- implementation, which passed some parameters through {{#if}} to trim
    -- their whitespace. This also triggered the automatic newline behavior.
-- their whitespace. This also triggered the automatic newline behavior.
    -- ([[meta:Help:Newlines and spaces#Automatic newline]])
-- ([[meta:Help:Newlines and spaces#Automatic newline]])
    s = mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1")
s = mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1")
    if mw.ustring.find(s, '^[#*:;]') or mw.ustring.find(s, '^{|') then
if mw.ustring.find(s, '^[#*:;]') or mw.ustring.find(s, '^{|') then
        return '\n' .. s
return '\n' .. s
    else
else
        return s
return s
    end
end
end
end


local function _sidebar(args)
function p.sidebar(frame, args)
    local root = HtmlBuilder.create('table')
if not args then
   
args = getArgs(frame)
    root
end
        .addClass('vertical-navbox')
local root = mw.html.create()
        .addClass(args.wraplinks ~= 'true' and 'nowraplinks')
local child = args.child and mw.text.trim(args.child) == 'yes'
        .addClass(args.bodyclass or args.class)
 
        .attr('cellspacing', args.cellspacing or 5)
if not child then
        .attr('cellpadding', args.cellpadding or 0)
root = root
        .css('float', args.float or 'right')
:tag('table')
        .css('clear', (args.float == 'none' and 'both') or args.float or 'right')
:addClass('vertical-navbox')
        .css('width', args.width or '22.0em')
:addClass(args.wraplinks ~= 'true' and 'nowraplinks' or nil)
        .css('margin', args.float == 'left' and '0 1.0em 1.0em 0' or '0 0 1.0em 1.0em')
:addClass(args.bodyclass or args.class)
        .css('background', '#f9f9f9')
:css('float', args.float or 'right')
        .css('border', '1px solid #aaa')
:css('clear', (args.float == 'none' and 'both') or args.float or 'right')
        .css('padding', '0.2em')
:css('width', args.width or '22.0em')
        .css('border-spacing', '0.4em 0')
:css('margin', args.float == 'left' and '0 1.0em 1.0em 0' or '0 0 1.0em 1.0em')
        .css('text-align', 'center')
:css('background', '#f9f9f9')
        .css('line-height', '1.4em')
:css('border', '1px solid #aaa')
        .css('font-size', '88%')
:css('padding', '0.2em')
        .cssText(args.bodystyle or args.style)
:css('border-spacing', '0.4em 0')
:css('text-align', 'center')
:css('line-height', '1.4em')
:css('font-size', '88%')
:cssText(args.bodystyle or args.style)
 
if args.outertitle then
root
:tag('caption')
:addClass(args.outertitleclass)
:css('padding-bottom', '0.2em')
:css('font-size', '125%')
:css('line-height', '1.2em')
:css('font-weight', 'bold')
:cssText(args.outertitlestyle)
:wikitext(args.outertitle)
end
 
if args.topimage then
local imageCell = root:tag('tr'):tag('td')


    if args.outertitle then
imageCell
        root
:addClass(args.topimageclass)
            .tag('caption')
:css('padding', '0.4em 0')
                .addClass(args.outertitleclass)
:cssText(args.topimagestyle)
                .css('padding-bottom', '0.2em')
:wikitext(args.topimage)
                .css('font-size', '125%')
                .css('line-height', '1.2em')
                .css('font-weight', 'bold')
                .cssText(args.outertitlestyle)
                .wikitext(args.outertitle)
    end


    if args.topimage then
if args.topcaption then
        local imageCell = root.tag('tr').tag('td')
imageCell
       
:tag('div')
        imageCell
:css('padding-top', '0.2em')
            .addClass(args.topimageclass)
:css('line-height', '1.2em')
            .css('padding', '0.4em 0')
:cssText(args.topcaptionstyle)
            .cssText(args.topimagestyle)
:wikitext(args.topcaption)
            .wikitext(args.topimage)
end
       
end
        if args.topcaption then
            imageCell
                .tag('div')
                    .css('padding-top', '0.2em')
                    .css('line-height', '1.2em')
                    .cssText(args.topcaptionstyle)
                    .wikitext(args.topcaption)
        end
    end
   
    if args.pretitle then
        root
            .tag('tr')
                .tag('td')
                    .addClass(args.pretitleclass)
                    .cssText(args.basestyle)
                    .css('padding-top', args.topimage and '0.2em' or '0.4em')
                    .css('line-height', '1.2em')
                    .cssText(args.pretitlestyle)
                    .wikitext(args.pretitle)
    end


    if args.title then
if args.pretitle then
        root
root
            .tag('tr')
:tag('tr')
                .tag('th')
:tag('td')
                    .addClass(args.titleclass)
:addClass(args.pretitleclass)
                    .cssText(args.basestyle)
:cssText(args.basestyle)
                    .css('padding', '0.2em 0.4em 0.2em')
:css('padding-top', args.topimage and '0.2em' or '0.4em')
                    .css('padding-top', args.pretitle and 0)
:css('line-height', '1.2em')
                    .css('font-size', '145%')
:cssText(args.pretitlestyle)
                    .css('line-height', '1.2em')
:wikitext(args.pretitle)
                    .cssText(args.titlestyle)
end
                    .wikitext(args.title)
    end


    if args.image then
end
        local imageCell = root.tag('tr').tag('td')
       
        imageCell
            .addClass(args.imageclass)
            .css('padding', '0.2em 0 0.4em')
            .cssText(args.imagestyle)
            .wikitext(args.image)
           
        if args.caption then
            imageCell
                .tag('div')
                    .css('padding-top', '0.2em')
                    .css('line-height', '1.2em')
                    .cssText(args.captionstyle)
                    .wikitext(args.caption)
        end
    end
   
    if args.above then
        root
            .tag('tr')
                .tag('td')
                    .addClass(args.aboveclass)
                    .css('padding', '0.3em 0.4em 0.3em')
                    .css('font-weight', 'bold')
                    .cssText(args.abovestyle)
                    .newline()      -- newline required for bullet-points to work
                    .wikitext(args.above)
    end


    local rowNums = {}
if args.title then
    for k, v in pairs(args) do
if child then
        k = '' .. k
root
        local num = k:match('^heading(%d+)$') or k:match('^content(%d+)$')
:wikitext(args.title)
        if num then table.insert(rowNums, tonumber(num)) end
:wikitext('</th></tr>') -- @todo replace this with unclosed again once mw.html gets it
    end
else
    table.sort(rowNums)
root
    -- remove duplicates from the list (e.g. 3 will be duplicated if both heading3 and content3 are specified)
:tag('tr')
    for i = #rowNums, 1, -1 do
:tag('th')
        if rowNums[i] == rowNums[i - 1] then
:addClass(args.titleclass)
            table.remove(rowNums, i)
:cssText(args.basestyle)
        end
:css('padding', '0.2em 0.4em 0.2em')
    end
:css('padding-top', args.pretitle and 0)
:css('font-size', '145%')
:css('line-height', '1.2em')
:cssText(args.titlestyle)
:wikitext(args.title)
end
end


    for i, num in ipairs(rowNums) do
if args.image then
        local heading = args['heading' .. num]
local imageCell = root:tag('tr'):tag('td')
        if heading then
            root
                .tag('tr')
                    .tag('th')
                        .addClass(args.headingclass)
                        .css('padding', '0.1em')
                        .cssText(args.basestyle)
                        .cssText(args.headingstyle)
                        .cssText(args['heading' .. num .. 'style'])
                        .wikitext(heading)
        end
       
        local content = args['content' .. num]
        if content then
            root
                .tag('tr')
                    .tag('td')
                        .addClass(args.contentclass)
                        .css('padding', '0 0.1em 0.4em')
                        .cssText(args.contentstyle)
                        .cssText(args['content' .. num .. 'style'])
                        .newline()
                        .wikitext(content)
                        .done()
                    .newline()  -- Without a linebreak after the </td>, a nested list like "* {{hlist| ...}}" doesn't parse correctly.
        end
    end


    if args.below then
imageCell
        root
:addClass(args.imageclass)
            .tag('tr')
:css('padding', '0.2em 0 0.4em')
                .tag('td')
:cssText(args.imagestyle)
                    .addClass(args.belowclass)
:wikitext(args.image)
                    .css('padding', '0.3em 0.4em 0.3em')
                    .css('font-weight', 'bold')
                    .cssText(args.belowstyle)
                    .newline()
                    .wikitext(args.below)
    end


    local navbarArg = args.navbar or args.tnavbar
if args.caption then
    if navbarArg ~= 'none' and navbarArg ~= 'off' then
imageCell
        root
:tag('div')
            .tag('tr')
:css('padding-top', '0.2em')
                .tag('td')
:css('line-height', '1.2em')
                    .css('text-align', 'right')
:cssText(args.captionstyle)
                    .css('font-size', '115%')
:wikitext(args.caption)
                    .cssText(args.navbarstyle or args.tnavbarstyle)
end
                    .wikitext(Navbar.navbar({
end
                        args.name or mw.title.getCurrentTitle().fullText,
                        mini = 1,
                        fontstyle = args.navbarfontstyle or args.tnavbarfontstyle
                    }))
    end  


    return tostring(root)
if args.above then
root
:tag('tr')
:tag('td')
:addClass(args.aboveclass)
:css('padding', '0.3em 0.4em 0.3em')
:css('font-weight', 'bold')
:cssText(args.abovestyle)
:newline() -- newline required for bullet-points to work
:wikitext(args.above)
end
 
local rowNums = {}
for k, v in pairs(args) do
k = '' .. k
local num = k:match('^heading(%d+)$') or k:match('^content(%d+)$')
if num then table.insert(rowNums, tonumber(num)) end
end
table.sort(rowNums)
-- remove duplicates from the list (e.g. 3 will be duplicated if both heading3 and content3 are specified)
for i = #rowNums, 1, -1 do
if rowNums[i] == rowNums[i - 1] then
table.remove(rowNums, i)
end
end
 
for i, num in ipairs(rowNums) do
local heading = args['heading' .. num]
if heading then
root
:tag('tr')
:tag('th')
:addClass(args.headingclass)
:css('padding', '0.1em')
:cssText(args.basestyle)
:cssText(args.headingstyle)
:cssText(args['heading' .. num .. 'style'])
:newline()
:wikitext(heading)
end
 
local content = args['content' .. num]
if content then
root
:tag('tr')
:tag('td')
:addClass(args.contentclass)
:css('padding', '0 0.1em 0.4em')
:cssText(args.contentstyle)
:cssText(args['content' .. num .. 'style'])
:newline()
:wikitext(content)
:done()
:newline() -- Without a linebreak after the </td>, a nested list like "* {{hlist| ...}}" doesn't parse correctly.
end
end
 
if args.below then
root
:tag('tr')
:tag('td')
:addClass(args.belowclass)
:css('padding', '0.3em 0.4em 0.3em')
:css('font-weight', 'bold')
:cssText(args.belowstyle)
:newline()
:wikitext(args.below)
end
 
if not child then
local navbarArg = args.navbar or args.tnavbar
if navbarArg ~= 'none' and navbarArg ~= 'off' and (args.name or frame:getParent():getTitle():gsub('/sandbox$', '') ~= 'Template:Sidebar') then
root
:tag('tr')
:tag('td')
:css('text-align', 'right')
:css('font-size', '115%')
:cssText(args.navbarstyle or args.tnavbarstyle)
:wikitext(navbar{
args.name,
mini = 1,
fontstyle = args.navbarfontstyle or args.tnavbarfontstyle
})
end
end
 
return tostring(root)
end
end


function _collapsibleSidebar(args)
function p.collapsible(frame)
    args.abovestyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.abovestyle or '')
local args = getArgs(frame)
    args.belowstyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.belowstyle or '')
    args.navbarstyle = 'padding-top: 0.6em;' .. (args.navbarstyle or args.tnavbarstyle or '')
   
    local contentArgs = {}
   
    for k, v in pairs(args) do
        local num = ('' .. k):match('^list(%d+)$')
        if num then
            local expand = args.expanded and (args.expanded == 'all' or args.expanded == args['list' .. num .. 'name'])
           
            local row = HtmlBuilder.create('div')
            row
                .addClass('NavFrame')
                .addClass((not expand) and 'collapsed')
                .css('border', 'none')
                .css('padding', 0)
                .cssText(args.listframestyle)
                .cssText(args['list' .. num .. 'framestyle'])
                .tag('div')
                    .addClass('NavHead')
                    .addClass(args.listtitleclass)
                    .css('font-size', '105%')
                    .css('background', 'transparent')
                    .css('text-align', 'left')
                    .cssText(args.basestyle)
                    .cssText(args.listtitlestyle)
                    .cssText(args['list' .. num .. 'titlestyle'])
                    .wikitext(trimAndAddAutomaticNewline(args['list' .. num .. 'title'] or 'List'))
                    .done()
                .tag('div')
                    .addClass('NavContent')
                    .addClass(args.listclass)
                    .addClass(args['list' .. num .. 'class'])
                    .css('font-size', '105%')
                    .css('padding', '0.2em 0 0.4em')
                    .css('text-align', 'center')
                    .cssText(args.liststyle)
                    .cssText(args['list' .. num .. 'style'])
                    .wikitext(trimAndAddAutomaticNewline(args['list' .. num]))
                   
            contentArgs['content' .. num] = tostring(row)
        end
    end


    for k, v in pairs(contentArgs) do
args.abovestyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.abovestyle or '')
        args[k] = v
args.belowstyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.belowstyle or '')
    end
args.navbarstyle = 'padding-top: 0.6em;' .. (args.navbarstyle or args.tnavbarstyle or '')
   
if not args.name and frame:getParent():getTitle():gsub('/sandbox$', '') == 'Template:Sidebar with collapsible lists' then
    return _sidebar(args)
args.navbar = 'none'
end
end
                     
 
function makeWrapper(func)
local contentArgs = {}
    return function(frame)
 
        local origArgs
for k, v in pairs(args) do
        if frame == mw.getCurrentFrame() then
local num = string.match(k, '^list(%d+)$')
            -- We're being called via #invoke. If the invoking template passed any args, use
if num then
            -- them. Otherwise, use the args that were passed into the template.
local expand = args.expanded and (args.expanded == 'all' or args.expanded == args['list' .. num .. 'name'])
            origArgs = frame:getParent().args
 
            for k, v in pairs(frame.args) do
local row = mw.html.create('div')
                origArgs = frame.args
row
                break
:addClass('NavFrame')
            end
:addClass((not expand) and 'collapsed' or nil)
        else
:css('border', 'none')
            -- We're being called from another module or from the debug console, so assume
:css('padding', 0)
            -- the args are passed in directly.
:cssText(args.listframestyle)
            origArgs = frame
:cssText(args['list' .. num .. 'framestyle'])
        end
:tag('div')
   
:addClass('NavHead')
        -- ParserFunctions considers the empty string to be false, so to preserve the previous
:addClass(args.listtitleclass)
        -- behavior of the template, change any empty arguments to nil, so Lua will consider
:css('font-size', '105%')
        -- them false too.
:css('background', 'transparent')
        local args = {}
:css('text-align', 'left')
        for k, v in pairs(origArgs) do
:cssText(args.basestyle)
            if v ~= '' then
:cssText(args.listtitlestyle)
                args[k] = v
:cssText(args['list' .. num .. 'titlestyle'])
            end
:wikitext(trimAndAddAutomaticNewline(args['list' .. num .. 'title'] or 'List'))
        end
:done()
   
:tag('div')
        return func(args)
:addClass('NavContent')
    end
:addClass(args.listclass)
:addClass(args['list' .. num .. 'class'])
:css('font-size', '105%')
:css('padding', '0.2em 0 0.4em')
:css('text-align', 'center')
:cssText(args.liststyle)
:cssText(args['list' .. num .. 'style'])
:wikitext(trimAndAddAutomaticNewline(args['list' .. num]))
 
contentArgs['content' .. num] = tostring(row)
end
end
 
for k, v in pairs(contentArgs) do
args[k] = v
end
 
return p.sidebar(frame, args)
end
end


return {
return p
    sidebar = makeWrapper(_sidebar),
    collapsible = makeWrapper(_collapsibleSidebar)
}

Revision as of 18:34, 16 February 2016

--

-- This module implements

-- require('Module:No globals')

local p = {}

local getArgs = require('Module:Arguments').getArgs local navbar = require('Module:Navbar')._navbar

local function trimAndAddAutomaticNewline(s)

-- For compatibility with the original

-- implementation, which passed some parameters through {{#if}} to trim -- their whitespace. This also triggered the automatic newline behavior. -- (meta:Help:Newlines and spaces#Automatic newline) s = mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1") if mw.ustring.find(s, '^[#*:;]') or mw.ustring.find(s, '^{|') then return '\n' .. s else return s end end

function p.sidebar(frame, args) if not args then args = getArgs(frame) end local root = mw.html.create() local child = args.child and mw.text.trim(args.child) == 'yes'

if not child then root = root :tag('table') :addClass('vertical-navbox') :addClass(args.wraplinks ~= 'true' and 'nowraplinks' or nil) :addClass(args.bodyclass or args.class) :css('float', args.float or 'right') :css('clear', (args.float == 'none' and 'both') or args.float or 'right') :css('width', args.width or '22.0em') :css('margin', args.float == 'left' and '0 1.0em 1.0em 0' or '0 0 1.0em 1.0em') :css('background', '#f9f9f9') :css('border', '1px solid #aaa') :css('padding', '0.2em') :css('border-spacing', '0.4em 0') :css('text-align', 'center') :css('line-height', '1.4em') :css('font-size', '88%') :cssText(args.bodystyle or args.style)

if args.outertitle then root :tag('caption') :addClass(args.outertitleclass) :css('padding-bottom', '0.2em') :css('font-size', '125%') :css('line-height', '1.2em') :css('font-weight', 'bold') :cssText(args.outertitlestyle) :wikitext(args.outertitle) end

if args.topimage then local imageCell = root:tag('tr'):tag('td')

imageCell :addClass(args.topimageclass) :css('padding', '0.4em 0') :cssText(args.topimagestyle) :wikitext(args.topimage)

if args.topcaption then imageCell :tag('div') :css('padding-top', '0.2em') :css('line-height', '1.2em') :cssText(args.topcaptionstyle) :wikitext(args.topcaption) end end

if args.pretitle then root :tag('tr') :tag('td') :addClass(args.pretitleclass) :cssText(args.basestyle) :css('padding-top', args.topimage and '0.2em' or '0.4em') :css('line-height', '1.2em') :cssText(args.pretitlestyle) :wikitext(args.pretitle) end

end

if args.title then if child then root :wikitext(args.title)

:wikitext('') -- @todo replace this with unclosed again once mw.html gets it else root :tag('tr') :tag('th') :addClass(args.titleclass) :cssText(args.basestyle) :css('padding', '0.2em 0.4em 0.2em') :css('padding-top', args.pretitle and 0) :css('font-size', '145%') :css('line-height', '1.2em') :cssText(args.titlestyle) :wikitext(args.title) end end if args.image then local imageCell = root:tag('tr'):tag('td') imageCell :addClass(args.imageclass) :css('padding', '0.2em 0 0.4em') :cssText(args.imagestyle) :wikitext(args.image) if args.caption then imageCell :tag('div') :css('padding-top', '0.2em') :css('line-height', '1.2em') :cssText(args.captionstyle) :wikitext(args.caption) end end if args.above then root :tag('tr') :tag('td') :addClass(args.aboveclass) :css('padding', '0.3em 0.4em 0.3em') :css('font-weight', 'bold') :cssText(args.abovestyle) :newline() -- newline required for bullet-points to work :wikitext(args.above) end local rowNums = {} for k, v in pairs(args) do k = .. k local num = k:match('^heading(%d+)$') or k:match('^content(%d+)$') if num then table.insert(rowNums, tonumber(num)) end end table.sort(rowNums) -- remove duplicates from the list (e.g. 3 will be duplicated if both heading3 and content3 are specified) for i = #rowNums, 1, -1 do if rowNums[i] == rowNums[i - 1] then table.remove(rowNums, i) end end for i, num in ipairs(rowNums) do local heading = args['heading' .. num] if heading then root :tag('tr') :tag('th') :addClass(args.headingclass) :css('padding', '0.1em') :cssText(args.basestyle) :cssText(args.headingstyle) :cssText(args['heading' .. num .. 'style']) :newline() :wikitext(heading) end local content = args['content' .. num] if content then root :tag('tr') :tag('td') :addClass(args.contentclass) :css('padding', '0 0.1em 0.4em') :cssText(args.contentstyle) :cssText(args['content' .. num .. 'style']) :newline() :wikitext(content) :done() :newline() -- Without a linebreak after the , a nested list like "*

  • ...

" doesn't parse correctly.

end end

if args.below then root :tag('tr') :tag('td') :addClass(args.belowclass) :css('padding', '0.3em 0.4em 0.3em') :css('font-weight', 'bold') :cssText(args.belowstyle) :newline() :wikitext(args.below) end

if not child then local navbarArg = args.navbar or args.tnavbar if navbarArg ~= 'none' and navbarArg ~= 'off' and (args.name or frame:getParent():getTitle():gsub('/sandbox$', ) ~= 'Template:Sidebar') then root :tag('tr') :tag('td') :css('text-align', 'right') :css('font-size', '115%') :cssText(args.navbarstyle or args.tnavbarstyle) :wikitext(navbar{ args.name, mini = 1, fontstyle = args.navbarfontstyle or args.tnavbarfontstyle }) end end

return tostring(root) end

function p.collapsible(frame) local args = getArgs(frame)

args.abovestyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.abovestyle or ) args.belowstyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.belowstyle or ) args.navbarstyle = 'padding-top: 0.6em;' .. (args.navbarstyle or args.tnavbarstyle or ) if not args.name and frame:getParent():getTitle():gsub('/sandbox$', ) == 'Template:Sidebar with collapsible lists' then args.navbar = 'none' end

local contentArgs = {}

for k, v in pairs(args) do local num = string.match(k, '^list(%d+)$') if num then local expand = args.expanded and (args.expanded == 'all' or args.expanded == args['list' .. num .. 'name'])

local row = mw.html.create('div') row :addClass('NavFrame') :addClass((not expand) and 'collapsed' or nil) :css('border', 'none') :css('padding', 0) :cssText(args.listframestyle) :cssText(args['list' .. num .. 'framestyle']) :tag('div') :addClass('NavHead') :addClass(args.listtitleclass) :css('font-size', '105%') :css('background', 'transparent') :css('text-align', 'left') :cssText(args.basestyle) :cssText(args.listtitlestyle) :cssText(args['list' .. num .. 'titlestyle']) :wikitext(trimAndAddAutomaticNewline(args['list' .. num .. 'title'] or 'List')) :done() :tag('div') :addClass('NavContent') :addClass(args.listclass) :addClass(args['list' .. num .. 'class']) :css('font-size', '105%') :css('padding', '0.2em 0 0.4em') :css('text-align', 'center') :cssText(args.liststyle) :cssText(args['list' .. num .. 'style']) :wikitext(trimAndAddAutomaticNewline(args['list' .. num]))

contentArgs['content' .. num] = tostring(row) end end

for k, v in pairs(contentArgs) do args[k] = v end

return p.sidebar(frame, args) end

return p