Jump to content

Editing Module:Sidebar

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
require('strict')
--
local cfg = mw.loadData('Module:Sidebar/configuration')
-- This module implements {{Sidebar}}
 
--
local p = {}
local p = {}
 
local getArgs = require('Module:Arguments').getArgs
local HtmlBuilder = require('Module:HtmlBuilder')
 
local Navbar = require('Module:Navbar')
--[[
Categorizes calling templates and modules with a 'style' parameter of any sort
for tracking to convert to TemplateStyles.
 
TODO after a long cleanup: Catch sidebars in other namespaces than Template and Module.
TODO would probably want to remove /log and /archive as CS1 does
]]
local function categorizeTemplatesWithInlineStyles(args)
local title = mw.title.getCurrentTitle()
if title.namespace ~= 10 and title.namespace ~= 828 then return '' end
for _, pattern in ipairs (cfg.i18n.pattern.uncategorized_conversion_titles) do
if title.text:match(pattern) then return '' end
end
for key, _ in pairs(args) do
if mw.ustring.find(key, cfg.i18n.pattern.style_conversion) or key == 'width' then
return cfg.i18n.category.conversion
end
end
end
 
--[[
For compatibility with the original {{sidebar with collapsible lists}}
implementation, which passed some parameters through {{#if}} to trim their
whitespace. This also triggered the automatic newline behavior.
]]
-- See ([[meta:Help:Newlines and spaces#Automatic newline]])
local function trimAndAddAutomaticNewline(s)
local function trimAndAddAutomaticNewline(s)
s = mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1")
    -- For compatibility with the original {{sidebar with collapsible lists}}
if mw.ustring.find(s, '^[#*:;]') or mw.ustring.find(s, '^{|') then
    -- implementation, which passed some parameters through {{#if}} to trim
return '\n' .. s
    -- their whitespace. This also triggered the automatic newline behavior.
else
    -- ([[meta:Help:Newlines and spaces#Automatic newline]])
return s
    s = mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1")
end
    if mw.ustring.find(s, '^[#*:;]') or mw.ustring.find(s, '^{|') then
end
        return '\n' .. s
 
    else
--[[
        return s
Finds whether a sidebar has a subgroup sidebar.
    end
]]
local function hasSubgroup(s)
if mw.ustring.find(s, cfg.i18n.pattern.subgroup) then
return true
else
return false
end
end
 
local function has_navbar(navbar_mode, sidebar_name)
return navbar_mode ~= cfg.i18n.navbar_none and
navbar_mode ~= cfg.i18n.navbar_off and
(
sidebar_name or
mw.getCurrentFrame():getParent():getTitle():gsub(cfg.i18n.pattern.sandbox, '') ~=
cfg.i18n.title_not_to_add_navbar
)
end
 
local function has_list_class(args, htmlclass)
local patterns = {
'^' .. htmlclass .. '$',
'%s' .. htmlclass .. '$',
'^' .. htmlclass .. '%s',
'%s' .. htmlclass .. '%s'
}
for arg, value in pairs(args) do
if type(arg) == 'string' and mw.ustring.find(arg, 'class') then
for _, pattern in ipairs(patterns) do
if mw.ustring.find(args[arg] or '', pattern) then
return true
end
end
end
end
return false
end
 
-- there are a lot of list classes in the wild, so we add their TemplateStyles
local function add_list_styles(args)
local frame = mw.getCurrentFrame()
local function add_list_templatestyles(htmlclass, templatestyles)
if has_list_class(args, htmlclass) then
return frame:extensionTag{
name = 'templatestyles', args = { src = templatestyles }
}
else
return ''
end
end
local plainlist_styles = add_list_templatestyles('plainlist', cfg.i18n.plainlist_templatestyles)
local hlist_styles = add_list_templatestyles('hlist', cfg.i18n.hlist_templatestyles)
-- a second workaround for [[phab:T303378]]
-- when that issue is fixed, we can actually use has_navbar not to emit the
-- tag here if we want
if has_navbar(args.navbar, args.name) and hlist_styles == '' then
hlist_styles = frame:extensionTag{
name = 'templatestyles', args = { src = cfg.i18n.hlist_templatestyles}
}
end
 
-- hlist -> plainlist is best-effort to preserve old Common.css ordering. [hlist_note]
return hlist_styles .. plainlist_styles
end
end


-- work around [[phab:T303378]]
local function _sidebar(args)
-- for each arg: find all the templatestyles strip markers, insert them into a
    local root = HtmlBuilder.create('table')
-- table. then remove all templatestyles markers from the arg
   
local function move_hiding_templatestyles(args)
    root
local gfind = string.gfind
        .addClass('vertical-navbox')
local gsub = string.gsub
        .addClass(args.wraplinks ~= 'true' and 'nowraplinks')
local templatestyles_markers = {}
        .addClass(args.bodyclass or args.class)
local strip_marker_pattern = '(\127[^\127]*UNIQ%-%-templatestyles%-%x+%-QINU[^\127]*\127)'
        .attr('cellspacing', args.cellspacing or 5)
for k, arg in pairs(args) do
        .attr('cellpadding', args.cellpadding or 0)
for marker in gfind(arg, strip_marker_pattern) do
        .css('float', args.float or 'right')
table.insert(templatestyles_markers, marker)
        .css('clear', (args.float == 'none' and 'both') or args.float or 'right')
end
        .css('width', args.width or '22.0em')
args[k] = gsub(arg, strip_marker_pattern, '')
        .css('margin', args.float == 'left' and '0 1.0em 1.0em 0' or '0 0 1.0em 1.0em')
end
        .css('background', '#f9f9f9')
return templatestyles_markers
        .css('border', '1px solid #aaa')
end
        .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
Main sidebar function. Takes the frame, args, and an optional collapsibleClass.
        root
The collapsibleClass is and should be used only for sidebars with collapsible
            .tag('caption')
lists, as in p.collapsible.
                .addClass(args.outertitleclass)
]]
                .css('padding-bottom', '0.2em')
function p.sidebar(frame, args, collapsibleClass)
                .css('font-size', '125%')
if not args then
                .css('line-height', '1.2em')
args = getArgs(frame)
                .css('font-weight', 'bold')
end
                .cssText(args.outertitlestyle)
local hiding_templatestyles = table.concat(move_hiding_templatestyles(args))
                .wikitext(args.outertitle)
local root = mw.html.create()
    end
local child = args.child and mw.text.trim(args.child) == cfg.i18n.child_yes


root = root:tag('table')
    if args.topimage then
if not child then
        local imageCell = root.tag('tr').tag('td')
root
       
:addClass(cfg.i18n.class.sidebar)
        imageCell
-- force collapsibleclass to be sidebar-collapse otherwise output nothing
            .addClass(args.topimageclass)
:addClass(collapsibleClass == cfg.i18n.class.collapse and cfg.i18n.class.collapse or nil)
            .css('padding', '0.4em 0')
:addClass('nomobile')
            .cssText(args.topimagestyle)
:addClass(args.float == cfg.i18n.float_none and cfg.i18n.class.float_none or nil)
            .wikitext(args.topimage)
:addClass(args.float == cfg.i18n.float_left and cfg.i18n.class.float_left or nil)
       
:addClass(args.wraplinks ~= cfg.i18n.wrap_true and cfg.i18n.class.wraplinks or nil)
        if args.topcaption then
:addClass(args.bodyclass or args.class)
            imageCell
:css('width', args.width or nil)
                .tag('div')
:cssText(args.bodystyle or args.style)
                    .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.outertitle then
    if args.title then
root
        root
:tag('caption')
            .tag('tr')
:addClass(cfg.i18n.class.outer_title)
                .tag('th')
:addClass(args.outertitleclass)
                    .addClass(args.titleclass)
:cssText(args.outertitlestyle)
                    .cssText(args.basestyle)
:wikitext(args.outertitle)
                    .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


if args.topimage then
    if args.image then
local imageCell = root:tag('tr'):tag('td')
        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


imageCell
    local rowNums = {}
:addClass(cfg.i18n.class.top_image)
    for k, v in pairs(args) do
:addClass(args.topimageclass)
        k = '' .. k
:cssText(args.topimagestyle)
        local num = k:match('^heading(%d+)$') or k:match('^content(%d+)$')
:wikitext(args.topimage)
        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


if args.topcaption then
    for i, num in ipairs(rowNums) do
imageCell
        local heading = args['heading' .. num]
:tag('div')
        if heading then
:addClass(cfg.i18n.class.top_caption)
            root
:cssText(args.topcaptionstyle)
                .tag('tr')
:wikitext(args.topcaption)
                    .tag('th')
end
                        .addClass(args.headingclass)
end
                        .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.pretitle then
    if args.below then
root
        root
:tag('tr')
            .tag('tr')
:tag('td')
                .tag('td')
:addClass(args.topimage and cfg.i18n.class.pretitle_with_top_image
                    .addClass(args.belowclass)
or cfg.i18n.class.pretitle)
                    .css('padding', '0.3em 0.4em 0.3em')
:addClass(args.pretitleclass)
                    .css('font-weight', 'bold')
:cssText(args.basestyle)
                    .cssText(args.belowstyle)
:cssText(args.pretitlestyle)
                    .newline()
:wikitext(args.pretitle)
                    .wikitext(args.below)
end
    end
else
root
:addClass(cfg.i18n.class.subgroup)
:addClass(args.bodyclass or args.class)
:cssText(args.bodystyle or args.style)
end


if args.title then
    local navbarArg = args.navbar or args.tnavbar
if child then
    if navbarArg ~= 'none' and navbarArg ~= 'off' then
root
        root
:wikitext(args.title)
            .tag('tr')
else
                .tag('td')
root
                    .css('text-align', 'right')
:tag('tr')
                    .css('font-size', '115%')
:tag('th')
                    .cssText(args.navbarstyle or args.tnavbarstyle)
:addClass(args.pretitle and cfg.i18n.class.title_with_pretitle
                    .wikitext(Navbar.navbar({
or cfg.i18n.class.title)
                        args.name or mw.title.getCurrentTitle().fullText,
:addClass(args.titleclass)
                        mini = 1,
:cssText(args.basestyle)
                        fontstyle = args.navbarfontstyle or args.tnavbarfontstyle
:cssText(args.titlestyle)
                    }))
:wikitext(args.title)
    end  
end
end


if args.image then
    return tostring(root)
local imageCell = root:tag('tr'):tag('td')
 
imageCell
:addClass(cfg.i18n.class.image)
:addClass(args.imageclass)
:cssText(args.imagestyle)
:wikitext(args.image)
 
if args.caption then
imageCell
:tag('div')
:addClass(cfg.i18n.class.caption)
:cssText(args.captionstyle)
:wikitext(args.caption)
end
end
 
if args.above then
root
:tag('tr')
:tag('td')
:addClass(cfg.i18n.class.above)
:addClass(args.aboveclass)
: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(cfg.i18n.class.heading)
:addClass(args.headingclass)
:addClass(args['heading' .. num .. 'class'])
: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(hasSubgroup(content) and cfg.i18n.class.content_with_subgroup
or cfg.i18n.class.content)
:addClass(args.contentclass)
:addClass(args['content' .. num .. 'class'])
:cssText(args.contentstyle)
:cssText(args['content' .. num .. 'style'])
:newline()
:wikitext(content)
:done()
-- Without a linebreak after the </td>, a nested list like
-- "* {{hlist| ...}}" doesn't parse correctly.
:newline()
end
end
 
if args.below then
root
:tag('tr')
:tag('td')
:addClass(cfg.i18n.class.below)
:addClass(args.belowclass)
:cssText(args.belowstyle)
:newline()
:wikitext(args.below)
end
 
if not child and has_navbar(args.navbar, args.name) then
root
:tag('tr')
:tag('td')
:addClass(cfg.i18n.class.navbar)
:cssText(args.navbarstyle)
:wikitext(require('Module:Navbar')._navbar{
args.name,
mini = 1,
fontstyle = args.navbarfontstyle
})
end
local base_templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = cfg.i18n.templatestyles }
}
local templatestyles = ''
if args['templatestyles'] and args['templatestyles'] ~= '' then
templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = args['templatestyles'] }
}
end
local child_templatestyles = ''
if args['child templatestyles'] and args['child templatestyles'] ~= '' then
child_templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = args['child templatestyles'] }
}
end
local grandchild_templatestyles = ''
if args['grandchild templatestyles'] and args['grandchild templatestyles'] ~= '' then
grandchild_templatestyles = frame:extensionTag{
name = 'templatestyles', args = { src = args['grandchild templatestyles'] }
}
end
 
return table.concat({
add_list_styles(args), -- see [hlist_note] above about ordering
base_templatestyles,
templatestyles,
child_templatestyles,
grandchild_templatestyles,
hiding_templatestyles,
tostring(root),
(child and cfg.i18n.category.child or ''),
categorizeTemplatesWithInlineStyles(args)
})
end
end


local function list_title(args, is_centered_list_titles, num)
function _collapsibleSidebar(args)
    args.abovestyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.abovestyle or '')
local title_text = trimAndAddAutomaticNewline(args['list' .. num .. 'title']
    args.belowstyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.belowstyle or '')
or cfg.i18n.default_list_title)
    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


local title
    for k, v in pairs(contentArgs) do
if is_centered_list_titles then
        args[k] = v
-- collapsible can be finicky, so provide some CSS/HTML to support
    end
title = mw.html.create('div')
   
:addClass(cfg.i18n.class.list_title_centered)
    return _sidebar(args)
:wikitext(title_text)
else
title = mw.html.create()
:wikitext(title_text)
end
local title_container = mw.html.create('div')
:addClass(cfg.i18n.class.list_title)
-- don't /need/ a listnumtitleclass because you can do
-- .templateclass .listnumclass .sidebar-list-title
:addClass(args.listtitleclass)
:cssText(args.basestyle)
:cssText(args.listtitlestyle)
:cssText('color: var(--color-base)')
:cssText(args['list' .. num .. 'titlestyle'])
:node(title)
:done()
return title_container
end
end
 
                     
--[[
function makeWrapper(func)
Main entry point for sidebar with collapsible lists.
    return function(frame)
Does the work of creating the collapsible lists themselves and including them
        local origArgs
into the args.
        if frame == mw.getCurrentFrame() then
]]
            -- We're being called via #invoke. If the invoking template passed any args, use
function p.collapsible(frame)
            -- them. Otherwise, use the args that were passed into the template.
local args = getArgs(frame)
            origArgs = frame:getParent().args
if not args.name and
            for k, v in pairs(frame.args) do
frame:getParent():getTitle():gsub(cfg.i18n.pattern.collapse_sandbox, '') ==
                origArgs = frame.args
cfg.i18n.collapse_title_not_to_add_navbar then
                break
args.navbar = cfg.i18n.navbar_none
            end
end
        else
 
            -- We're being called from another module or from the debug console, so assume
local contentArgs = {}
            -- the args are passed in directly.
            origArgs = frame
local is_centered_list_titles = false
        end
if args['centered list titles'] and args['centered list titles'] ~= '' then
   
is_centered_list_titles = true
        -- ParserFunctions considers the empty string to be false, so to preserve the previous
end
        -- behavior of the template, change any empty arguments to nil, so Lua will consider
 
        -- them false too.
for k, v in pairs(args) do
        local args = {}
local num = string.match(k, '^list(%d+)$')
        for k, v in pairs(origArgs) do
if num then
            if v ~= '' then
local expand = args.expanded and
                args[k] = v
(args.expanded == 'all' or args.expanded == args['list' .. num .. 'name'])
            end
local row = mw.html.create('div')
        end
row
   
:addClass(cfg.i18n.class.list)
        return func(args)
:addClass('mw-collapsible')
    end
:addClass((not expand) and 'mw-collapsed' or nil)
:addClass(args['list' .. num .. 'class'])
:cssText(args.listframestyle)
:cssText(args['list' .. num .. 'framestyle'])
:node(list_title(args, is_centered_list_titles, num))
:tag('div')
:addClass(cfg.i18n.class.list_content)
:addClass('mw-collapsible-content')
-- don't /need/ a listnumstyleclass because you can do
-- .templatename .listnumclass .sidebar-list
:addClass(args.listclass)
: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, cfg.i18n.class.collapse)
end
end


return p
return {
    sidebar = makeWrapper(_sidebar),
    collapsible = makeWrapper(_collapsibleSidebar)
}
Please note that all contributions to OrangDev Labs Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see OrangDev Labs Wiki:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)
Preview page with this template

Template used on this page:

Retrieved from "https://projecthome.skywiki.org/wiki/Module:Sidebar"