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}}
--
require('Module:No globals')


local p = {}
local p = {}


local getArgs = require('Module:Arguments').getArgs
local getArgs = require('Module:Arguments').getArgs
local navbar = require('Module:Navbar')._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)
-- 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.
-- ([[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
Line 42: Line 22:
end
end


--[[
function p.sidebar(frame, args)
Finds whether a sidebar has a subgroup sidebar.
]]
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
 
-- work around [[phab:T303378]]
-- for each arg: find all the templatestyles strip markers, insert them into a
-- table. then remove all templatestyles markers from the arg
local function move_hiding_templatestyles(args)
local gfind = string.gfind
local gsub = string.gsub
local templatestyles_markers = {}
local strip_marker_pattern = '(\127[^\127]*UNIQ%-%-templatestyles%-%x+%-QINU[^\127]*\127)'
for k, arg in pairs(args) do
for marker in gfind(arg, strip_marker_pattern) do
table.insert(templatestyles_markers, marker)
end
args[k] = gsub(arg, strip_marker_pattern, '')
end
return templatestyles_markers
end
 
--[[
Main sidebar function. Takes the frame, args, and an optional collapsibleClass.
The collapsibleClass is and should be used only for sidebars with collapsible
lists, as in p.collapsible.
]]
function p.sidebar(frame, args, collapsibleClass)
if not args then
if not args then
args = getArgs(frame)
args = getArgs(frame)
end
end
local hiding_templatestyles = table.concat(move_hiding_templatestyles(args))
local root = mw.html.create()
local root = mw.html.create()
local child = args.child and mw.text.trim(args.child) == cfg.i18n.child_yes
local child = args.child and mw.text.trim(args.child) == 'yes'


root = root:tag('table')
if not child then
if not child then
root  
root = root
:addClass(cfg.i18n.class.sidebar)
:tag('div')
-- force collapsibleclass to be sidebar-collapse otherwise output nothing
:attr('role', args.role)
:addClass(collapsibleClass == cfg.i18n.class.collapse and cfg.i18n.class.collapse or nil)
:attr('aria-labelledby', args.outertitle and mw.uri.anchorEncode(args.outertitle) or args.title and mw.uri.anchorEncode(args.title))
:addClass('nomobile')
:attr('aria-label', (args.outertitle or args.title) and nil or 'Sidebar')
:addClass(args.float == cfg.i18n.float_none and cfg.i18n.class.float_none or nil)
:addClass('vertical-navbox')
:addClass(args.float == cfg.i18n.float_left and cfg.i18n.class.float_left or nil)
:addClass(args.wraplinks ~= 'true' and 'nowraplinks' or nil)
:addClass(args.wraplinks ~= cfg.i18n.wrap_true and cfg.i18n.class.wraplinks or nil)
:addClass(args.bodyclass or args.class)
:addClass(args.bodyclass or args.class)
:css('width', args.width or nil)
:css('position', 'relative')
:css('clear', args.float == 'none' and 'both' or args.float or 'right')
:css('float', args.float or 'right')
:css('box-sizing', 'border-box')
:css('margin-left', args.float == 'right' and '1em' or nil)
:css('margin-right', args.float == 'left' and '1em' or nil)
:css('margin-bottom', '1em')
:css('width', args.width or '22.0em')
:css('border', '1px solid #aaa')
:css('padding', '0.3em 0.5em')
:css('background', '#f9f9f9')
:css('line-height', '1.4em')
:css('font-size', '88%')
:css('text-align', 'center')
:cssText(args.bodystyle or args.style)
:cssText(args.bodystyle or args.style)


if args.outertitle then
if args.outertitle then
root
root
:tag('caption')
:css('margin-top', '1.6em')
:addClass(cfg.i18n.class.outer_title)
:tag('div')
:attr('id', mw.uri.anchorEncode(args.outertitle))
:addClass(args.outertitleclass)
:addClass(args.outertitleclass)
:css('position', 'absolute')
:css('top', '-1.4em')
:css('left', '0')
:css('width', '100%')
:css('font-size', '125%')
:css('line-height', '1.2em')
:css('font-weight', 'bold')
:cssText(args.outertitlestyle)
:cssText(args.outertitlestyle)
:wikitext(args.outertitle)
:wikitext(args.outertitle)
Line 166: Line 72:


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


imageCell
imageContainer
:addClass(cfg.i18n.class.top_image)
:addClass(args.topimageclass)
:addClass(args.topimageclass)
:css('padding', '0.4em 0')
:cssText(args.topimagestyle)
:cssText(args.topimagestyle)
:wikitext(args.topimage)
:wikitext(args.topimage)


if args.topcaption then
if args.topcaption then
imageCell
imageContainer
:tag('div')
:tag('div')
:addClass(cfg.i18n.class.top_caption)
:css('padding-top', '0.2em')
:css('line-height', '1.2em')
:cssText(args.topcaptionstyle)
:cssText(args.topcaptionstyle)
:wikitext(args.topcaption)
:wikitext(args.topcaption)
Line 185: Line 92:
if args.pretitle then
if args.pretitle then
root
root
:tag('tr')
:tag('div')
:tag('td')
:addClass(args.pretitleclass)
:addClass(args.topimage and cfg.i18n.class.pretitle_with_top_image
:cssText(args.basestyle)
or cfg.i18n.class.pretitle)
:css('padding-top', args.topimage and '0.2em' or '0.4em')
:addClass(args.pretitleclass)
:css('line-height', '1.2em')
:cssText(args.basestyle)
:cssText(args.pretitlestyle)
:cssText(args.pretitlestyle)
:wikitext(args.pretitle)
:wikitext(args.pretitle)
end
end
else
 
root
:addClass(cfg.i18n.class.subgroup)
:addClass(args.bodyclass or args.class)
:cssText(args.bodystyle or args.style)
end
end


Line 207: Line 109:
else
else
root
root
:tag('tr')
:tag('div')
:tag('th')
:attr('id', (args.outertitle or args.pretitle) and nil or mw.uri.anchorEncode(args.title))
:addClass(args.pretitle and cfg.i18n.class.title_with_pretitle
:addClass(args.titleclass)
or cfg.i18n.class.title)
:cssText(args.basestyle)
:addClass(args.titleclass)
:css('padding', '0.2em 0.4em 0.2em')
:cssText(args.basestyle)
:css('padding-top', args.pretitle and 0)
:cssText(args.titlestyle)
:css('font-size', '145%')
:wikitext(args.title)
:css('line-height', '1.2em')
:css('font-weight', 'bold')
:cssText(args.titlestyle)
:wikitext(args.title)
end
end
end
end


if args.image then
if args.image then
local imageCell = root:tag('tr'):tag('td')
local imageContainer = root:tag('div')


imageCell
imageContainer
:addClass(cfg.i18n.class.image)
:addClass(args.imageclass)
:addClass(args.imageclass)
:css('padding', '0.2em 0 0.4em')
:cssText(args.imagestyle)
:cssText(args.imagestyle)
:wikitext(args.image)
:wikitext(args.image)


if args.caption then
if args.caption then
imageCell
imageContainer
:tag('div')
:tag('div')
:addClass(cfg.i18n.class.caption)
:css('padding-top', '0.2em')
:css('line-height', '1.2em')
:cssText(args.captionstyle)
:cssText(args.captionstyle)
:wikitext(args.caption)
:wikitext(args.caption)
Line 238: Line 144:
if args.above then
if args.above then
root
root
:tag('tr')
:tag('div')
:tag('td')
:addClass(args.aboveclass)
:addClass(cfg.i18n.class.above)
:css('padding', '0.3em 0.4em 0.3em')
:addClass(args.aboveclass)
:css('font-weight', 'bold')
:cssText(args.abovestyle)
:cssText(args.abovestyle)
:newline() -- newline required for bullet-points to work
:newline() -- newline required for bullet-points to work
:wikitext(args.above)
:wikitext(args.above)
end
end


local rowNums = {}
local parameterNumbers = {}
for k, v in pairs(args) do
for k, _ in pairs(args) do
k = '' .. k
k = '' .. k
local num = k:match('^heading(%d+)$') or k:match('^content(%d+)$')
local num = k:match('^heading(%d+)$') or k:match('^content(%d+)$')
if num then table.insert(rowNums, tonumber(num)) end
if num then table.insert(parameterNumbers, tonumber(num)) end
end
end
table.sort(rowNums)
table.sort(parameterNumbers)
-- remove duplicates from the list (e.g. 3 will be duplicated if both heading3
-- remove duplicates from the list (e.g. 3 will be duplicated if both heading3 and content3 are specified)
-- and content3 are specified)
for i = #parameterNumbers, 1, -1 do
for i = #rowNums, 1, -1 do
if parameterNumbers[i] == parameterNumbers[i - 1] then
if rowNums[i] == rowNums[i - 1] then
table.remove(parameterNumbers, i)
table.remove(rowNums, i)
end
end
end
end


for i, num in ipairs(rowNums) do
for i, num in ipairs(parameterNumbers) do
local heading = args['heading' .. num]
local heading = args['heading' .. num]
if heading then
if heading then
root
root
:tag('tr')
:tag('div')
:tag('th')
:addClass(args.headingclass)
:addClass(cfg.i18n.class.heading)
:css('padding', '0.1em')
:addClass(args.headingclass)
:css('font-weight', 'bold')
:addClass(args['heading' .. num .. 'class'])
:cssText(args.basestyle)
:cssText(args.basestyle)
:cssText(args.headingstyle)
:cssText(args.headingstyle)
:cssText(args['heading' .. num .. 'style'])
:cssText(args['heading' .. num .. 'style'])
:newline()
:newline()
:wikitext(heading)
:wikitext(heading)
end
end


Line 281: Line 185:
if content then
if content then
root
root
:tag('tr')
:tag('div')
:tag('td')
:addClass(args.contentclass)
:addClass(hasSubgroup(content) and cfg.i18n.class.content_with_subgroup
:css('padding', i == #parameterNumbers and '0 0.1em' or '0 0.1em 0.4em') -- no bottom padding on last content
or cfg.i18n.class.content)
:cssText(args.contentstyle)
:addClass(args.contentclass)
:cssText(args['content' .. num .. 'style'])
: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()
:newline()
:wikitext(content)
:done()
:newline() -- Without a linebreak after the </td>, a nested list like "* {{hlist| ...}}" doesn't parse correctly.
end
end
end
end
Line 300: Line 199:
if args.below then
if args.below then
root
root
:tag('tr')
:tag('div')
:tag('td')
:addClass(args.belowclass)
:addClass(cfg.i18n.class.below)
:css('margin-top', '0.4em')
:addClass(args.belowclass)
:css('padding', '0.3em 0.4em 0.3em')
:cssText(args.belowstyle)
:css('font-weight', 'bold')
:newline()
:cssText(args.belowstyle)
:wikitext(args.below)
:newline()
:wikitext(args.below)
end
end


if not child and has_navbar(args.navbar, args.name) then
if not child then
root
local navbarArg = args.navbar or args.tnavbar
:tag('tr')
if navbarArg ~= 'none' and navbarArg ~= 'off' and (args.name or frame:getParent():getTitle():gsub('/sandbox$', '') ~= 'Template:Sidebar') then
:tag('td')
root
:addClass(cfg.i18n.class.navbar)
:tag('div')
:cssText(args.navbarstyle)
:css('text-align', 'right')
:wikitext(require('Module:Navbar')._navbar{
:css('font-size', '115%')
:cssText(args.navbarstyle or args.tnavbarstyle)
:wikitext(navbar{
args.name,
args.name,
mini = 1,
mini = 1,
fontstyle = args.navbarfontstyle
fontstyle = args.navbarfontstyle or args.tnavbarfontstyle
})
})
end
end
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
local function list_title(args, is_centered_list_titles, num)
local title_text = trimAndAddAutomaticNewline(args['list' .. num .. 'title']
or cfg.i18n.default_list_title)


local title
return tostring(root)
if is_centered_list_titles then
-- collapsible can be finicky, so provide some CSS/HTML to support
title = mw.html.create('div')
:addClass(cfg.i18n.class.list_title_centered)
: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


--[[
Main entry point for sidebar with collapsible lists.
Does the work of creating the collapsible lists themselves and including them
into the args.
]]
function p.collapsible(frame)
function p.collapsible(frame)
local args = getArgs(frame)
local args = getArgs(frame)
if not args.name and
 
frame:getParent():getTitle():gsub(cfg.i18n.pattern.collapse_sandbox, '') ==
args.abovestyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.abovestyle or '')
cfg.i18n.collapse_title_not_to_add_navbar then
args.belowstyle = 'border-top: 1px solid #aaa; border-bottom: 1px solid #aaa;' .. (args.belowstyle or '')
args.navbar = cfg.i18n.navbar_none
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
end


local contentArgs = {}
local contentArgs = {}
local is_centered_list_titles = false
if args['centered list titles'] and args['centered list titles'] ~= '' then
is_centered_list_titles = true
end


for k, v in pairs(args) do
for k, v in pairs(args) do
local num = string.match(k, '^list(%d+)$')
local num = string.match(k, '^list(%d+)$')
if num then
if num then
local expand = args.expanded and
local expand = args.expanded and (args.expanded == 'all' or args.expanded == args['list' .. num .. 'name'])
(args.expanded == 'all' or args.expanded == args['list' .. num .. 'name'])
 
local row = mw.html.create('div')
local row = mw.html.create('div')
row
row
:addClass(cfg.i18n.class.list)
:addClass('NavFrame')
:addClass('mw-collapsible')
:addClass((not expand) and 'collapsed' or nil)
:addClass((not expand) and 'mw-collapsed' or nil)
:css('border', 'none')
:addClass(args['list' .. num .. 'class'])
:css('padding', 0)
:cssText(args.listframestyle)
:cssText(args.listframestyle)
:cssText(args['list' .. num .. 'framestyle'])
:cssText(args['list' .. num .. 'framestyle'])
:node(list_title(args, is_centered_list_titles, num))
:tag('div')
:tag('div')
:addClass(cfg.i18n.class.list_content)
:addClass('NavHead')
:addClass('mw-collapsible-content')
:addClass(args.listtitleclass)
-- don't /need/ a listnumstyleclass because you can do
:css('font-size', '105%')
-- .templatename .listnumclass .sidebar-list
: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.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.liststyle)
:cssText(args['list' .. num .. 'style'])
:cssText(args['list' .. num .. 'style'])
Line 443: Line 283:
end
end


return p.sidebar(frame, args, cfg.i18n.class.collapse)
return p.sidebar(frame, args)
end
end


return p
return p
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"