Module:Navbox - Revision history

76561198021843184: 7 revisions imported

2025-10-21T23:46:41Z

7 revisions imported

← Older revision		Revision as of 23:46, 21 October 2025
(No difference)

wgg>Cadaei: update from https://defaultloadout.wiki.gg/wiki/Module:Navbox

2025-09-27T21:35:44Z

update from https://defaultloadout.wiki.gg/wiki/Module:Navbox

← Older revision		Revision as of 21:35, 27 September 2025
Line 1:		Line 1:
	-- version 1.2.4		-- version 1.2.5.1

	-- config table for RANGER.		-- config table for RANGER.
Line 5:		Line 5:
	-- please do it via the `onLoadConfig` hook in [[Module:Navbox/Hooks]].		-- please do it via the `onLoadConfig` hook in [[Module:Navbox/Hooks]].
	local config = {		local config = {
	default_navbox_class = "navigation-not-searchable", -- Base value of the `class` parameter.		default_navbox_class = "navigation-not-searchable noexcerpt", -- Base value of the `class` parameter.
	default_title_class = nil, -- Base value of the `title_class` parameter.		default_title_class = nil, -- Base value of the `title_class` parameter.
	default_above_class = nil, -- Base value of the `above_class` parameter.		default_above_class = nil, -- Base value of the `above_class` parameter.
Line 17:		Line 17:

	editlink_hover_message_key = 'Navbox-edit-hover', -- The system message name for hover text of the edit icon.		editlink_hover_message_key = 'Navbox-edit-hover', -- The system message name for hover text of the edit icon.

			auto_flatten_top_level = true, -- If true, when a section has only one list with no content and no corresponding group but has sublists, these sublists will be moved to top level.
			-- This helps make the hierarchy of sections and content clearer.
			-- An example:
			-- {{navbox
			-- ...
			-- \|header1 = Items
			-- \| group1.1 = Weapons
			-- \| list1.1 = Swords · Guns · Wands
			-- \| group1.2 = Armors
			-- \| list1.2 = Head pieces · Capes
			-- \|header2 = NPCs
			-- \| group2.1 = Town NPCs
			-- \| list2.1 = Guide · Witch
			-- ...
			-- }}
			-- will be equal to:
			-- {{navbox
			-- ...
			-- \|header1 = Items
			-- \| group2 = Weapons
			-- \| list2 = Swords · Guns · Wands
			-- \| group3 = Armors
			-- \| list3 = Head pieces · Capes
			-- \|header5 = NPCs
			-- \| group6 = Town NPCs
			-- \| list6 = Guide · Witch
			-- ...
			-- }}

	custom_render_handle = nil, -- usually for debugging purposes only. if set, it should be a function accept 2 parameters: `dataTree` and `args`, and return a string as module output.		custom_render_handle = nil, -- usually for debugging purposes only. if set, it should be a function accept 2 parameters: `dataTree` and `args`, and return a string as module output.
Line 363:		Line 392:
	-- flatten if needed:		-- flatten if needed:
	-- If a section has only one list with no content and no corresponding group but has sublists, these sublists will be moved to upper level.		-- If a section has only one list with no content and no corresponding group but has sublists, these sublists will be moved to upper level.
	for _, sect in ipairs(sections) do		if config.auto_flatten_top_level then
	if #sect.body == 1 then		for _, sect in ipairs(sections) do
	local node = sect.body[1]		if #sect.body == 1 then
	if not node.group and not node.list and node.sections and #node.sections == 1 and not node.sections[1].header then		local node = sect.body[1]
	sect.body = node.sections[1].body		if not node.group and not node.list and node.sections and #node.sections == 1 and not node.sections[1].header then
			sect.body = node.sections[1].body
			end
	end		end
	end		end
	end		end
	return sections		return sections
	end		end

wgg>Cadaei: 1 revision imported: updating to current dlw version

2025-04-19T19:47:19Z

1 revision imported: updating to current dlw version

← Older revision		Revision as of 19:47, 19 April 2025
(No difference)

dlw>Westgrass: it should be a bug fix.

2025-04-06T13:47:55Z

it should be a bug fix.

← Older revision		Revision as of 13:47, 6 April 2025
Line 1:		Line 1:
	-- version 1.2.2		-- version 1.2.4

	-- config table for RANGER.		-- config table for RANGER.
Line 54:		Line 54:
	['plain'] = '',		['plain'] = '',
	['collapsed'] = 'mw-collapsible mw-collapsed',		['collapsed'] = 'mw-collapsible mw-collapsed',
			['expanded'] = 'mw-collapsible',
	}		}

Line 167:		Line 168:

	------------------------------------------------------------------------		------------------------------------------------------------------------

			-- equivalent to mw.text.split(str, div, true) for non-empty separator, but can be over 60x faster, since the latter is Unicode-aware.
			-- Original version credit: http://richard.warburton.it.
			function h.explode(div, str)
			if (div=='') then return nil end
			local pos,arr = 0,{}
			-- for each divider found
			for st,sp in function() return string.find(str,div,pos,true) end do
			arr[#arr+1] = string.sub(str,pos,st-1) -- Attach chars left of current divider
			pos = sp+1 -- Jump past current divider
			end
			arr[#arr+1] = string.sub(str,pos) -- Attach chars right of last divider
			return arr
			end

	function h.parseArgs(inputArgs)		function h.parseArgs(inputArgs)
Line 434:		Line 449:

	-- find the node that matches the index in the tree		-- find the node that matches the index in the tree
	local arr = mw.~~text.split~~(~~index,~~ '.', ~~true~~)		local arr = h.explode('.', index)
	local node = tree		local node = tree
	for _, v in ipairs(arr) do		for _, v in ipairs(arr) do

wgg>RheingoldRiver: Pushing 1.43-related updates to all wikis - please let us know at https://discord.gg/rTnST57tuW if you have questions or want to opt out

2025-03-27T04:41:23Z

Pushing 1.43-related updates to all wikis - please let us know at https://discord.gg/rTnST57tuW if you have questions or want to opt out

Show changes

wgg>Cadaei: using RANGER from https://support.wiki.gg/wiki/Module:Navbox

2024-12-12T18:31:51Z

using RANGER from https://support.wiki.gg/wiki/Module:Navbox

Show changes

wgg>Cadaei: from https://defaultloadout.wiki.gg/wiki/Module:Navbox

2024-12-12T18:20:14Z

from https://defaultloadout.wiki.gg/wiki/Module:Navbox

Show changes

wgg>Cadaei: from https://ark.wiki.gg/wiki/Module:Navbox

2023-06-22T19:00:19Z

from https://ark.wiki.gg/wiki/Module:Navbox

New page

local p = {}
local navbar = require('Module:Navbar')._navbar
local cfg = mw.loadData('Module:Navbox/configuration')
local getArgs -- lazily initialized
local args
local format = string.format

local function striped(wikitext, border)
-- 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.
if border == cfg.keyword.border_subgroup and args[cfg.arg.orphan] ~= cfg.keyword.orphan_yes then
-- No change; striping occurs in outermost navbox.
return wikitext
end
local first, second = cfg.class.navbox_odd_part, cfg.class.navbox_even_part
if args[cfg.arg.evenodd] then
if args[cfg.arg.evenodd] == cfg.keyword.evenodd_swap then
first, second = second, first
else
first = args[cfg.arg.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
return (wikitext: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
local lines = {}
for line in (item .. '\n'):gmatch('([^\n]*)\n') do
local prefix, content = line:match('^([*:;#]+)%s*(.*)')
if prefix and not content:match(cfg.pattern.nowrap) then
line = format(cfg.nowrap_item, prefix, content)
end
table.insert(lines, line)
end
item = table.concat(lines, '\n')
end
if item:match('^[*:;#]') then
return '\n' .. item ..'\n'
end
return item
end

-- we will want this later when we want to add tstyles for hlist/plainlist
local function has_navbar()
return args[cfg.arg.navbar] ~= cfg.keyword.navbar_off
and args[cfg.arg.navbar] ~= cfg.keyword.navbar_plain
and (
args[cfg.arg.name]
or mw.getCurrentFrame():getParent():getTitle():gsub(cfg.pattern.sandbox, '')
~= cfg.pattern.navbox
)
end

local function renderNavBar(titleCell)
if has_navbar() then
titleCell:wikitext(navbar{
[cfg.navbar.name] = args[cfg.arg.name],
[cfg.navbar.mini] = 1,
[cfg.navbar.fontstyle] = (args[cfg.arg.basestyle] or '') .. ';' ..
(args[cfg.arg.titlestyle] or '') ..
';background:none transparent;border:none;box-shadow:none;padding:0;'
})
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])
:cssText(args[cfg.arg.titlestyle])
: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]))
:addClass(cfg.class.navbox_title_text)
:addClass(args[cfg.arg.titleclass])
:wikitext(processItem(args[cfg.arg.title]))

-- ARK: spacer
tbl:tag('tr')
:addClass('navbox-spacer')
end

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

local function renderAboveRow(tbl)
if not args[cfg.arg.above] then return end

tbl:tag('tr')
:tag('td')
:addClass(cfg.class.navbox_abovebelow)
:addClass(args[cfg.arg.aboveclass])
:cssText(args[cfg.arg.basestyle])
:cssText(args[cfg.arg.abovestyle])
:attr('colspan', getAboveBelowColspan())
:tag('div')
-- id for aria-labelledby attribute, if no title
:attr('id', args[cfg.arg.title] and nil or mw.uri.anchorEncode(args[cfg.arg.above]))
:wikitext(processItem(args[cfg.arg.above], args[cfg.arg.nowrapitems]))

-- ARK: spacer
tbl:tag('tr')
:addClass('navbox-spacer')
end

local function renderBelowRow(tbl)
if not args[cfg.arg.below] then return end

-- ARK: spacer
tbl:tag('tr')
:addClass('navbox-spacer')

tbl:tag('tr')
:tag('td')
:addClass(cfg.class.navbox_abovebelow)
:addClass(args[cfg.arg.belowclass])
:cssText(args[cfg.arg.basestyle])
:cssText(args[cfg.arg.belowstyle])
:attr('colspan', getAboveBelowColspan())
:tag('div')
:wikitext(processItem(args[cfg.arg.below], args[cfg.arg.nowrapitems]))
end

local function renderListRow(tbl, index, listnum, listnums_size)
if index > 1 then
-- ARK: spacer
tbl:tag('tr')
:addClass('navbox-spacer')
end

local row = tbl:tag('tr')

if index == 1 and args[cfg.arg.imageleft] then
row
:tag('td')
:addClass(cfg.class.noviewer)
:addClass(cfg.class.navbox_image)
:addClass(args[cfg.arg.imageclass])
:css('width', '1px') -- Minimize width
:css('padding', '0 2px 0 0')
:cssText(args[cfg.arg.imageleftstyle])
:attr('rowspan', listnums_size)
:tag('div')
:wikitext(processItem(args[cfg.arg.imageleft]))
end

local group_and_num = format(cfg.arg.group_and_num, listnum)
local groupstyle_and_num = format(cfg.arg.groupstyle_and_num, 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]))
end

groupCell
:attr('scope', 'row')
:addClass(cfg.class.navbox_group)
:addClass(args[cfg.arg.groupclass])
:cssText(args[cfg.arg.basestyle])

groupCell
:cssText(args[cfg.arg.groupstyle])
:cssText(args[groupstyle_and_num])
:wikitext(args[group_and_num])
end

local listCell = row:tag('td')

if args[group_and_num] then
listCell
:addClass(cfg.class.navbox_list_with_group)
else
listCell:attr('colspan', 2)
end

local rowstyle -- usually nil so cssText(rowstyle) usually adds nothing
if index % 2 == 1 then
rowstyle = args[cfg.arg.oddstyle]
else
rowstyle = args[cfg.arg.evenstyle]
end

local list_and_num = format(cfg.arg.list_and_num, listnum)
local listText = args[list_and_num]
local oddEven = cfg.marker.oddeven
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(cfg.pattern.navbox_title) and cfg.marker.restart or cfg.class.navbox_odd_part
end

local liststyle_and_num = format(cfg.arg.liststyle_and_num, listnum)
local listclass_and_num = format(cfg.arg.listclass_and_num, listnum)
listCell
:css('padding', '0')
:cssText(args[cfg.arg.liststyle])
:cssText(rowstyle)
:cssText(args[liststyle_and_num])
:addClass(cfg.class.navbox_list)
:addClass(cfg.class.navbox_part .. oddEven)
:addClass(args[cfg.arg.listclass])
:addClass(args[listclass_and_num])
:tag('div')
:css('padding',
(index == 1 and args[cfg.arg.list1padding]) or args[cfg.arg.listpadding] or '0 0.25em'
)
:wikitext(processItem(listText, args[cfg.arg.nowrapitems]))

if index == 1 and args[cfg.arg.image] then
row
:tag('td')
:addClass(cfg.class.noviewer)
:addClass(cfg.class.navbox_image)
:addClass(args[cfg.arg.imageclass])
:css('width', '1px') -- Minimize width
:css('padding', '0 0 0 2px')
:cssText(args[cfg.arg.imagestyle])
:attr('rowspan', listnums_size)
:tag('div')
:wikitext(processItem(args[cfg.arg.image]))
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 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 = {
'^' .. htmlclass .. '$',
'%s' .. htmlclass .. '$',
'^' .. htmlclass .. '%s',
'%s' .. htmlclass .. '%s'
}

for _, arg in ipairs(class_args) do
for _, pattern in ipairs(patterns) do
if mw.ustring.find(args[arg] or '', pattern) then
return true
end
end
end
return false
end

local function needsHorizontalLists(border)
if border == cfg.keyword.border_subgroup then
return false
end
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,
cfg.arg.basestyle, cfg.arg.abovestyle, cfg.arg.belowstyle}) do
if tostring(args[key]):find('background', 1, true) then
return true
end
end
return false
end

local function hasBorders()
for _, key in ipairs({cfg.arg.groupstyle, cfg.arg.basestyle,
cfg.arg.abovestyle, cfg.arg.belowstyle}) do
if tostring(args[key]):find('border', 1, true) then
return true
end
end
return false
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
if state == cfg.keyword.state_collapsed then
state = cfg.class.collapsed
end
tbl
:addClass(cfg.class.collapsible)
:addClass(state or cfg.class.autocollapse)
end

if border == cfg.keyword.border_subgroup or border == cfg.keyword.border_none then
tbl
:addClass(cfg.class.navbox_subgroup)
:cssText(args[cfg.arg.bodystyle])
:cssText(args[cfg.arg.style])
else -- regular navbox - bodystyle and style will be applied to the wrapper table
tbl
:addClass(cfg.class.navbox_inner)
end
tbl:cssText(args[cfg.arg.innerstyle])

renderTitleRow(tbl)
renderAboveRow(tbl)
local listnums_size = #listnums
for i, listnum in ipairs(listnums) do
renderListRow(tbl, i, listnum, listnums_size)
end
renderBelowRow(tbl)

return tbl
end

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

for k, _ in pairs(args) do
if type(k) == 'string' then
local listnum = k:match(cfg.pattern.listnum)
if listnum then table.insert(listnums, tonumber(listnum)) end
end
end
table.sort(listnums)

local border = mw.text.trim(args[cfg.arg.border] or args[1] or '')
if border == cfg.keyword.border_child then
border = cfg.keyword.border_subgroup
end

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

local res = mw.html.create()
-- render the appropriate wrapper for the navbox, based on the border param

if border == cfg.keyword.border_none then
local nav = res:tag('div')
:attr('role', 'navigation')
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
if args[cfg.arg.title] or args[cfg.arg.above] or (args[cfg.arg.group1]
and not args[cfg.arg.group2]) then
nav:attr(
'aria-labelledby',
mw.uri.anchorEncode(
args[cfg.arg.title] or args[cfg.arg.above] or args[cfg.arg.group1]
)
)
else
nav:attr('aria-label', cfg.aria_label)
end
elseif border == cfg.keyword.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(cfg.class.navbox)
:addClass(args[cfg.arg.navboxclass])
:cssText(args[cfg.arg.bodystyle])
:cssText(args[cfg.arg.style])
:node(tbl)
-- aria-labelledby title, otherwise above, otherwise lone group
if args[cfg.arg.title] or args[cfg.arg.above]
or (args[cfg.arg.group1] and not args[cfg.arg.group2]) then
nav:attr(
'aria-labelledby',
mw.uri.anchorEncode(args[cfg.arg.title] or args[cfg.arg.above] or args[cfg.arg.group1])
)
else
nav:attr('aria-label', cfg.aria_label)
end
end

return striped(tostring(res), border)
end

function p.navbox(frame)
if not getArgs then
getArgs = require('dev:Arguments').getArgs
end
args = getArgs(frame, {wrappers = {cfg.pattern.navbox}})

-- Read the arguments in the order they'll be output in, to make references
-- number in the right order.
local _
_ = args[cfg.arg.title]
_ = args[cfg.arg.above]
-- 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[format(cfg.arg.group_and_num, i)]
_ = args[format(cfg.arg.list_and_num, i)]
end
_ = args[cfg.arg.below]

return p._navbox(args)
end

return p