Module:Navbox: Difference between revisions

Jump to navigation Jump to search

Module:Navbox (view source)

Revision as of 01:44, 5 November 2021

2,632 bytes added ,  5 November 2021
no edit summary
m (1 revision imported)
No edit summary
Tags: Manual revert Reverted
Line 1: Line 1:
-- <nowiki>
--
--
-- Implements {{navbox}}
-- This module implements {{Navbox}}
--
--


local p = {}
local p = {}
local tnavbar = require( 'Module:Tnavbar' )
 
local yesno = require( 'Module:Yesno' )
local navbar = require('Module:Navbar')._navbar
local onmain = require('Module:Mainonly').on_main()
local getArgs -- lazily initialized
local page_title = mw.title.getCurrentTitle().fullText
 
--
local args
-- Helper for inserting a new row into the navbox
local border
--
local listnums
-- @param tbl {mw.html table}
local ODD_EVEN_MARKER = '\127_ODDEVEN_\127'
-- @return tbl {mw.html table}
local RESTART_MARKER = '\127_ODDEVEN0_\127'
--
local REGEX_MARKER = '\127_ODDEVEN(%d?)_\127'
local function insertRow( tbl )
 
return tbl:tag( 'tr' )
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 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 == 'yes' then
local lines = {}
for line in (item .. '\n'):gmatch('([^\n]*)\n') do
local prefix, content = line:match('^([*:;#]+)%s*(.*)')
if prefix and not content:match('^<span class="nowrap">') then
line = prefix .. '<span class="nowrap">' .. content .. '</span>'
end
table.insert(lines, line)
end
item = table.concat(lines, '\n')
end
if item:match('^[*:;#]') then
return '\n' .. item ..'\n'
end
return item
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;box-shadow:none;padding:0;'
})
end
 
end
end


--
--
-- Creates the navbox table
--   Title row
--
--
-- @param args {table}
local function renderTitleRow(tbl)
-- @return tbl {mw.html table}
if not args.title then return end
--
local function createTbl( args )


local tbl = mw.html.create( 'table' )
local titleRow = tbl:tag('tr')


tbl
if args.titlegroup then
:addClass( yesno( args.subgroup ) and 'navbox-subgroup' or 'navbox' )
titleRow
:addClass( 'nowraplinks' )
:tag('th')
:attr('scope', 'row')
:addClass('navbox-group')
:addClass(args.titlegroupclass)
:cssText(args.basestyle)
:cssText(args.groupstyle)
:cssText(args.titlegroupstyle)
:wikitext(args.titlegroup)
end


if not yesno( args.subgroup ) and
local titleCell = titleRow:tag('th'):attr('scope', 'col')
( args.state == 'collapsed' or
  args.state == 'uncollapsed' or
  args.state == 'autocollapse' or
  -- defaults to autocollapse
  args.state == nil )
then
tbl:addClass( 'mw-collapsible' )


if args.state == 'collapsed' then
if args.titlegroup then
tbl:addClass( 'mw-collapsed' )
titleCell
elseif args.state == 'uncollapsed' then
:css('border-left', '2px solid #fdfdfd')
tbl:addClass('navbox-uncollapsed')
:css('width', '100%')
end
end
end


if yesno( args.collapsible ) then
local titleColspan = 2
tbl:addClass( 'navbox-collapsible' )
if args.imageleft then titleColspan = titleColspan + 1 end
end
if args.image then titleColspan = titleColspan + 1 end
if args.titlegroup then titleColspan = titleColspan - 1 end


if args.style then
titleCell
tbl:cssText( args.style )
:cssText(args.basestyle)
end
:cssText(args.titlestyle)
:addClass('navbox-title')
:attr('colspan', titleColspan)


-- manually set collapse/expand messages
renderNavBar(titleCell)
-- bug causing the default database messages to be used
tbl
:attr( {
['cellspacing'] = '0',
['data-expandtext'] = 'show',
['data-collapsetext'] = 'hide',
['data-navbox-name'] = args.name
} )


return tbl
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
end


--
--
-- Wrapper for [[Module:Tnavbar]]
--   Above/Below rows
--
--
-- @param args {table}
 
-- @return {string}
local function getAboveBelowColspan()
--
local ret = 2
local function navbar( args )
if args.imageleft then ret = ret + 1 end
return tnavbar._collapsible( { [1] = '<span style="display:none;">RS3 </span>'..args.title, [2] = args.name } )
if args.image then ret = ret + 1 end
return ret
end
end


--
local function renderAboveRow(tbl)
-- Creates the header (what you see when the navbox is collapsed)
if not args.above then return end
--
 
-- @param tbl {mw.html table}
tbl:tag('tr')
-- @param args {table}
:tag('td')
-- @return {mw.html table}
:addClass('navbox-abovebelow')
--
:addClass(args.aboveclass)
local function header( tbl, args )
:cssText(args.basestyle)
local div = insertRow( tbl )
:cssText(args.abovestyle)
:tag( 'th' )
:attr('colspan', getAboveBelowColspan())
:attr( 'colspan', '2' )
:tag('div')
:addClass( 'navbox-title' )
-- id for aria-labelledby attribute, if no title
:attr( 'id' , 'navbox-title' )
:attr('id', args.title and nil or mw.uri.anchorEncode(args.above))
:tag( 'div' )
:wikitext(processItem(args.above, args.nowrapitems))
end


-- @todo move this to site css so we can simplify this (hook off a class)
local function renderBelowRow(tbl)
-- to something like div:wikitext( args.name and navbar( args ) or args.title )
if not args.below then return end
-- which can be appended to the above and returned straight away
if args.name then
div
:css( 'padding-right', args.state == 'plain' and '6em' or '0' )
:wikitext( navbar( args ) )
else
div
:css( 'padding-left', args.state == 'plain' and '0' or '6em' )
:wikitext( '<span style="display:none;">RS3 </span>'..args.title )
end


return div:allDone()
tbl:tag('tr')
: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


--
--
-- Inserts a row into the navbox
--   List rows
--
--
-- @param tbl {mw.html table}
local function renderListRow(tbl, index, listnum)
-- @param gtitle {string}
local row = tbl:tag('tr')
-- @param group {string}
 
-- @param gtype {string}
if index == 1 and args.imageleft then
-- @param gcats {table}
row
-- @param style {string}
:tag('td')
-- @return {mw.html table}
:addClass('noviewer')
--
:addClass('navbox-image')
local function row( tbl, gtitle, group, gtype, gcats, style, _name, subgroup )
:addClass(args.imageclass)
local tr = insertRow( tbl )
:css('width', '1px')               -- Minimize width
local td
:css('padding', '0px 2px 0px 0px')
:cssText(args.imageleftstyle)
if gtitle then
:attr('rowspan', #listnums)
td = tr
:tag('div')
:addClass( 'navbox-group' )
:wikitext(processItem(args.imageleft))
:tag( 'td' )
:addClass( 'navbox-group-title' )
:wikitext( gtitle )
:done()
:tag( 'td' )
else
td = tr
:addClass( 'navbox-group' )
:addClass( 'navbox-group-split' )
:tag( 'td' )
:addClass( 'navbox-group-title-hidden' )
:attr( 'colspan', '0' )
:css( 'display', 'none' )
:done()
:tag( 'td' )
:attr( 'colspan', '2' )
end
end


--[[
if args['group' .. listnum] then
  List styling
local groupCell = row:tag('th')
  This is unlikely to be implemented in the near future due to it requiring extra css to work
  and mobile currently not supporting that css.
  As an example, it lets you do the following instead if using {{*}} all the time
  | group3 =
  * {{plink|foo}}
  * {{plink|bar}}
  * {{plink|baz}}
]]
if mw.ustring.match( group, '^%s*%*' ) then
td:newline()


-- trim whitespace on bullets
-- id for aria-labelledby attribute, if lone group with no title or above
local spl = mw.text.split( group, '\n' )
if listnum == 1 and not (args.title or args.above or args.group2) then
groupCell
:attr('id', mw.uri.anchorEncode(args.group1))
end


for i = 1, #spl do
groupCell
spl[i] = mw.text.trim( spl[i] )
:attr('scope', 'row')
end
:addClass('navbox-group')
:addClass(args.groupclass)
:cssText(args.basestyle)
:css('width', args.groupwidth or '1%') -- If groupwidth not specified, minimize width


group = '\n' .. table.concat( spl, '\n' )
groupCell
:cssText(args.groupstyle)
:cssText(args['group' .. listnum .. 'style'])
:wikitext(args['group' .. listnum])
end
end


--local group2 = group
local listCell = row:tag('td')
--local group3 = group2
-- analytics


--if _name then
if args['group' .. listnum] then
-- local name = mw.ustring.gsub(_name,' ','_')
listCell
-- for v in mw.ustring.gmatch(group,'%[%[[^%]]+%]%]') do
:css('text-align', 'left')
-- if mw.ustring.match(v,'%[%[File:.+|link=') then
:css('border-left-width', '2px')
-- local link = mw.ustring.match(v,'|link=([^%]|]+)')
:css('border-left-style', 'solid')
-- if link then
else
-- local linkrep = mw.ustring.gsub(link,'([%%%]%[%-^$*()+?])','%%%1')
listCell:attr('colspan', 2)
-- local _link = mw.ustring.gsub(link,' ','_')
end
-- local newfile = mw.ustring.gsub(v,'|link='..linkrep,string.format('|link=https://runescape.wiki/w/%s?f=%s',_link,name))
-- local w = mw.ustring.gsub(v,'([%%%]%[%-^$*()+?])','%%%1')
-- group2 = mw.ustring.gsub(group2,w,newfile)
-- end
-- elseif mw.ustring.match(v,'%[%[Category:') then
-- nothing
-- else
-- local link = mw.ustring.match(v,'%[%[([^%]|]+)')
-- local txt = mw.ustring.match(v,'%|([^%]|]+)') or link


-- local newlink = ''
if not args.groupwidth then
listCell:css('width', '100%')
end


-- black links if current page
local rowstyle  -- usually nil so cssText(rowstyle) usually adds nothing
-- if link == page_title then
if index % 2 == 1 then
-- newlink = string.format('<b>%s</b>',txt)
rowstyle = args.oddstyle
-- else
else
-- local _link = mw.ustring.gsub(link or '',' ','_')
rowstyle = args.evenstyle
-- newlink = string.format('[https://runescape.wiki.com/w/%s?n=%s %s]',_link,name,txt)
end
-- end
-- local w = mw.ustring.gsub(v,'([%%%]%[%-^$*()+?])','%%%1')
-- group2 = mw.ustring.gsub(group2,w,newlink)
-- end
-- end


--[==[
local listText = args['list' .. listnum]
fix [[these kind]]s of [[link]]s post analytics parse
local oddEven = ODD_EVEN_MARKER
]==]
if listText:sub(1, 12) == '</div><table' then
-- group3 = group2
-- 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))


-- for v in mw.ustring.gmatch(group2,'%[https://runescape.wiki.com/w[^%]]-%]%a') do
if index == 1 and args.image then
-- local rep = mw.ustring.gsub(v,'%]','')
row
-- rep = rep..']'
:tag('td')
-- local w = mw.ustring.gsub(v,'([%%%]%[%-^$*()+?])','%%%1')
:addClass('noviewer')
: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


-- group3 = mw.ustring.gsub(group2,w,rep)
-- end
--end


td
--
:addClass( 'navbox-list' )
--  Tracking categories
:wikitext( group ) --group3
--


if gtype and mw.ustring.lower( gtype ) == 'subgroup' then
local function needsHorizontalLists()
td
if border == 'subgroup' or args.tracking == 'no' then
:addClass( 'navbox-parent' )
return false
:css( {
padding = '0',
['border-bottom'] = '0'
} )
end
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


if style then
local function hasBackgroundColors()
td:cssText( style )
for _, key in ipairs({'titlestyle', 'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
end
if tostring(args[key]):find('background', 1, true) then
return true
-- add subgroup categories
if next(gcats) and onmain then
first_char = page_title:sub(1,1)
title_pattern = "[" .. first_char:upper() .. first_char:lower() .. "]" .. page_title:sub(2)
title_pattern = title_pattern :gsub("%(","%%(")
:gsub("%)","%%)")
:gsub("_"," ")
:gsub(" ","[_ ]")
:gsub("%-","%%-")
local link_patterns = {
"%[%["..title_pattern.."%]%]", "%[%["..title_pattern.."%|", "{{[Pp]link%|"..title_pattern.."}}",
"{{[Pp]link%|"..title_pattern.."%|", "{{[Pp]linkp%|"..title_pattern.."}}",
"{{[Pp]linkp%|"..title_pattern.."%|", "{{[Ii]linkp%|"..title_pattern.."}}",
"{{[Ii]linkp%|"..title_pattern.."%|", "{{[Cc]hatl%|"..title_pattern.."}}",
"{{[Cc]hatl%|"..title_pattern.."%|"
}
for _,v in ipairs(link_patterns) do
if group:match(v) then
for _,cat in ipairs(gcats) do
td:wikitext('[[Category:'..cat..']]')
end
break
end
end
end
end
end
return td:allDone()
end
end


--
local function hasBorders()
-- Inserts a footer into the navbox
for _, key in ipairs({'groupstyle', 'basestyle', 'abovestyle', 'belowstyle'}) do
--
if tostring(args[key]):find('border', 1, true) then
-- @param tbl {mw.html table}
return true
-- @param args {table}
end
-- @return {mw.html table}
--
local function footer( tbl, args )
local th = insertRow( tbl )
:tag( 'th' )
:attr( 'colspan', '2' )
:addClass( 'navbox-footer' )
 
if args.fstyle then
th:cssText( args.fstyle )
end
end
end


if mw.ustring.match( args.footer, '^%s*%*' ) then
local function isIllegible()
th:newline()
local styleratio = require('Module:Color contrast')._styleratio


-- trim whitespace on bullets
for key, style in pairs(args) do
local spl = mw.text.split( args.footer, '\n' )
if tostring(key):match("style$") then
 
if styleratio{mw.text.unstripNoWiki(style)} < 4.5 then
for i = 1, #spl do
return true
spl[i] = mw.text.trim( spl[i] )
end
end
end
args.footer = table.concat( spl, '\n' )
th:addClass( 'navbox-list' )
end
end
return false
end


th:wikitext( args.footer )
local function getTrackingCategories()
 
local cats = {}
return th:allDone()
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)
-- Adds [[Category:Navigational templates]] to navbox template pages
--
-- @return {string}
--
local function categories()
local title = mw.title.getCurrentTitle()
local title = mw.title.getCurrentTitle()
local page = title.text
if title.namespace ~= 10 then return end -- not in template space
local ns = title.nsText
local subpage = title.subpageText
if subpage == 'doc' or subpage == 'sandbox' or subpage == 'testcases' then return end


if ns == 'Template' then
for _, cat in ipairs(getTrackingCategories()) do
-- sort in category by pagename
builder:wikitext('[[Category:' .. cat .. ']]')
return '[[Category:Navigational templates|' .. page .. ']]'
else
return ''
end
end
end
end


--
--
-- Adds [[Template:Navbox/doc]] to navbox template pages
--   Main navbox tables
--
--
-- @param args {table}
local function renderMainTable()
-- @return {string}
local tbl = mw.html.create('table')
--
:addClass('nowraplinks')
local function docs( args )
:addClass(args.bodyclass)
local frame = mw.getCurrentFrame()
 
local title = mw.title.getCurrentTitle()
if args.title and (args.state ~= 'plain' and args.state ~= 'off') then
local base = title.baseText
if args.state == 'collapsed' then args.state = 'mw-collapsed' end
local ns = title.nsText
tbl
:addClass('mw-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)


-- not if a subpage of [[Template:Navbox]]
renderTitleRow(tbl)
if base ~= 'Navbox' and
renderAboveRow(tbl)
-- in template ns
for i, listnum in ipairs(listnums) do
ns == 'Template' and
renderListRow(tbl, i, listnum)
-- not a navbox group within a navbox
not yesno( args.subgroup ) and
-- not a collapsible navbox within a navbox
not yesno( args.collapsible ) and
-- not if the doc argument is not set to "yes"
yesno( args.doc, false )
then
return frame:expandTemplate{ title = 'Navbox/doc' }
else
return ''
end
end
renderBelowRow(tbl)


return tbl
end
end


--
function p._navbox(navboxArgs)
-- Navbox method to allow it to be called by other modules
args = navboxArgs
--
listnums = {}
-- @param _args {table}
 
-- @return {string}
for k, _ in pairs(args) do
--
if type(k) == 'string' then
function p._navbox( _args )
local listnum = k:match('^list(%d+)$')
local args = {}
if listnum then table.insert(listnums, tonumber(listnum)) end
local wkCss = ''
local wkDiv = ''
local j
-- preserves parser function behaviour where an empty string is considered undefined
-- or nil in lua's case
for k, v in pairs( _args ) do
if v ~= '' then
args[k] = v
end
end
end
end
table.sort(listnums)


local tbl = createTbl( args )
border = mw.text.trim(args.border or args[1] or '')
 
if border == 'child' then
if not yesno( args.subgroup ) then
border = 'subgroup'
tbl = header( tbl, args )
end
end


-- insert up to 20 rows
-- render the main body of the navbox
--
local tbl = renderMainTable()
-- 20 is a limit inherited from wikipedia when we copied this over
-- and we've never had a reason to extend it
for i = 1, 20 do
j = tostring( i )


if args['group' .. j] then
-- render the appropriate wrapper around the navbox, depending on the border param
local gcats = {}
local res = mw.html.create()
for p = 1, 20 do
if border == 'none' then
local q = tostring ( p )
local nav = res:tag('div')
:attr('role', 'navigation')
if args['g' .. j .. 'cat' .. q] then
:node(tbl)
table.insert(gcats, args['g' .. j .. 'cat' .. q])
-- aria-labelledby title, otherwise above, otherwise lone group
else
if args.title or args.above or (args.group1 and not args.group2) then
break
nav:attr('aria-labelledby', mw.uri.anchorEncode(args.title or args.above or args.group1))
end
else
end
nav:attr('aria-label', 'Navbox')
end
tbl = row( tbl, args['gtitle' .. j], args['group' .. j], args['gtype' .. j], gcats, args['style' .. j], args.name, args.subgroup )
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')
: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
else
break
nav:attr('aria-label', 'Navbox')
end
end
end
end


if args.footer then
if (args.nocat or 'false'):lower() == 'false' then
tbl = footer( tbl, args )
renderTrackingCategories(res)
end
end
return striped(tostring(res))
end


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


local cats = ''
-- Read the arguments in the order they'll be output in, to make references number in the right order.
if not yesno(args.subgroup) and not yesno(args.hidecat) then
local _
cats = categories()
_ = args.title
_ = args.above
for i = 1, 20 do
_ = args["group" .. tostring(i)]
_ = args["list" .. tostring(i)]
end
end
local docs = docs( args )
_ = args.below
 
return tbl .. cats .. docs
end


--
return p._navbox(args)
-- Main navbox method accessed through #invoke
--
-- @param frame {table}
-- @return {string}
--
function p.navbox( frame )
local args = frame:getParent().args
return p._navbox( args )
end
end


return p
return p
-- </nowiki>
Retrieved from "https://wideboys.org/Special:MobileDiff/11372"

Navigation menu