Difference between revisions of "Module:Navbox"

From TLAwiki
Jump to navigation Jump to search
(Created page with "-- -- This module implements {{Navbox}} -- local p = {} local navbar = require('Module:Navbar')._navbar local getArgs -- lazily initialized local args local border local li...")
 
 
Line 1: Line 1:
 
--
 
--
-- This module implements {{Navbox}}
+
-- This module will implement {{Navbox}}
 
--
 
--
  +
 
 
local p = {}
 
local p = {}
  +
 
local navbar = require('Module:Navbar')._navbar
+
local HtmlBuilder = require('Module:HtmlBuilder')
  +
local Navbar = require('Module:Navbar')
local getArgs -- lazily initialized
 
   
 
local args
 
local args
  +
local frame
  +
local tableRowAdded = false
 
local border
 
local border
local listnums
+
local listnums = {}
  +
local ODD_EVEN_MARKER = '\127_ODDEVEN_\127'
 
  +
function trim(s)
local RESTART_MARKER = '\127_ODDEVEN0_\127'
 
  +
return (mw.ustring.gsub(s, "^%s*(.-)%s*$", "%1"))
local REGEX_MARKER = '\127_ODDEVEN(%d?)_\127'
 
  +
end
   
local function striped(wikitext)
+
function addNewline(s)
  +
if s:match('^[*:;#]') or s:match('^{|') then
-- Return wikitext with markers replaced for odd/even striping.
 
  +
return '\n' .. s ..'\n'
-- Child (subgroup) navboxes are flagged with a category that is removed
 
  +
else
-- by parent navboxes. The result is that the category shows all pages
 
  +
return s
-- where a child navbox is not contained in a parent navbox.
 
  +
end
local orphanCat = '[[Category:Navbox orphans]]'
 
if border == 'subgroup' and args.orphan ~= 'yes' then
 
-- No change; striping occurs in outermost navbox.
 
return wikitext .. orphanCat
 
end
 
local first, second = 'odd', 'even'
 
if args.evenodd then
 
if args.evenodd == 'swap' then
 
first, second = second, first
 
else
 
first = args.evenodd
 
second = first
 
end
 
end
 
local changer
 
if first == second then
 
changer = first
 
else
 
local index = 0
 
changer = function (code)
 
if code == '0' then
 
-- Current occurrence is for a group before a nested table.
 
-- Set it to first as a valid although pointless class.
 
-- The next occurrence will be the first row after a title
 
-- in a subgroup and will also be first.
 
index = 0
 
return first
 
end
 
index = index + 1
 
return index % 2 == 1 and first or second
 
end
 
end
 
local regex = orphanCat:gsub('([%[%]])', '%%%1')
 
return (wikitext:gsub(regex, ''):gsub(REGEX_MARKER, changer)) -- () omits gsub count
 
 
end
 
end
   
local function processItem(item, nowrapitems)
+
function addTableRow(tbl)
  +
-- If any other rows have already been added, then we add a 2px gutter row.
if item:sub(1, 2) == '{|' then
 
  +
if tableRowAdded then
-- Applying nowrap to lines in a table does not make sense.
 
  +
tbl
-- Add newlines to compensate for trim of x in |parm=x in a template.
 
  +
.tag('tr')
return '\n' .. item ..'\n'
 
  +
.css('height', '2px')
end
 
  +
.tag('td')
if nowrapitems == 'yes' then
 
  +
.attr('colspan',2)
local lines = {}
 
  +
end
for line in (item .. '\n'):gmatch('([^\n]*)\n') do
 
  +
local prefix, content = line:match('^([*:;#]+)%s*(.*)')
 
  +
tableRowAdded = true
if prefix and not content:match('^<span class="nowrap">') then
 
  +
line = prefix .. '<span class="nowrap">' .. content .. '</span>'
 
  +
return tbl.tag('tr')
end
 
table.insert(lines, line)
 
end
 
item = table.concat(lines, '\n')
 
end
 
if item:match('^[*:;#]') then
 
return '\n' .. item ..'\n'
 
end
 
return item
 
 
end
 
end
   
local function renderNavBar(titleCell)
 
 
if args.navbar ~= 'off' and args.navbar ~= 'plain' and not (not args.name and mw.getCurrentFrame():getParent():getTitle():gsub('/sandbox$', '') == 'Template:Navbox') then
 
titleCell:wikitext(navbar{
 
args.name,
 
mini = 1,
 
fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;-moz-box-shadow:none;-webkit-box-shadow:none;box-shadow:none; padding:0;'
 
})
 
end
 
 
end
 
   
 
--
 
--
 
-- Title row
 
-- Title row
 
--
 
--
local function renderTitleRow(tbl)
+
function renderTitleRow(tbl)
if not args.title then return end
+
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
local titleRow = tbl:tag('tr')
 
  +
.tag('div')
  +
.addClass(args.titleclass)
  +
.css('font-size', '110%')
  +
.wikitext(addNewline(args.title))
  +
end
   
  +
function renderNavBar(titleCell)
if args.titlegroup then
 
  +
-- Depending on the presence of the navbar and/or show/hide link, we may need to add a spacer div on the left
titleRow
 
  +
-- or right to keep the title centered.
:tag('th')
 
  +
local spacerSide = nil
:attr('scope', 'row')
 
:addClass('navbox-group')
 
:addClass(args.titlegroupclass)
 
:cssText(args.basestyle)
 
:cssText(args.groupstyle)
 
:cssText(args.titlegroupstyle)
 
:wikitext(args.titlegroup)
 
end
 
   
  +
if args.navbar == 'off' then
local titleCell = titleRow:tag('th'):attr('scope', 'col')
 
  +
-- 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.wikitext(Navbar.navbar({
if args.titlegroup then
 
  +
args.name,
titleCell
 
  +
mini = 1,
:css('border-left', '2px solid #fdfdfd')
 
  +
fontstyle = (args.basestyle or '') .. ';' .. (args.titlestyle or '') .. ';background:none transparent;border:none;'
:css('width', '100%')
 
  +
}))
end
 
  +
end
  +
  +
-- Render the spacer div.
  +
if spacerSide then
  +
titleCell
  +
.tag('span')
  +
.css('float', spacerSide)
  +
.css('width', '6em')
  +
.wikitext('&nbsp;')
  +
end
  +
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')
 
-- id for aria-labelledby attribute
 
:attr('id', mw.uri.anchorEncode(args.title))
 
:addClass(args.titleclass)
 
:css('font-size', '114%')
 
:css('margin', '0 4em')
 
:wikitext(processItem(args.title))
 
end
 
   
 
--
 
--
 
-- Above/Below rows
 
-- Above/Below rows
 
--
 
--
  +
function renderAboveRow(tbl)
  +
if not args.above then return end
   
  +
addTableRow(tbl)
local function getAboveBelowColspan()
 
  +
.tag('td')
local ret = 2
 
  +
.addClass('navbox-abovebelow')
if args.imageleft then ret = ret + 1 end
 
  +
.addClass(args.aboveclass)
if args.image then ret = ret + 1 end
 
  +
.cssText(args.basestyle)
return ret
 
  +
.cssText(args.abovestyle)
  +
.attr('colspan', getAboveBelowColspan())
  +
.tag('div')
  +
.wikitext(addNewline(args.above))
 
end
 
end
   
local function renderAboveRow(tbl)
+
function renderBelowRow(tbl)
if not args.above then return end
+
if not args.below then return end
   
  +
addTableRow(tbl)
tbl:tag('tr')
 
:tag('td')
+
.tag('td')
:addClass('navbox-abovebelow')
+
.addClass('navbox-abovebelow')
:addClass(args.aboveclass)
+
.addClass(args.belowclass)
:cssText(args.basestyle)
+
.cssText(args.basestyle)
:cssText(args.abovestyle)
+
.cssText(args.belowstyle)
:attr('colspan', getAboveBelowColspan())
+
.attr('colspan', getAboveBelowColspan())
:tag('div')
+
.tag('div')
  +
.wikitext(addNewline(args.below))
-- id for aria-labelledby attribute, if no title
 
:attr('id', args.title and nil or mw.uri.anchorEncode(args.above))
 
:wikitext(processItem(args.above, args.nowrapitems))
 
 
end
 
end
   
local function renderBelowRow(tbl)
+
function getAboveBelowColspan()
  +
local ret = 2
if not args.below then return end
 
  +
if args.imageleft then ret = ret + 1 end
 
  +
if args.image then ret = ret + 1 end
tbl:tag('tr')
 
  +
return ret
:tag('td')
 
:addClass('navbox-abovebelow')
 
:addClass(args.belowclass)
 
:cssText(args.basestyle)
 
:cssText(args.belowstyle)
 
:attr('colspan', getAboveBelowColspan())
 
:tag('div')
 
:wikitext(processItem(args.below, args.nowrapitems))
 
 
end
 
end
  +
 
  +
 
--
 
--
 
-- List rows
 
-- List rows
 
--
 
--
local function renderListRow(tbl, index, listnum)
+
function renderListRow(tbl, listnum)
local row = tbl:tag('tr')
+
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')
  +
.wikitext(addNewline(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 index == 1 and args.imageleft then
+
if args['group' .. listnum] then
  +
listCell
row
 
  +
.css('text-align', 'left')
:tag('td')
 
  +
.css('border-left-width', '2px')
:addClass('navbox-image')
 
  +
.css('border-left-style', 'solid')
:addClass(args.imageclass)
 
  +
else
:css('width', '1px') -- Minimize width
 
  +
listCell.attr('colspan', 2)
:css('padding', '0px 2px 0px 0px')
 
  +
end
:cssText(args.imageleftstyle)
 
  +
:attr('rowspan', #listnums)
 
  +
if not args.groupwidth then
:tag('div')
 
  +
listCell.css('width', '100%')
:wikitext(processItem(args.imageleft))
 
end
+
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
if args['group' .. listnum] then
 
  +
.css('padding', '0px')
local groupCell = row:tag('th')
 
  +
.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')
  +
.wikitext(addNewline(args['list' .. listnum]))
   
  +
if listnum == 1 and args.image then
-- id for aria-labelledby attribute, if lone group with no title or above
 
  +
row
if listnum == 1 and not (args.title or args.above or args.group2) then
 
  +
.tag('td')
groupCell
 
  +
.addClass('navbox-image')
:attr('id', mw.uri.anchorEncode(args.group1))
 
  +
.addClass(args.imageclass)
end
 
  +
.css('width', '0%')
 
  +
.css('padding', '0px 0px 0px 2px')
groupCell
 
  +
.cssText(args.imagestyle)
:attr('scope', 'row')
 
  +
.attr('rowspan', 2 * #listnums - 1)
:addClass('navbox-group')
 
  +
.tag('div')
:addClass(args.groupclass)
 
  +
.wikitext(addNewline(args.image))
:cssText(args.basestyle)
 
  +
end
:css('width', args.groupwidth or '1%') -- If groupwidth not specified, minimize width
 
 
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 rowstyle -- usually nil so cssText(rowstyle) usually adds nothing
 
if index % 2 == 1 then
 
rowstyle = args.oddstyle
 
else
 
rowstyle = args.evenstyle
 
end
 
 
local listText = args['list' .. listnum]
 
local oddEven = ODD_EVEN_MARKER
 
if listText:sub(1, 12) == '</div><table' then
 
-- Assume list text is for a subgroup navbox so no automatic striping for this row.
 
oddEven = listText:find('<th[^>]*"navbox%-title"') and RESTART_MARKER or 'odd'
 
end
 
listCell
 
:css('padding', '0px')
 
:cssText(args.liststyle)
 
:cssText(rowstyle)
 
:cssText(args['list' .. listnum .. 'style'])
 
:addClass('navbox-list')
 
:addClass('navbox-' .. oddEven)
 
:addClass(args.listclass)
 
:addClass(args['list' .. listnum .. 'class'])
 
:tag('div')
 
:css('padding', (index == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
 
:wikitext(processItem(listText, args.nowrapitems))
 
 
if index == 1 and args.image then
 
row
 
:tag('td')
 
:addClass('navbox-image')
 
:addClass(args.imageclass)
 
:css('width', '1px') -- Minimize width
 
:css('padding', '0px 0px 0px 2px')
 
:cssText(args.imagestyle)
 
:attr('rowspan', #listnums)
 
:tag('div')
 
:wikitext(processItem(args.image))
 
end
 
 
end
 
end
   
Line 283: Line 258:
 
-- Tracking categories
 
-- Tracking categories
 
--
 
--
  +
function renderTrackingCategories(builder)
 
local function needsHorizontalLists()
+
local frame = mw.getCurrentFrame()
  +
if border == 'subgroup' or args.tracking == 'no' then
 
return false
+
if not frame then return end
  +
end
 
  +
local s = frame:preprocess('{{#ifeq:{{NAMESPACE}}|{{ns:10}}|1|0}}{{SUBPAGENAME}}')
local listClasses = {
 
  +
if mw.ustring.sub(s, 1, 1) == '0' then return end -- not in template space
['plainlist'] = true, ['hlist'] = true, ['hlist hnum'] = true,
 
  +
local subpage = mw.ustring.lower(mw.ustring.sub(s, 2))
['hlist hwrap'] = true, ['hlist vcard'] = true, ['vcard hlist'] = true,
 
  +
if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end
['hlist vevent'] = true,
 
  +
}
 
  +
for i, cat in ipairs(getTrackingCategories()) do
return not (listClasses[args.listclass] or listClasses[args.bodyclass])
 
  +
builder.wikitext('[[Category:' .. cat .. ']]')
end
 
  +
end
 
local function hasBackgroundColors()
 
for _, key in ipairs({'titlestyle', 'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
 
if tostring(args[key]):find('background', 1, true) then
 
return true
 
end
 
end
 
 
end
 
end
   
local function hasBorders()
+
function getTrackingCategories()
  +
local cats = {}
for _, key in ipairs({'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
 
  +
if needsHorizontalLists() then table.insert(cats, 'Navigational boxes without horizontal lists') end
if tostring(args[key]):find('border', 1, true) then
 
  +
if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
return true
 
  +
return cats
end
 
end
 
 
end
 
end
   
local function isIllegible()
+
function needsHorizontalLists()
  +
if border == 'child' or border == 'subgroup' or args.tracking == 'no' then return false end
local styleratio = require('Module:Color contrast')._styleratio
 
  +
  +
local listClasses = {'plainlist', 'hlist', 'hlist hnum', 'hlist hwrap', 'hlist vcard', 'vcard hlist', 'hlist vevent'}
  +
for i, cls in ipairs(listClasses) do
  +
if args.listclass == cls or args.bodyclass == cls then
  +
return false
  +
end
  +
end
   
  +
return true
for key, style in pairs(args) do
 
if tostring(key):match("style$") then
 
if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
 
return true
 
end
 
end
 
end
 
return false
 
 
end
 
end
   
local function getTrackingCategories()
+
function hasBackgroundColors()
  +
return args.titlestyle or args.groupstyle
local cats = {}
 
if needsHorizontalLists() then table.insert(cats, 'Navigational boxes without horizontal lists') end
 
if hasBackgroundColors() then table.insert(cats, 'Navboxes using background colours') end
 
if isIllegible() then table.insert(cats, 'Potentially illegible navboxes') end
 
if hasBorders() then table.insert(cats, 'Navboxes using borders') end
 
return cats
 
 
end
 
end
   
local function renderTrackingCategories(builder)
 
local title = mw.title.getCurrentTitle()
 
if title.namespace ~= 10 then return end -- not in template space
 
local subpage = title.subpageText
 
if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end
 
 
for _, cat in ipairs(getTrackingCategories()) do
 
builder:wikitext('[[Category:' .. cat .. ']]')
 
end
 
end
 
   
 
--
 
--
 
-- Main navbox tables
 
-- Main navbox tables
 
--
 
--
local function renderMainTable()
+
function renderMainTable()
local tbl = mw.html.create('table')
+
local tbl = HtmlBuilder.create('table')
  +
.attr('cellspacing', 0)
:addClass('nowraplinks')
 
:addClass(args.bodyclass)
+
.addClass('nowraplinks')
  +
.addClass(args.bodyclass)
 
  +
if args.title and (args.state ~= 'plain' and args.state ~= 'off') then
 
if args.state == 'collapsed' then args.state = 'mw-collapsed' end
+
if args.title and (args.state ~= 'plain' and args.state ~= 'off') then
tbl
+
tbl
:addClass('mw-collapsible')
+
.addClass('collapsible')
:addClass(args.state or 'autocollapse')
+
.addClass(args.state or 'autocollapse')
end
+
end
  +
 
tbl:css('border-spacing', 0)
+
tbl.css('border-spacing', 0)
if border == 'subgroup' or border == 'none' then
+
if border == 'subgroup' or border == 'child' or border == 'none' then
tbl
+
tbl
:addClass('navbox-subgroup')
+
.addClass('navbox-subgroup')
:cssText(args.bodystyle)
+
.cssText(args.bodystyle)
:cssText(args.style)
+
.cssText(args.style)
else -- regular navbox - bodystyle and style will be applied to the wrapper table
+
else -- regular navobx - bodystyle and style will be applied to the wrapper table
tbl
+
tbl
:addClass('navbox-inner')
+
.addClass('navbox-inner')
:css('background', 'transparent')
+
.css('background', 'transparent')
:css('color', 'inherit')
+
.css('color', 'inherit')
end
+
end
tbl:cssText(args.innerstyle)
+
tbl.cssText(args.innerstyle)
  +
 
renderTitleRow(tbl)
+
renderTitleRow(tbl)
renderAboveRow(tbl)
+
renderAboveRow(tbl)
for i, listnum in ipairs(listnums) do
+
for i, listnum in ipairs(listnums) do
renderListRow(tbl, i, listnum)
+
renderListRow(tbl, listnum)
end
+
end
renderBelowRow(tbl)
+
renderBelowRow(tbl)
  +
 
return tbl
+
return tbl
 
end
 
end
   
 
function p._navbox(navboxArgs)
 
function p._navbox(navboxArgs)
args = navboxArgs
+
args = navboxArgs
  +
listnums = {}
 
  +
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
for k, _ in pairs(args) do
 
  +
local tbl = renderMainTable()
if type(k) == 'string' then
 
local listnum = k:match('^list(%d+)$')
 
if listnum then table.insert(listnums, tonumber(listnum)) end
 
end
 
end
 
table.sort(listnums)
 
   
  +
-- render the appropriate wrapper around the navbox, depending on the border param
border = mw.text.trim(args.border or args[1] or '')
 
  +
local res = HtmlBuilder.create()
if border == 'child' then
 
border = 'subgroup'
+
if border == 'none' then
  +
res.node(tbl)
end
 
  +
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
-- render the main body of the navbox
 
  +
-- therefore inside a div with padding:0em 0.25em. We start with a </div> to avoid the
local tbl = renderMainTable()
 
  +
-- padding being applied, and at the end add a <div> to balance out the parent's </div>
 
  +
res
-- render the appropriate wrapper around the navbox, depending on the border param
 
  +
.tag('/div', {unclosed = true})
local res = mw.html.create()
 
  +
.done()
if border == 'none' then
 
  +
.node(tbl)
local nav = res:tag('div')
 
  +
.tag('div', {unclosed = true})
:attr('role', 'navigation')
 
  +
else
:node(tbl)
 
  +
res
-- aria-labelledby title, otherwise above, otherwise lone group
 
  +
.tag('table')
if args.title or args.above or (args.group1 and not args.group2) then
 
  +
.attr('cellspacing', 0)
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args.above or args.group1))
 
  +
.addClass('navbox')
else
 
  +
.css('border-spacing', 0)
nav:attr('aria-label', 'Navbox')
 
  +
.cssText(args.bodystyle)
end
 
  +
.cssText(args.style)
elseif border == 'subgroup' then
 
  +
.tag('tr')
-- We assume that this navbox is being rendered in a list cell of a parent navbox, and is
 
  +
.tag('td')
-- therefore inside a div with padding:0em 0.25em. We start with a </div> to avoid the
 
  +
.css('padding', '2px')
-- padding being applied, and at the end add a <div> to balance out the parent's </div>
 
  +
.node(tbl)
res
 
  +
end
:wikitext('</div>')
 
  +
:node(tbl)
 
  +
renderTrackingCategories(res)
:wikitext('<div>')
 
  +
else
 
  +
return tostring(res)
local nav = res:tag('div')
 
:attr('role', 'navigation')
 
:addClass('navbox')
 
:addClass(args.navboxclass)
 
:cssText(args.bodystyle)
 
:cssText(args.style)
 
:css('padding', '3px')
 
:node(tbl)
 
-- aria-labelledby title, otherwise above, otherwise lone group
 
if args.title or args.above or (args.group1 and not args.group2) then
 
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args.above or args.group1))
 
else
 
nav:attr('aria-label', 'Navbox')
 
end
 
end
 
 
if (args.nocat or 'false'):lower() == 'false' then
 
renderTrackingCategories(res)
 
end
 
return striped(tostring(res))
 
 
end
 
end
  +
 
 
function p.navbox(frame)
 
function p.navbox(frame)
  +
-- ParserFunctions considers the empty string to be false, so to preserve the previous
if not getArgs then
 
  +
-- behavior of {{navbox}}, change any empty arguments to nil, so Lua will consider
getArgs = require('Module:Arguments').getArgs
 
  +
-- them false too.
end
 
  +
local args = {}
args = getArgs(frame, {wrappers = {'Template:Navbox', 'Template:Navbox subgroup'}})
 
  +
local parent_args = frame:getParent().args;
if frame.args.border then
 
-- This allows Template:Navbox_subgroup to use {{#invoke:Navbox|navbox|border=...}}.
 
args.border = frame.args.border
 
end
 
   
  +
-- Out of order parsing bug.
-- Read the arguments in the order they'll be output in, to make references number in the right order.
 
local _
+
local temp;
_ = args.title
+
temp = parent_args.title;
_ = args.above
+
temp = parent_args.above;
for i = 1, 20 do
+
for i = 1, 20 do
_ = args["group" .. tostring(i)]
+
temp = parent_args["group" .. tostring(i)];
_ = args["list" .. tostring(i)]
+
temp = parent_args["list" .. tostring(i)];
end
+
end
_ = args.below
+
temp = parent_args.below;
  +
 
  +
for k, v in pairs(parent_args) do
return p._navbox(args)
 
  +
if v ~= '' then
  +
args[k] = v
  +
end
  +
end
  +
return p._navbox(args)
 
end
 
end
  +
 
 
return p
 
return p

Latest revision as of 01:06, 2 August 2020

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

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

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

function addNewline(s)
    if s:match('^[*:;#]') or s:match('^{|') then
        return '\n' .. s ..'\n'
    else
        return s
    end
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')
                	.attr('colspan',2)
    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%')
             .wikitext(addNewline(args.title))
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.wikitext(Navbar.navbar({ 
            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('&nbsp;')
    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')
                .wikitext(addNewline(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')
                .wikitext(addNewline(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')
                    .wikitext(addNewline(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')
            .wikitext(addNewline(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')
                    .wikitext(addNewline(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 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 hwrap', 'hlist vcard', 'vcard hlist', 'hlist vevent'}
    for i, cls in ipairs(listClasses) do
        if args.listclass == cls or args.bodyclass == cls then
            return false
        end
    end

    return true
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 = {}
    local parent_args = frame:getParent().args;

    -- Out of order parsing bug.
    local temp;
    temp = parent_args.title;
    temp = parent_args.above;
    for i = 1, 20 do
        temp = parent_args["group" .. tostring(i)];
        temp = parent_args["list" .. tostring(i)];
    end    
    temp = parent_args.below;
    
    for k, v in pairs(parent_args) do
        if v ~= '' then
            args[k] = v
        end
    end
    return p._navbox(args)
end
 
return p