Module:Navbox

Module documentation[view] [edit] [history] [purge]

This module implements a metatemplate, and may be invoked by templates using its corresponding template Template:Navbox, or used directly from other modules.

Module:Navbox is a module that implements the {{Navbox}} template. Navbox templates can be made by using the template or by calling the _navbox function from another module.

On templates, you can create a navbox by using {{Navbox}}, which calls this module's wrapper function.

On modules, you can include local navbox = require("Module:Navbox")._navbox to create a navbox.

Introspection summary for Module:Navbox
Functions provided (5) Line Function Params 12 navbox_header_footer (row_content) 20 navbox_row (row_content, is_row_navbox) 56 navbox_title (title, is_root_navbox) 67 _navbox (main) (args) 152 navbox (invokable) (frame)	Lua modules required (2) Variable Module Functions used getArgs Module:Arguments getArgs yesno Module:Yesno yesno

No function descriptions were provided. The Lua code may have further information.

---

-- Page is following provisonal style guide: User:Ganaram_inukshuk/Provisional_style_guide_for_Lua
-- Loosely modeled off of Runescape Wiki's navbox, not Wikipedia's
local getArgs = require("Module:Arguments").getArgs
local yesno = require("Module:Yesno")
local p = {}

-- TODO:
-- Have row entries based on that of the infobox, where one row is a 1-entry or
-- 2-entry table (1 entry for headerless row, 2 for header-data pair).

-- Header/footer row
function p.navbox_header_footer(row_content)
	local row = "|-\n"
		.. '| colspan="2" style="font-size: 0.8em; text-align: center; background-color: #eaecf0; padding: 0em; border: 1px solid white;" | ' .. row_content .. "\n"

	return row
end

-- Navbox row
function p.navbox_row(row_content, is_row_navbox)
	local is_row_navbox = yesno(is_row_navobx, false)

	local row = "|-\n"
	if #row_content == 1 then
		-- Headerless row; takes up two cells
		if is_row_navbox then
			-- Row data is a child navbox; data cell has no padding
			row = row
				.. '| style="padding: 0;" colspan="2" | \n'
				.. row_content[1] .. "\n"
		else
			-- Row data is normal data
			row = row .. '| style="font-size: 0.9em; padding: 0.25em 0.5em;" colspan="2" | ' .. row_content[1] .. "\n"
    	end
	else
		-- Row with header and data
		if is_row_navbox then
			-- Row data is a child navbox; data cell has no padding
			row = row
				.. '! style="white-space: nowrap; font-size: 0.9em; width: 5%; text-align: right; background-color: #eaecf0; padding: 0.25em 0.5em; border: 1px solid white;" |' ..  row_content[1] .. "\n"
				.. '| style="padding: 0;" |\n' 
				.. row_content[2] .. "\n"
		else
			-- Row data is normal data
			row = row
				.. '! style="white-space: nowrap; font-size: 0.9em; width: 5%; text-align: right; background-color: #eaecf0; padding: 0.25em 0.5em; border: 1px solid white;" |' ..  row_content[1] .. "\n"
				.. '| style="font-size: 0.9em; padding: 0.25em 0.5em;" | ' .. row_content[2] .. "\n"
		end
	end
	
	return row
end

-- Navbox title
-- Nested navboxes have slightly smaller title text
function p.navbox_title(title, is_root_navbox)
	local is_root_navbox = (is_root_navbox == nil and is_root_navbox or true)		-- If not specified, default to TRUE
	local navbox_title = ''
	if title ~= nil then
		navbox_title = "|-\n"
			.. '! style="' .. (is_root_navbox and '' or 'font-size: 0.9em; ') .. 'text-align: center; background-color: #eaecf0; white-space: nowrap; padding: 0.25em 0.5em; border: 1px solid white;" colspan="2" | ' .. title .. "\n"
	end
	return navbox_title
end

-- Navbox to be called by other modules; also called by wrapper function
function p._navbox(args)
	local title           = args["Title"] or "Navbox Title"
	local rows            = args["Rows"]
	local is_row_navbox   = args["Is Row Navbox"]
	local is_collapsible  = yesno(args["Is Collapsible"], true )
	local is_collapsed    = yesno(args["Is Collapsed"  ], false)
	local navbox_type     = ((args["Navbox Type"] == nil) and "Normal" or args["Navbox Type"])
	local header_row = args["Header Row"]
	local footer_row = args["Footer Row"]
	
	-- Start of table
	local navbox = ''
	if navbox_type == "Nested" then
		-- Navbox has a title, wikitable border, collapse options, and extra
		-- margin.
		-- This navbox is meant to be a sub-navbox, placed on a headerless row.
		navbox = '<div class="wikitable" style="overflow-x: auto; padding: 0; margin: 2px;">\n'
			.. '{| width="100%" style="mw-border-collapse: collapse; border-spacing: 0; margin: 0"' .. (is_collapsible and ('class="mw-collapsible' .. (is_collapsed and ' mw-collapsed"' or '"')) or '') .. '\n'
			.. p.navbox_title(title, false)
			
		-- Add header
		if header_row ~= nil then
			navbox = navbox .. p.navbox_header_footer(header_row)
		end
		
		-- Add rows
		for i = 1, #rows do
			navbox = navbox .. p.navbox_row(rows[i])
		end
		
		-- Add footer
		if footer_row ~= nil then
			navbox = navbox .. p.navbox_header_footer(footer_row)
		end
		
		-- End of table
		navbox = navbox
			.. '|}\n'
			.. '</div>'
			
	elseif navbox_type == "Subheader" then
		-- Navbox has no title, border, or collapse options.
		-- This navbox is meant to display subheaders.
		navbox = '{| width="100%" style="mw-border-collapse: collapse; border-spacing: 0; margin: 0;"\n'
		
		-- Add rows
		for i = 1, #rows do
			navbox = navbox .. p.navbox_row(rows[i], is_row_navbox[i])
		end
		
		-- End of table
		navbox = navbox .. '|}\n'
	else
		-- Navbox has a title, wikitable border, and collapse options.
		-- This navbox is a normal navbox or a nested navbox.
		navbox = '<div class="wikitable" style="overflow-x: auto; padding: 0">\n'
			.. '{| width="100%" style="mw-border-collapse: collapse; border-spacing: 0; margin: 0"' .. (is_collapsible and ('class="mw-collapsible' .. (is_collapsed and 'mw-collapsed"' or '"')) or '') .. '\n'
			.. p.navbox_title(title, false)
			
		-- Add header
		if header_row ~= nil then
			navbox = navbox .. p.navbox_header_footer(header_row)
		end
		
		-- Add rows
		for i = 1, #rows do
			navbox = navbox .. p.navbox_row(rows[i], is_row_navbox[i])
		end
		
		-- Add header
		if footer_row ~= nil then
			navbox = navbox .. p.navbox_header_footer(footer_row)
		end
		
		-- End of table
		navbox = navbox
			.. '|}\n'
			.. '</div>'
	end	
	
	return navbox
end

-- Navbox to be #invoke'd
-- Wrapper function for template-based navboxes
function p.navbox(frame)
	local args = getArgs(frame)
	
	-- Preprocess individual entries for, headers, data, and is-row-child into
	-- one single table.
	-- Both the Wikipedia and RsWiki navboxes go up to 20 rows so follow that.
	local rows = {}
	local is_row_navbox = {}
	for i = 1, 30 do
		local header = args["Header " .. i]
		local data   = args["Data "   .. i]
		local is_row_i_navbox = yesno(args["Is Row " .. i .. " Navbox"], false)
		
		local row = nil
		if (header == nil and data ~= nil) then
			row = {}
			table.insert(row, data)
		elseif (header ~= nil and data ~= nil) then
			row = {}
			table.insert(row, header)
			table.insert(row, data)
		end
		if row ~= nil then
			table.insert(rows, row)
			table.insert(is_row_i_navbox, is_row_navbox)
		end
		
		-- Remove original entries as cleanup
		args["Header " .. i] = nil
		args["Data "   .. i] = nil
		args["Is Row " .. i .. " Navbox"] = nil
	end
	args["Rows"] = rows
	args["Is Row Navbox"] = is_row_navbox
	
	return p._navbox(args)
	
end

return p