Rhythm Doctor Wiki

Module:Sidebar: Difference between revisions

Module Discussion

Module:Sidebar (view source)

Revision as of 04:15, 25 May 2022

2,431 bytes removed ,  25 May 2022
m
1 revision imported: Miraheze infobox
(make wraplinks work like it used to)
m (1 revision imported: Miraheze infobox)
Line 3: Line 3:
--
--
require('Module:No globals')
require('Module:No globals')
local cfg = mw.loadData('Module:Sidebar/configuration')


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 45: Line 22:
end
end


--[[
Finds whether a sidebar has a subgroup sidebar.
]]
local function hasSubgroup(s)
local function hasSubgroup(s)
if mw.ustring.find(s, cfg.i18n.pattern.subgroup) then
if mw.ustring.find(s, 'vertical%-navbox%-subgroup') then
return true
return true
else
else
Line 56: Line 30:
end
end


--[[
function p.sidebar(frame, args)
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 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')
root = root:tag('table')
if not child then
if not child then
root  
root  
:addClass(cfg.i18n.class.sidebar)
:addClass('vertical-navbox')
-- force collapsibleclass to be sidebar-collapse otherwise output nothing
:addClass(args.wraplinks ~= 'true' and 'nowraplinks' or nil)
:addClass(collapsibleClass == cfg.i18n.class.collapse and cfg.i18n.class.collapse or nil)
:addClass('nomobile')
:addClass(args.float == cfg.i18n.float_none and cfg.i18n.class.float_none or nil)
: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)
:addClass(args.bodyclass or args.class)
:addClass(args.bodyclass or args.class)
:css('width', args.width or nil)
: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)
:cssText(args.bodystyle or args.style)


Line 85: Line 59:
root
root
:tag('caption')
:tag('caption')
:addClass(cfg.i18n.class.outer_title)
:addClass(args.outertitleclass)
:addClass(args.outertitleclass)
:css('padding-bottom', '0.2em')
: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 95: Line 72:


imageCell
imageCell
: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)
Line 103: Line 80:
imageCell
imageCell
: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 113: Line 91:
:tag('tr')
:tag('tr')
:tag('td')
:tag('td')
:addClass(args.topimage and cfg.i18n.class.pretitle_with_top_image
or cfg.i18n.class.pretitle)
:addClass(args.pretitleclass)
:addClass(args.pretitleclass)
:cssText(args.basestyle)
:cssText(args.basestyle)
:css('padding-top', args.topimage and '0.2em' or '0.4em')
:css('line-height', '1.2em')
:cssText(args.pretitlestyle)
:cssText(args.pretitlestyle)
:wikitext(args.pretitle)
:wikitext(args.pretitle)
Line 122: Line 100:
else
else
root
root
:addClass(cfg.i18n.class.subgroup)
:addClass('vertical-navbox-subgroup')
:css('width', '100%')
:css('margin', '0px')
:css('border-spacing', '0px')
:addClass(args.bodyclass or args.class)
:addClass(args.bodyclass or args.class)
:cssText(args.bodystyle or args.style)
:cssText(args.bodystyle or args.style)
Line 135: Line 116:
:tag('tr')
:tag('tr')
:tag('th')
:tag('th')
:addClass(args.pretitle and cfg.i18n.class.title_with_pretitle
or cfg.i18n.class.title)
:addClass(args.titleclass)
:addClass(args.titleclass)
:cssText(args.basestyle)
: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)
:cssText(args.titlestyle)
:wikitext(args.title)
:wikitext(args.title)
Line 148: Line 131:


imageCell
imageCell
: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)
Line 156: Line 139:
imageCell
imageCell
: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 166: Line 150:
:tag('tr')
:tag('tr')
:tag('td')
:tag('td')
:addClass(cfg.i18n.class.above)
:addClass(args.aboveclass)
:addClass(args.aboveclass)
:css('padding', '0.3em 0.4em 0.3em')
: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
Line 180: Line 165:
end
end
table.sort(rowNums)
table.sort(rowNums)
-- 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 = #rowNums, 1, -1 do
for i = #rowNums, 1, -1 do
if rowNums[i] == rowNums[i - 1] then
if rowNums[i] == rowNums[i - 1] then
Line 194: Line 178:
:tag('tr')
:tag('tr')
:tag('th')
:tag('th')
:addClass(cfg.i18n.class.heading)
:addClass(args.headingclass)
:addClass(args.headingclass)
:addClass(args['heading' .. num .. 'class'])
:css('padding', '0.1em')
:cssText(args.basestyle)
:cssText(args.basestyle)
:cssText(args.headingstyle)
:cssText(args.headingstyle)
Line 209: Line 192:
:tag('tr')
:tag('tr')
:tag('td')
:tag('td')
:addClass(hasSubgroup(content) and cfg.i18n.class.content_with_subgroup
or cfg.i18n.class.content)
:addClass(args.contentclass)
:addClass(args.contentclass)
:addClass(args['content' .. num .. 'class'])
:css('padding', hasSubgroup(content) and '0.1em 0 0.2em' or '0 0.1em 0.4em')
:cssText(args.contentstyle)
:cssText(args.contentstyle)
:cssText(args['content' .. num .. 'style'])
:cssText(args['content' .. num .. 'style'])
Line 218: Line 199:
:wikitext(content)
:wikitext(content)
:done()
:done()
-- Without a linebreak after the </td>, a nested list like
:newline() -- Without a linebreak after the </td>, a nested list like "* {{hlist| ...}}" doesn't parse correctly.
-- "* {{hlist| ...}}" doesn't parse correctly.
:newline()
end
end
end
end
Line 228: Line 207:
:tag('tr')
:tag('tr')
:tag('td')
:tag('td')
:addClass(cfg.i18n.class.below)
:addClass(args.belowclass)
:addClass(args.belowclass)
:css('padding', '0.3em 0.4em 0.3em')
:css('font-weight', 'bold')
:cssText(args.belowstyle)
:cssText(args.belowstyle)
:newline()
:newline()
Line 236: Line 216:


if not child then
if not child then
if args.navbar ~= cfg.i18n.navbar_none and args.navbar ~= cfg.i18n.navbar_off and
local navbarArg = args.navbar or args.tnavbar
(args.name or frame:getParent():getTitle():gsub(cfg.i18n.pattern.sandbox, '') ~=
if navbarArg ~= 'none' and navbarArg ~= 'off' and (args.name or frame:getParent():getTitle():gsub('/sandbox$', '') ~= 'Template:Sidebar') then
cfg.i18n.title_not_to_add_navbar) then
root
root
:tag('tr')
:tag('tr')
:tag('td')
:tag('td')
:addClass(cfg.i18n.class.navbar)
:css('text-align', 'right')
:cssText(args.navbarstyle)
:css('font-size', '115%')
:wikitext(require('Module:Navbar')._navbar{
: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
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({
base_templatestyles,
templatestyles,
child_templatestyles,
grandchild_templatestyles,
tostring(root),
(child and cfg.i18n.category.child or ''),
categorizeTemplatesWithInlineStyles(args)
})
end


local function list_title(args, is_centered_list_titles, num)
return tostring(root) .. (child and '[[Category:Pages using sidebar with the child parameter]]' or '')
local title_text = trimAndAddAutomaticNewline(args['list' .. num .. 'title']
or cfg.i18n.default_list_title)
 
local title
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(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
if args['centered list titles'] and args['centered list titles'] ~= '' then
is_centered_list_titles = true
else
is_centered_list_titles = false
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 372: Line 290:
end
end


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


return p
return p
Retrieved from "https://wiki.rhythm.cafe/page/Special:MobileDiff/342"