Xenharmonic Wiki

Module:Navbox: Difference between revisions

← Older edit
ArrowHead294 (talk | contribs)
15,213 edits
mNo edit summary
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
6,211 edits
m minor renaming
 
(82 intermediate revisions by 2 users not shown)
Line 1: Line 1:
-- Page is following provisonal style guide: User:Ganaram_inukshuk/Provisional_style_guide_for_Lua
-- This module follows [[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 getArgs = require("Module:Arguments").getArgs
local navbar = require("Module:Navbar")._navbar
local tiu = require("Module:Template input utils")
local yesno = require("Module:Yesno")
local yesno = require("Module:Yesno")
local p = {}
local p = {}


-- TODO:
-- TODO (medium priority): add/use navbox/styles.css
-- - Add VTE (view/talk/edit) links
 
-- TODO (medium priority): nest and refactor helper functions
 
-- Navbox row helper function
-- Function was refactored to use table.concat(), like with the "main" function,
-- since it's being called multiple times. The other helper functions don't need
-- to be refactored (currently) because they only need to be called a fixed
-- number of times.
function p.navbox_row(row_content, is_content_navbox)
local is_navbox = is_navbox or false
local header = row_content["Header"]
local data = row_content["Data"]
local row = {}
if header and data then
-- Row is a header+data row
local header_style = '! 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;" |'
local data_style = is_content_navbox
and '| style="padding: 0;" |\n' -- For nested navboxes; endline required for nested navboxes to work properly
or  '| style="font-size: 0.9em; padding: 0.25em 0.5em;" |' -- For normal content; endline not needed as adding it makes rows too thick
 
table.insert(row, "|-")
table.insert(row, header_style .. header)
table.insert(row, data_style .. data)
elseif data and not header then
-- Row is a headerless data row
local data_style = is_content_navbox
and '| style="padding: 0; colspan="2" |\n' -- For nested navboxes
or  '| style="font-size: 0.9em; padding: 0.25em 0.5em;" colspan="2" |' -- For normal content
table.insert(row, "|-")
table.insert(row, data_style .. data)
elseif header and not data then
-- Row is a dataless header row
local data_style = is_content_navbox
and '! style="padding: 0;" colspan="2" |\n' -- For nested navboxes; in case nav elements are ever added here, such as numlinks
or  '! style="white-space: nowrap; font-size: 0.9em; width: 5%; background-color: #eaecf0; padding: 0.25em 0.5em; border: 1px solid white;" colspan="2" |'
table.insert(row, "|-")
table.insert(row, data_style .. header)
end


-- Header/footer row
return table.concat(row, "\n")
end
 
-- Header/footer row helper function
-- Called up to twice on a table.
function p.navbox_header_footer(row_content)
function p.navbox_header_footer(row_content)
local row = "|-\n"
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"
.. '| colspan="2" style="font-size: 0.8em; text-align: center; background-color: #eaecf0; padding: 0em; border: 1px solid white;" | '
.. row_content --.. "\n"


return row
return row
end
end


-- Navbox row
-- Navbox title helper function
function p.navbox_row(row_content, is_navbox)
-- Up to one title helper is called per table; this is expected to be called in
local is_navbox = (is_navbox ~= nil and is_navbox or false)
-- most cases, however.
 
function p.navbox_title(title, is_collapsible, name)
local row = "|-\n"
local is_root_navbox = (is_root_navbox == nil and is_root_navbox or true) -- If not specified, default to TRUE
if #row_content == 1 then
local has_navbar = name ~= nil
-- Headerless row; takes up two cells
local navbox_title = ''
if is_navbox then
if title ~= nil then
-- Row data is a child navbox; data cell has no padding
navbox_title = "|-\n"
row = row
.. '! style="text-align: center; background-color: #eaecf0; white-space: nowrap; margin: 0em 4em 0em 4em;'
.. '| style="padding: 0;" colspan="2" | \n'
.. 'padding: 0.25em 0.5em; border: 1px solid white;" colspan="2" | '  
.. row_content[1] .. "\n"
.. '<span style="display: inline-block; float: left; text-align: left; font-weight: normal; font-style: normal; min-width: 4em; padding: 0px; margin: 0px;">'
else
.. (has_navbar and navbar(name, "mini", "") or "") .. '</span>'
-- Row data is normal data
.. '<span style="font-size: 1.05em;">' .. title .. "</span>"
row = row .. '| style="font-size: 0.9em; padding: 0.25em 0.5em;" colspan="2" | ' .. row_content[1] .. "\n"
.. (is_collapsible and '' or '<span style="display: inline-block; float: right; font-size: 0.8em; width: 5em;">&nbsp;</span>')
    end
--.. '\n'
else
-- Row with header and data
if is_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
end
return navbox_title
return row
end
end


-- Navbox title
-- Navbox title for nested navboxes or subheader (subcategory) navboxes
-- Nested navboxes have slightly smaller title text
-- Up to one title helper is called per table; not always necessray if the table
function p.navbox_title(title, navbar, is_root_navbox)
-- is used for subcategories.
local is_root_navbox = (is_root_navbox == nil and is_root_navbox or true) -- If not specified, default to TRUE
function p.nested_navbox_title(title, is_collapsible)
local navbox_title = ''
local navbox_title = ''
if title ~= nil then
if title ~= nil then
navbox_title = "|-\n"
navbox_title = "|-\n"
.. '! style="' .. (is_root_navbox and '' or 'font-size: 0.9em; ')
.. '! style="text-align: center; background-color: #eaecf0; white-space: nowrap; margin: 0em 4em 0em 4em;'
.. 'text-align: center; background-color: #eaecf0; white-space: nowrap; margin: 0em 4em 0em 4em;'
.. 'padding: 0.25em 0.5em; border: 1px solid white;" colspan="2" | '  
.. 'padding: 0.25em 0.5em; border: 1px solid white;" colspan="2" | '  
.. navbar .. title .. "\n"
.. (is_collapsible and '<span style="display: inline-block; float: left; min-width: 4em; padding: 0px; margin: 0px;">&nbsp;</span>' or '')
.. '<span style="font-size: 0.9em;">' .. title .. "</span>"
--.. '\n'
end
end
return navbox_title
return navbox_title
end
end


-- "Main" function
-- Navbox to be called by other modules; also called by wrapper function
-- Navbox to be called by other modules; also called by wrapper function
function p._navbox(args, nb)
function p._navbox(args)
local title          = args["Title"] or "Navbox Title"
local title          = args["Title"] or "Navbox Title"
local name            = args["name"]
local name            = args["name"]
Line 75: Line 109:
local is_collapsed    = yesno(args["Is Collapsed"  ], false)
local is_collapsed    = yesno(args["Is Collapsed"  ], false)
local navbox_type    = ((args["Navbox Type"] == nil) and "Normal" or args["Navbox Type"])
local navbox_type    = ((args["Navbox Type"] == nil) and "Normal" or args["Navbox Type"])
local header_row = args["Header Row"]
local header_row     = args["Header Row"]
local footer_row = args["Footer Row"]
local footer_row     = args["Footer Row"]
 
-- Start of table
-- Table that holds individual lines
local navbox = ''
local navbox = {}
 
if navbox_type == "Nested" then
if navbox_type == "Nested" then
-- Navbox has a title, wikitable border, collapse options, and extra
-- Build a navbox that lies within another navbox
-- margin.
table.insert(navbox, '<div class="wikitable" style="overflow-x: auto; padding: 0; margin: 2px;">')
-- This navbox is meant to be a sub-navbox, placed on a headerless row.
table.insert(navbox,
navbox = '<div class="wikitable" style="overflow-x: auto; padding: 0; margin: 2px;">\n'
'{| style="mw-border-collapse: collapse; border-spacing: 0; margin: 0; width: 100%;"'
.. '{| 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 '')
.. (is_collapsible and ('class="mw-collapsible' .. (is_collapsed and ' mw-collapsed"' or '"')) or '') .. '\n'
)
.. p.navbox_title(title, nb, false)
 
-- Title row
-- Add header
table.insert(navbox, p.nested_navbox_title(title, is_collapsible))
if header_row ~= nil then
navbox = navbox .. p.navbox_header_footer(header_row)
-- Header row
if header_row then
table.insert(navbox, p.navbox_header_footer(header_row))
end
end
 
-- Add rows
-- Data rows
for i = 1, #rows do
for i = 1, #rows do
navbox = navbox .. p.navbox_row(rows[i], is_data_navbox[i])
table.insert(navbox, p.navbox_row(rows[i], is_data_navbox[i]))
end
end
 
-- Add footer
-- Footer rows
if footer_row ~= nil then
if footer_row then
navbox = navbox .. p.navbox_header_footer(footer_row)
table.insert(navbox, p.navbox_header_footer(footer_row))
end
end
 
-- End of table
-- End of table
navbox = navbox
table.insert(navbox, '|}')
.. '|}\n'
table.insert(navbox, '</div>')
.. '</div>'
 
elseif navbox_type == "Subheader" then
elseif navbox_type == "Subheader" then
-- Navbox has no title, border, or collapse options.
-- Build a navbox that lies within another navbox
-- This navbox is meant to display subheaders.
-- This one serves as subcategories for one row
navbox = '{| width="100%" style="mw-border-collapse: collapse; border-spacing: 0; margin: 0;"\n'
table.insert(navbox, '{| style="mw-border-collapse: collapse; border-spacing: 0; margin: 0; width: 100%;"')
-- Add rows
-- Title (optional)
table.insert(navbox, p.nested_navbox_title(title, false))
 
-- Rows
for i = 1, #rows do
for i = 1, #rows do
navbox = navbox .. p.navbox_row(rows[i], is_data_navbox[i])
table.insert(navbox, p.navbox_row(rows[i], is_data_navbox[i]))
end
end
 
-- End of table
-- End of table
navbox = navbox .. '|}\n'
table.insert(navbox, '|}')
else
 
-- Navbox has a title, wikitable border, and collapse options.
else -- Normal
-- This navbox is a normal navbox or a nested navbox.
table.insert(navbox, '<div class="wikitable" style="overflow-x: auto; padding: 0">')
navbox = '<div class="wikitable" style="overflow-x: auto; padding: 0">\n'
table.insert(navbox,
.. '{| 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'
'{| style="mw-border-collapse: collapse; border-spacing: 0; margin: 0; width: 100%;"'
.. p.navbox_title(title, name, false)
.. (is_collapsible and (' class="mw-collapsible' .. (is_collapsed and ' mw-collapsed"' or '"')) or '')
)
-- Add header
 
if header_row ~= nil then
-- Title
navbox = navbox .. p.navbox_header_footer(header_row)
table.insert(navbox, p.navbox_title(title, is_collapsible, name))
 
-- Header
if header_row then
table.insert(navbox, p.navbox_header_footer(header_row))
end
end
 
-- Add rows
-- Rows
for i = 1, #rows do
for i = 1, #rows do
navbox = navbox .. p.navbox_row(rows[i], is_data_navbox[i])
table.insert(navbox, p.navbox_row(rows[i], is_data_navbox[i]))
end
end
-- Add header
-- Footer
if footer_row ~= nil then
if footer_row then
navbox = navbox .. p.navbox_header_footer(footer_row)
table.insert(navbox, p.navbox_header_footer(footer_row))
end
end
 
-- End of table
-- End of table
navbox = navbox
table.insert(navbox, '|}')
.. '|}\n'
table.insert(navbox, '</div>')
.. '</div>'
end
end
 
return table.concat(navbox, '\n')
return navbox
end
end


-- Navbox to be #invoke'd
-- Wrapper function for template-based navboxes
-- Wrapper function for template-based navboxes
function p.navbox(frame)
function p.navbox(frame)
local args = getArgs(frame)
local args = getArgs(frame)
-- Preprocess individual entries for, headers, data, and is-row-child into
-- Preprocess bools for rows that indicate whether that row is a nested
-- one single table.
-- navbox. A row is considered valid if it has either a header or data. If
-- Both the Wikipedia and RsWiki navboxes go up to 20 rows so follow that.
-- a bool exists but not its header or data, it's skipped. If a valid row
local rows = {}
-- exists but not its bool, it defaults to false.
local is_data_navbox = {}
local is_data_navbox = {}
for i = 1, 30 do
for i = 1, 30 do
local header = args["Header " .. i]
local header = args["Header " .. i]
local data  = args["Data "  .. i]
local data  = args["Data "  .. i]
local is_navbox = args["Is Data " .. i .. " Navbox"] ~= nil and args["Is Data " .. i .. " Navbox"] or false
local key = string.format("Is Data %d Navbox", i)
local row = nil
if header or data then
if (header == nil and data ~= nil) then
table.insert(is_data_navbox, args[key] or false)
-- Headerless row
row = {}
table.insert(row, data)
elseif (header ~= nil and data == nil) then
-- Dataless row; permitted for placeholder purposes
row = {}
table.insert(row, header)
table.insert(row, "")
elseif (header ~= nil and data ~= nil) then
-- Row with header and data
row = {}
table.insert(row, header)
table.insert(row, data)
end
end
if row ~= nil then
 
table.insert(rows, row)
args[key] = nil
table.insert(is_data_navbox, is_navbox)
end
-- Remove original entries as cleanup
args["Header " .. i] = nil
args["Data "  .. i] = nil
args["Is Data " .. i .. " Navbox"] = nil
end
end
args["Is Data Navbox"] = is_data_navbox
-- Preprocess individual entries for headers and data
local rows = tiu.numbered_header_data_args_to_table(args, 30)
args["Rows"] = rows
args["Rows"] = rows
args["Is Data Navbox"] = is_data_navbox
local nb = frame:preprocess("{{navbar|" .. title .. "|mini}}")
local result = p._navbox(args)
return p._navbox(args, nb)
-- Debugger option
local debugg = yesno(args["debug"])
if debugg == true then
result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
end
return frame:preprocess(result)
end
function p.tester()
local row_content = {  ["Header"] = "AAA" }
return p.navbox_row(row_content, false)
end
end


return p
return p
Retrieved from "https://en.xen.wiki/w/Module:Navbox"