Module:Navbox
.svg){kind=icon}
- 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.
local navbox = require("Module:Navbox")._navbox to create a navbox.
| Introspection summary for Module:Navbox | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| |||||||||||||||||||||||||||
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:
-- Add option for header cell width? (low priority)
-- Fix collapse options (high priority)
-- Header/footer row
function p.navbox_header_footer(row_content)
local row = '<tr>\n'
.. '<td style="font-size: 0.8em; text-align: center; background-color: #eaecf0; padding: 0em; border: 1px solid white;" colspan="2">\n'
.. row_content
.. '</td>\n'
.. '</tr>\n'
return row
end
-- Navbox row
function p.navbox_row(row_content)
local row_header = row_content["Header"]
local row_data = row_content["Data"]
local is_row_navbox = row_content["Is Navbox"]
local row = '<tr>\n'
if row_header == nil then
-- Headerless row
if is_row_navbox then
-- Row data is a child navbox
row = row .. '<td style="padding: 0em;" colspan="2">\n' .. row_data .. '</td>\n'
else
-- Row data is normal data
row = row .. '<td style="font-size: 0.9em; padding: 0.25em 0.5em;" colspan="2">\n' .. row_data .. '</td>\n'
end
else
-- Simple row with header and data
if is_row_navbox then
-- Row data is a child navbox
row = row
--.. '<th style="width: 10em; min-width: 8em; max-width: 10%; text-align: right; background-color: #eaecf0; padding: 0.25em 0.5em; border: 1px solid white;">' .. row_header .. '</th>\n'
.. '<th 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_header .. '</th>\n'
.. '<td style="padding: 0em;">' .. row_data .. '</td>\n'
else
-- Row data is normal data
row = row
.. '<th 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_header .. '</th>\n'
.. '<td style="font-size: 0.9em; text-alight: right; padding: 0.25em 0.5em;">\n' .. row_data .. '</td>\n'
end
end
local row = row .. '</tr>\n'
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 = '<tr>\n'
.. '<th 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"><b>' .. title .. '</b></th>\n'
.. '</tr>\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_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 and collapse options, and a white border. The
-- white border matches with that of the header cells.
-- This navbox is meant to be a sub-navbox, placed on a headerless row.
navbox = '<div class="wikitable" style="margin: 2px;">\n'
.. '<table class="' .. (is_collapsible and ('mw-collapsible ' .. (is_collapsed and 'mw-collapsed ')) or '') .. 'nowraplinks" style="width: 100%; border-spacing: 0px;">\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
.. '</table>\n'
.. '</div>'
elseif navbox_type == "Subheader" then
-- Navbox has no title, border, or collapse options.
-- This navbox is meant to display subheaders.
navbox = '<table style="width: 100%; border-spacing: 0px;">\n'
-- Add rows
for i = 1, #rows do
navbox = navbox .. p.navbox_row(rows[i])
end
-- End of table
navbox = navbox .. '</table>'
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;">\n'
.. '<table class="' .. (is_collapsible and ('mw-collapsible ' .. (is_collapsed and 'mw-collapsed ')) or '') .. 'nowraplinks" style="width: 100%; border-spacing: 0px;">\n'
.. p.navbox_title(title, true)
-- 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 header
if footer_row ~= nil then
navbox = navbox .. p.navbox_header_footer(footer_row)
end
-- End of table
navbox = navbox
.. '</table>\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 = {}
for i = 1, 20 do
local header = args["Header " .. i]
local data = args["Data " .. i]
local is_navbox = yesno(args["Is Data " .. i .. " Navbox"])
local row = nil
if (header ~= nil or data ~= nil or is_navbox ~= nil) then
row = {
["Header"] = header,
["Data"] = ((header ~= nil and data == nil) and "" or data),
["Is Navbox"] = is_navbox
}
end
if row ~= nil then
table.insert(rows, row)
end
-- Remove original entries as cleanup
args["Header " .. i] = nil
args["Data " .. i] = nil
args["Is Data " .. i .. " Navbox"] = nil
end
args["Rows"] = rows
return p._navbox(args)
end
return p