Module:Navbox - Revision history

Cyclops: 1 revision imported

2023-05-22T19:58:18Z

1 revision imported

← Older revision

Revision as of 19:58, 22 May 2023

wikipedia>Lemondoge: Fixing ternary expression short-circuit ("foo and nil or bar" is always equal to "bar", but "not foo and bar or nil" produces the intended effect)

2023-04-17T13:46:15Z

Fixing ternary expression short-circuit ("foo and nil or bar" is always equal to "bar", but "not foo and bar or nil" produces the intended effect)

← Older revision		Revision as of 13:46, 17 April 2023
Line 70:		Line 70:
	end		end

	~~-- we will want this later when we want to add tstyles for hlist/plainlist~~
	local function has_navbar()		local function has_navbar()
	return args[cfg.arg.navbar] ~= cfg.keyword.navbar_off		return args[cfg.arg.navbar] ~= cfg.keyword.navbar_off
Line 142:		Line 141:
	:tag('div')		:tag('div')
	-- id for aria-labelledby attribute, if no title		-- id for aria-labelledby attribute, if no title
	:attr('id', args[cfg.arg.title] and ~~nil or~~ mw.uri.anchorEncode(args[cfg.arg.above]))		:attr('id', (not args[cfg.arg.title]) and mw.uri.anchorEncode(args[cfg.arg.above]) or nil)
	:wikitext(processItem(args[cfg.arg.above], args[cfg.arg.nowrapitems]))		:wikitext(processItem(args[cfg.arg.above], args[cfg.arg.nowrapitems]))
	end		end
Line 262:		Line 261:
	end		end

	~~-- uses this now to make the needHlistCategory correct~~
	~~-- to use later for when we add list styles via navbox~~
	local function has_list_class(htmlclass)		local function has_list_class(htmlclass)
	~~local class_args = { -- rough order of probability of use~~
	~~cfg.arg.bodyclass, cfg.arg.listclass, cfg.arg.aboveclass,~~
	~~cfg.arg.belowclass, cfg.arg.titleclass, cfg.arg.navboxclass,~~
	~~cfg.arg.groupclass, cfg.arg.imageclass~~
	}
	local patterns = {		local patterns = {
	'^' .. htmlclass .. '$',		'^' .. htmlclass .. '$',
Line 277:		Line 269:
	}		}

	for _~~, arg~~ in ~~ipairs~~(~~class_args~~) do		for arg, _ in pairs(args) do
	for _, pattern in ipairs(patterns) do		if type(arg) == 'string' and mw.ustring.find(arg, cfg.pattern.class) then
	if mw.ustring.find(args[arg] or '', pattern) then		for _, pattern in ipairs(patterns) do
	return true		if mw.ustring.find(args[arg] or '', pattern) then
			return true
			end
	end		end
	end		end
	end		end
	return false		return false
			end

			-- there are a lot of list classes in the wild, so we add their TemplateStyles
			local function add_list_styles()
			local frame = mw.getCurrentFrame()
			local function add_list_templatestyles(htmlclass, templatestyles)
			if has_list_class(htmlclass) then
			return frame:extensionTag{
			name = 'templatestyles', args = { src = templatestyles }
			}
			else
			return ''
			end
			end

			local hlist_styles = add_list_templatestyles('hlist', cfg.hlist_templatestyles)
			local plainlist_styles = add_list_templatestyles('plainlist', cfg.plainlist_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() and hlist_styles == '' then
			hlist_styles = frame:extensionTag{
			name = 'templatestyles', args = { src = cfg.hlist_templatestyles }
			}
			end

			-- hlist -> plainlist is best-effort to preserve old Common.css ordering.
			-- this ordering is not a guarantee because most navboxes will emit only
			-- one of these classes [hlist_note]
			return hlist_styles .. plainlist_styles
	end		end

Line 387:		Line 412:
	end		end

	local function add_navbox_styles()		local function add_navbox_styles(hiding_templatestyles)
	local frame = mw.getCurrentFrame()		local frame = mw.getCurrentFrame()
	-- This is a lambda so that it doesn't need the frame as a parameter		-- This is a lambda so that it doesn't need the frame as a parameter
Line 405:		Line 430:
	local child_templatestyles = add_user_styles(args[cfg.arg.child_templatestyles])		local child_templatestyles = add_user_styles(args[cfg.arg.child_templatestyles])

	-- The 'navbox-styles' div exists ~~for two reasons:~~		-- The 'navbox-styles' div exists to wrap the styles to work around T200206
	~~-- 1. To~~ wrap the styles to work around T200206 more elegantly. Instead		-- more elegantly. Instead of combinatorial rules, this ends up being linear
	-- of combinatorial rules, this ends up being linear number of CSS rules.		-- number of CSS rules.
	~~-- 2. To allow MobileFrontend to rip the styles out with 'nomobile' such that~~
	~~-- they are not dumped into the mobile view~~.
	return mw.html.create('div')		return mw.html.create('div')
	:addClass(cfg.class.navbox_styles)		:addClass(cfg.class.navbox_styles)
	:~~addClass~~(~~cfg~~.~~class~~.~~nomobile)~~		:wikitext(
	~~:wikitext(~~base_templatestyles .. templatestyles .. child_templatestyles)		add_list_styles() .. -- see [hlist_note] applied to 'before base_templatestyles'
			base_templatestyles ..
			templatestyles ..
			child_templatestyles ..
			table.concat(hiding_templatestyles)
			)
	:done()		:done()
			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		end

	function p._navbox(navboxArgs)		function p._navbox(navboxArgs)
	args = navboxArgs		args = navboxArgs
			local hiding_templatestyles = move_hiding_templatestyles(args)
	local listnums = {}		local listnums = {}

Line 441:		Line 487:

	if border == cfg.keyword.border_none then		if border == cfg.keyword.border_none then
	res:node(add_navbox_styles())		res:node(add_navbox_styles(hiding_templatestyles))
	local nav = res:tag('div')		local nav = res:tag('div')
	:attr('role', 'navigation')		:attr('role', 'navigation')
Line 467:		Line 513:
	:wikitext('<div>')		:wikitext('<div>')
	else		else
	res:node(add_navbox_styles())		res:node(add_navbox_styles(hiding_templatestyles))
	local nav = res:tag('div')		local nav = res:tag('div')
	:attr('role', 'navigation')		:attr('role', 'navigation')

Cyclops: 1 revision imported

2022-07-26T20:50:41Z

1 revision imported

← Older revision

Revision as of 20:50, 26 July 2022

wikipedia>Izno: remove titlegroup per templatestyles section on talk page

2022-01-07T21:39:23Z

remove titlegroup per templatestyles section on talk page

Show changes

Cyclops: 1 revision imported

2017-03-25T16:20:33Z

1 revision imported

New page

--
-- This module implements {{Navbox}}
--

local p = {}

local navbar = require('Module:Navbar')._navbar
local getArgs -- lazily initialized

local args
local tableRowAdded = false
local border
local listnums = {}
local ODD_EVEN_MARKER = '\127_ODDEVEN_\127'
local RESTART_MARKER = '\127_ODDEVEN0_\127'
local REGEX_MARKER = '\127_ODDEVEN(%d?)_\127'

local function striped(wikitext)
-- Return wikitext with markers replaced for odd/even striping.
-- Child (subgroup) navboxes are flagged with a category that is removed
-- by parent navboxes. The result is that the category shows all pages
-- where a child navbox is not contained in a parent navbox.
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

local function addNewline(s)
if s:match('^[*:;#]') or s:match('^{|') then
return '\n' .. s ..'\n'
else
return s
end
end

local 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

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;'
})
end

end

--
-- Title row
--
local 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')
:attr('id', mw.uri.anchorEncode(args.title))
:addClass(args.titleclass)
:css('font-size', '114%')
:css('margin', '0 4em')
:wikitext(addNewline(args.title))
end

--
-- Above/Below rows
--

local function getAboveBelowColspan()
local ret = 2
if args.imageleft then ret = ret + 1 end
if args.image then ret = ret + 1 end
return ret
end

local 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

local 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

--
-- List rows
--
local function renderListRow(tbl, index, listnum)
local row = addTableRow(tbl)

if index == 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 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)
:tag('div')
:css('padding', (index == 1 and args.list1padding) or args.listpadding or '0em 0.25em')
:wikitext(addNewline(listText))

if index == 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
--

local function needsHorizontalLists()
if border == 'subgroup' or args.tracking == 'no' then
return false
end
local listClasses = {
['plainlist'] = true, ['hlist'] = true, ['hlist hnum'] = true,
['hlist hwrap'] = true, ['hlist vcard'] = true, ['vcard hlist'] = true,
['hlist vevent'] = true,
}
return not (listClasses[args.listclass] or listClasses[args.bodyclass])
end

local function hasBackgroundColors()
for _, key in ipairs({'titlestyle', 'groupstyle', 'basestyle'}) do
if tostring(args[key]):find('background', 1, true) then
return true
end
end
end

local function isIllegible()
local styleratio = require('Module:Color contrast')._styleratio

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

local 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
if isIllegible() then table.insert(cats, 'Potentially illegible navboxes') end
return cats
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 i, cat in ipairs(getTrackingCategories()) do
builder:wikitext('[[Category:' .. cat .. ']]')
end
end

--
-- Main navbox tables
--
local function renderMainTable()
local tbl = mw.html.create('table')
: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 == 'none' then
tbl
:addClass('navbox-subgroup')
:cssText(args.bodystyle)
:cssText(args.style)
else -- regular navbox - 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, i, 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 = mw.text.trim(args.border or args[1] or '')
if border == 'child' then
border = 'subgroup'
end

-- render the main body of the navbox
local tbl = renderMainTable()

-- render the appropriate wrapper around the navbox, depending on the border param
local res = mw.html.create()
if border == 'none' then
local nav = res:tag('div')
:attr('role', 'navigation')
:node(tbl)
if args.title then
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
else
nav:attr('aria-label', 'Navbox')
end
elseif border == 'subgroup' 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
:wikitext('</div>')
:node(tbl)
:wikitext('<div>')
else
local nav = res:tag('div')
:attr('role', 'navigation')
:addClass('navbox')
:cssText(args.bodystyle)
:cssText(args.style)
:css('padding', '3px')
:node(tbl)
if args.title then
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title))
else
nav:attr('aria-label', 'Navbox')
end
end

renderTrackingCategories(res)

return striped(tostring(res))
end

function p.navbox(frame)
if not getArgs then
getArgs = require('Module:Arguments').getArgs
end
args = getArgs(frame, {wrappers = 'Template:Navbox'})

-- Read the arguments in the order they'll be output in, to make references number in the right order.
local _
_ = args.title
_ = args.above
for i = 1, 20 do
_ = args["group" .. tostring(i)]
_ = args["list" .. tostring(i)]
end
_ = args.below

return p._navbox(args)
end

return p