Wikipedia

Module:Navbox/sandbox: Difference between revisions

Browse history interactively
← Previous edit
Content deleted Content added
put type check into getSubgroup as well to avoid an extra function call
sandbox config
 
(29 intermediate revisions by 7 users not shown)
Line 4:
local inArray = require("Module:TableTools").inArray
local getArgs -- lazily initialized
local hiding_templatestyles = {}
 
-- global passthrough variables
local passthrough = {
[cfg.arg.above]=true,[cfg.arg.aboveclass]=true,[cfg.arg.abovestyle]=true,
[cfg.arg.basestyle]=true,
[cfg.arg.below]=true,[cfg.arg.belowclass]=true,[cfg.arg.belowstyle]=true,
[cfg.arg.bodyclass]=true,
[cfg.arg.groupclass]=true,
[cfg.arg.image]=true,[cfg.arg.imageclass]=true,[cfg.arg.imagestyle]=true,
[cfg.arg.imageleft]=true,[cfg.arg.imageleftstyle]=true,
[cfg.arg.listclass]=true,
[cfg.arg.name]=true,
[cfg.arg.navbar]=true,
[cfg.arg.state]=true,
[cfg.arg.title]=true,[cfg.arg.titleclass]=true,[cfg.arg.titlestyle]=true,
argHash=true
}
 
-- helper functions
local andnum = function(s, n) return string.format(cfg.arg[s .. '_and_num'], n) end
local isblank = function(v) return (v or '') == '' end
 
Line 30 ⟶ 32:
return r
end
 
local function concatstyles(s)
local r = ''
Line 40 ⟶ 42:
return r
end
 
local function getSubgroup(args, listnum, listText, prefix)
local subArgs = {
[cfg.arg.border] = cfg.keyword.border_subgroup,
[cfg.arg.navbar] = cfg.keyword.navbar_plain,
argHash = 0
}
local hasSubArgs = false
local subgroupssubgroups_and_num = prefix and {prefix} or cfg.keywordarg.subgroupssubgroups_and_num
for k, v in pairs(args) do
k = tostring(k)
for _, w in ipairs(subgroupssubgroups_and_num) do
w = string.format(w .., listnum) .. "_"
if (#k > #w) and (k:sub(1, #w) == w) then
subArgs[k:sub(#w + 1)] = v
hasSubArgs = true
subArgs.argHash = subArgs.argHash + (v and #v or 0)
end
end
end
ifreturn hasSubArgs thenand p._navbox(subArgs) or listText
if subArgs.type == cfg.keyword.with_collapsible_groups then
return p._withCollapsibleGroups(subArgs)
elseif subArgs.type == cfg.keyword.with_columns then
return p._withColumns(subArgs)
end
return p._navbox(subArgs)
end
return listText
end
 
Line 117 ⟶ 113:
return (wikitext:gsub(regex, ''):gsub(cfg.marker.regex, changer)) -- () omits gsub count
end
 
local function processItem(item, nowrapitems)
if item:sub(1, 2) == '{|' then
-- Applying nowrap to lines in a table does not make sense.
-- Add newlines to compensate for trim of x in |parm=x in a template.
return '\n' .. item .. '\n'
end
if nowrapitems == cfg.keyword.nowrapitems_yes then
Line 136 ⟶ 132:
end
if item:match('^[*:;#]') then
return '\n' .. item .. '\n'
end
return item
end
 
local function has_navbar()
return args[cfg.arg.navbar] ~= cfg.keyword.navbar_off
Line 150 ⟶ 146:
)
end
 
-- extract text color from css, which is the only permitted inline CSS for the navbar
local function extract_color(css_str)
Line 157 ⟶ 153:
return mw.ustring.match(';' .. css_str .. ';', '.*;%s*([Cc][Oo][Ll][Oo][Rr]%s*:%s*.-)%s*;') or nil
end
 
local function renderNavBar(titleCell)
if has_navbar() then
Line 169 ⟶ 165:
})
end
 
end
 
local function renderTitleRow(tbl)
if not args[cfg.arg.title] then return end
 
local titleRow = tbl:tag('tr')
 
local titleCell = titleRow:tag('th'):attr('scope', 'col')
 
local titleColspan = 2
if args[cfg.arg.imageleft] then titleColspan = titleColspan + 1 end
if args[cfg.arg.image] then titleColspan = titleColspan + 1 end
 
titleCell
:cssText(args[cfg.arg.basestyle])
Line 188 ⟶ 184:
:addClass(cfg.class.navbox_title)
:attr('colspan', titleColspan)
 
renderNavBar(titleCell)
 
titleCell
:tag('div')
-- id for aria-labelledby attribute
:attr('id', mw.uri.anchorEncode(args[cfg.arg.title]) .. args.argHash)
:addClass(args[cfg.arg.titleclass])
:css('font-size', '114%')
Line 200 ⟶ 196:
:wikitext(processItem(args[cfg.arg.title]))
end
 
local function getAboveBelowColspan()
local ret = 2
Line 207 ⟶ 203:
return ret
end
 
local function renderAboveRow(tbl)
if not args[cfg.arg.above] then return end
 
tbl:tag('tr')
:tag('td')
Line 220 ⟶ 216:
:tag('div')
-- id for aria-labelledby attribute, if no title
:attr('id', (not args[cfg.arg.title]) and
(mw.uri.anchorEncode(args[cfg.arg.above]) or.. nilargs.argHash)
or nil)
:wikitext(processItem(args[cfg.arg.above], args[cfg.arg.nowrapitems]))
end
 
local function renderBelowRow(tbl)
if not args[cfg.arg.below] then return end
 
tbl:tag('tr')
:tag('td')
Line 237 ⟶ 235:
:wikitext(processItem(args[cfg.arg.below], args[cfg.arg.nowrapitems]))
end
 
local function renderListRow(tbl, index, listnum, listnums_size)
local row = tbl:tag('tr')
 
if index == 1 and args[cfg.arg.imageleft] then
row
Line 247 ⟶ 245:
:addClass(cfg.class.navbox_image)
:addClass(args[cfg.arg.imageclass])
:css('width', '1px0px') -- Minimize width
:css('padding', '0 2px 0 0')
:cssText(args[cfg.arg.imageleftstyle])
Line 254 ⟶ 252:
:wikitext(processItem(args[cfg.arg.imageleft]))
end
 
local group_and_num = andnum('group', listnum)
local groupstyle_and_num = andnum('groupstyle', listnum)
if args[group_and_num] then
local groupCell = row:tag('th')
 
-- id for aria-labelledby attribute, if lone group with no title or above
if listnum == 1 and not (args[cfg.arg.title] or args[cfg.arg.above] or args[cfg.arg.group2]) then
groupCell
:attr('id', mw.uri.anchorEncode(args[cfg.arg.group1]) .. args.argHash)
end
 
groupCell
:attr('scope', 'row')
Line 273 ⟶ 271:
-- If groupwidth not specified, minimize width
:css('width', args[cfg.arg.groupwidth] or '1%')
 
groupCell
:cssText(args[cfg.arg.groupstyle])
Line 279 ⟶ 277:
:wikitext(args[group_and_num])
end
 
local listCell = row:tag('td')
 
if args[group_and_num] then
listCell
Line 288 ⟶ 286:
listCell:attr('colspan', 2)
end
 
if not args[cfg.arg.groupwidth] then
listCell:css('width', '100%')
end
 
local rowstyle -- usually nil so cssText(rowstyle) usually adds nothing
if index % 2 == 1 then
Line 299 ⟶ 297:
rowstyle = args[cfg.arg.evenstyle]
end
 
local list_and_num = andnum('list', listnum)
local listText = inArray(cfg.keyword.subgroups, args[list_and_num])
and getSubgroup(args, listnum, args[list_and_num]) or args[list_and_num]
 
local oddEven = cfg.marker.oddeven
if listText:sub(1, 12) == '</div><table' then
Line 309 ⟶ 307:
oddEven = listText:find(cfg.pattern.navbox_title) and cfg.marker.restart or cfg.class.navbox_odd_part
end
 
local liststyle_and_num = andnum('liststyle', listnum)
local listclass_and_num = andnum('listclass', listnum)
Line 326 ⟶ 324:
)
:wikitext(processItem(listText, args[cfg.arg.nowrapitems]))
 
if index == 1 and args[cfg.arg.image] then
row
Line 333 ⟶ 331:
:addClass(cfg.class.navbox_image)
:addClass(args[cfg.arg.imageclass])
:css('width', '1px0px') -- Minimize width
:css('padding', '0 0 0 2px')
:cssText(args[cfg.arg.imagestyle])
Line 341 ⟶ 339:
end
end
 
local function has_list_class(htmlclass)
local patterns = {
Line 349 ⟶ 347:
'%s' .. htmlclass .. '%s'
}
 
for arg, _ in pairs(args) do
if type(arg) == 'string' and mw.ustring.find(arg, cfg.pattern.class) then
Line 361 ⟶ 359:
return false
end
 
-- there are a lot of list classes in the wild, so we add their TemplateStyles
local function add_list_styles()
Line 374 ⟶ 372:
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
Line 386 ⟶ 384:
}
end
 
-- hlist -> plainlist is best-effort to preserve old Common.css ordering.
-- this ordering is not a guarantee because most navboxes will emit only
Line 392 ⟶ 390:
return hlist_styles .. plainlist_styles
end
 
local function needsHorizontalLists(border)
if border == cfg.keyword.border_subgroup or args[cfg.arg.tracking] == cfg.keyword.tracking_no then
Line 399 ⟶ 397:
return not has_list_class(cfg.pattern.hlist) and not has_list_class(cfg.pattern.plainlist)
end
 
local function hasBackgroundColors()
for _, key in ipairs({cfg.arg.titlestyle, cfg.arg.groupstyle,
Line 409 ⟶ 407:
return false
end
 
local function hasBorders()
for _, key in ipairs({cfg.arg.groupstyle, cfg.arg.basestyle,
Line 419 ⟶ 417:
return false
end
 
local function isIllegible()
local styleratio = require('Module:Color contrast')._styleratio
Line 431 ⟶ 429:
return false
end
 
local function getTrackingCategories(border)
local cats = {}
Line 440 ⟶ 438:
return cats
end
 
local function renderTrackingCategories(builder, border)
local title = mw.title.getCurrentTitle()
Line 447 ⟶ 445:
if subpage == cfg.keyword.subpage_doc or subpage == cfg.keyword.subpage_sandbox
or subpage == cfg.keyword.subpage_testcases then return end
 
for _, cat in ipairs(getTrackingCategories(border)) do
builder:wikitext('[[Category:' .. cat .. ']]')
end
end
 
local function renderMainTable(border, listnums)
local tbl = mw.html.create('table')
:addClass(cfg.class.nowraplinks)
:addClass(args[cfg.arg.bodyclass])
 
local state = args[cfg.arg.state]
if args[cfg.arg.title] and state ~= cfg.keyword.state_plain and state ~= cfg.keyword.state_off then
Line 467 ⟶ 465:
:addClass(state or cfg.class.autocollapse)
end
 
tbl:css('border-spacing', 0)
if border == cfg.keyword.border_subgroup or border == cfg.keyword.border_none then
Line 481 ⟶ 479:
end
tbl:cssText(args[cfg.arg.innerstyle])
 
renderTitleRow(tbl)
renderAboveRow(tbl)
Line 489 ⟶ 487:
end
renderBelowRow(tbl)
 
return tbl
end
 
local function add_navbox_styles(hiding_templatestyles)
local frame = mw.getCurrentFrame()
Line 504 ⟶ 502:
return ''
end
 
-- get templatestyles. load base from config so that Lua only needs to do
-- the work once of parser tag expansion
Line 510 ⟶ 508:
local templatestyles = add_user_styles(args[cfg.arg.templatestyles])
local child_templatestyles = add_user_styles(args[cfg.arg.child_templatestyles])
 
-- The 'navbox-styles' div exists to wrap the styles to work around T200206
-- more elegantly. Instead of combinatorial rules, this ends up being linear
Line 525 ⟶ 523:
: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 strip_marker_pattern = '(\127[^\127]*UNIQ%-%-templatestyles%-%x+%-QINU[^\127]*\127)'
local function move_hiding_templatestyles(args)
local gfindargHash = string.gfind0
for k, arg in pairs(args) do
local gsub = string.gsub
if type(arg) == 'string' then
local templatestyles_markers = {}
for marker in string.gfind(arg, strip_marker_pattern) do
local strip_marker_pattern = '(\127[^\127]*UNIQ%-%-templatestyles%-%x+%-QINU[^\127]*\127)'
table.insert(hiding_templatestyles, marker)
for k, arg in pairs(args) do
for marker in gfind(arg, strip_marker_pattern) do
table.insert(templatestyles_markers, marker)
end
argHash = argHash + #arg
args[k] = gsub(arg, strip_marker_pattern, '')
args[k] = string.gsub(arg, strip_marker_pattern, '')
end
return templatestyles_markers
end
if not args.argHash then args.argHash = argHash end
local hiding_templatestyles = move_hiding_templatestyles(args)
 
local listnums = {}
 
for k, _ in pairs(args) do
if type(k) == 'string' then
local listnum = k:match(cfg.pattern.listnum)
if listnum thenand table.insertargs[andnum(listnums'list', tonumber(listnum))] endthen
table.insert(listnums, tonumber(listnum))
end
end
end
Line 577 ⟶ 576:
mw.uri.anchorEncode(
args[cfg.arg.title] or args[cfg.arg.above] or args[cfg.arg.group1]
) .. args.argHash
)
else
Line 599 ⟶ 598:
:cssText(args[cfg.arg.bodystyle])
:cssText(args[cfg.arg.style])
:css('padding', '3px0px')
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
Line 606 ⟶ 605:
nav:attr(
'aria-labelledby',
mw.uri.anchorEncode(
args[cfg.arg.title] or args[cfg.arg.above] or args[cfg.arg.group1])
) .. args.argHash
)
else
nav:attr('aria-label', cfg.aria_label .. args.argHash)
end
end
Line 617 ⟶ 618:
end
return striped(tostring(res), border)
end --p._navbox
end
 
function p._withCollapsibleGroups(pargs)
Line 691 ⟶ 692:
[cfg.arg.image] = pargs[andnum('image', n)],
[cfg.arg.imageleft] = pargs[andnum('imageleft', n)],
[cfg.arg.listpadding] = pargs[cfg.arg.listpadding],
argHash = pargs.argHash
})
end
Line 700 ⟶ 702:
targs[cfg.arg.style] = concatstyles({targs[cfg.arg.style] or '', targs[cfg.arg.bodystyle] or ''})
targs[cfg.arg.bodystyle] = nil
 
-- child or subgroup
if targs[cfg.arg.border] == nil then targs[cfg.arg.border] = pargs[1] end
 
return p._navbox(targs)
end --p._withCollapsibleGroups
end
 
function p._withColumns(pargs)
-- table for args passed to navbox
local targs = {}
 
-- tables of column numbers
local colheadernums = {}
local colnums = {}
local colfooternums = {}
 
-- process args
local passthroughLocal = {
Line 750 ⟶ 752:
table.sort(colnums)
table.sort(colfooternums)
 
-- HTML table for list1
local coltable = mw.html.create( 'table' ):attraddClass('class', 'navbox-columns-table')
local row, col
 
local tablestyle = ( (#colheadernums > 0) or (not isblank(pargs[cfg.arg.fullwidth])) )
and 'width:100%'
or 'width:auto; margin-left:auto; margin-right:auto'
 
coltable:attrcssText('style', concatstyles({
'border-spacing: 0px; text-align:left',
tablestyle,
pargs[cfg.arg.coltablestyle] or ''
}))
 
--- Header row ---
if (#colheadernums > 0) then
row = coltable:tag('tr')
for k, n in ipairs(colheadernums) do
col = row:tag('td'):attraddClass('class', 'navbox-abovebelow')
col:attrcssText('style', concatstyles({
(k > 1) and 'border-left:2px solid #fdfdfd' or '',
'font-weight:bold',
Line 780 ⟶ 782:
end
end
 
--- Main columns ---
row = coltable:tag('tr'):attrcss('stylevertical-align', 'vertical-align:top')
for k, n in ipairs(colnums) do
if k == 1 and isblank(pargs[andnum('colheader', 1)])
Line 792 ⟶ 794:
if not nopad then
row:tag('td'):wikitext('&nbsp;&nbsp;&nbsp;')
:attrcss('stylewidth', 'width:'..(pargs[cfg.arg.padding] or '5em')..';')
end
end
col = row:tag('td'):attraddClass('class', 'navbox-list')
col:attrcssText('style', concatstyles({
(k > 1) and 'border-left:2px solid #fdfdfd' or '',
'padding:0px',
Line 806 ⟶ 808:
local wt = pargs[andnum('col', n)]
if wt and inArray(cfg.keyword.subgroups, wt) then
local prefixwt = mw.ustring.gsubgetSubgroup(pargs, n, wt, cfg.arg.col_and_num,"%%d","")
wt = getSubgroup(pargs, n, wt, prefix)
end
col:tag('div'):newline():wikitext(wt):newline()
end
 
--- Footer row ---
if (#colfooternums > 0) then
row = coltable:tag('tr')
for k, n in ipairs(colfooternums) do
col = row:tag('td'):attraddClass('class', 'navbox-abovebelow')
col:attrcssText('style', concatstyles({
(k > 1) and 'border-left:2px solid #fdfdfd' or '',
'font-weight:bold',
Line 827 ⟶ 828:
end
end
 
-- assign table to list1
targs[andnum('list', 1)] = tostring(coltable)
Line 834 ⟶ 835:
and isblank(pargs[andnum('colfooter', 1)]) then
targs[andnum('list', 1)] = targs[andnum('list', 1)] ..
'[[' .. cfg.patterncategory.without_first_col .. ']]'
end
 
Line 846 ⟶ 847:
return p._navbox(targs)
end --p._withColumns
end
 
-- Template entry points
Line 853 ⟶ 854:
-- Read the arguments in the order they'll be output in, to make references
-- number in the right order.
local _ = 0
_ = _ + (args[prefix .. cfg.arg.title] and #args[prefix .. cfg.arg.title] or 0)
_ = _ + (args[prefix .. cfg.arg.above] and #args[prefix .. cfg.arg.above] or 0)
-- Limit this to 20 as covering 'most' cases (that's a SWAG) and because
-- iterator approach won't work here
for i = 1, 20 do
_ = _ + (args[prefix .. andnum('group', i)] and #args[prefix .. andnum('group', i)] or 0)
if inArray(cfg.keyword.subgroups, args[prefix .. andnum('list', i)]) then
for _, v in ipairs(cfg.keywordarg.subgroupssubgroups_and_num) do
readArgs(args, prefix .. string.format(v .., i) .. "_")
end
readArgs(args, prefix .. andnum('col', i) .. "_")
end
end
_ = _ + (args[prefix .. cfg.arg.below] and #args[prefix .. cfg.arg.below] or 0)
return _
end
 
Line 873 ⟶ 876:
end
local args = getArgs(frame, {wrappers = {cfg.pattern[boxtype or 'navbox']}})
args.argHash = readArgs(args, "")
args.type = args.type or cfg.keyword[boxtype]
return p['_navbox'](args)
Retrieved from "https://en.wikipedia.org/wiki/Module:Navbox/sandbox"