Xenharmonic Wiki

Module:Navbox: Difference between revisions

← Older edit
Ganaram inukshuk (talk | contribs)
autopatrolled, emailconfirmed
4,810 edits
m function name correction
ArrowHead294 (talk | contribs)
14,512 edits
mNo edit summary
 
(127 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
-- 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
-- Loosely modelled off of Runescape Wiki's navbox, not Wikipedia's
local p = {}
 
local getArgs = require("Module:Arguments").getArgs
local getArgs = require("Module:Arguments").getArgs
local navbar = require("Module:Navbar")._navbar
local yesno = require("Module:Yesno")
local yesno = require("Module:Yesno")
local p = {}


-- TODO:
-- Header/footer row
-- - Address navbox nesting further by introducing navbox options:
function p.navbox_header_footer(row_content)
-- -- Navbox with outer div --> Root navbox; has collapse options
local row = "|-\n"
-- -- Navbox without outer div --> Nested navbox for headerless row; has collapse options
.. '| colspan="2" style="font-size: 0.8em; text-align: center; background-color: #eaecf0; padding: 0em; border: 1px solid white;" | '
-- -- Navbox without title --> Nested navbox for subcategories; no collapse options
.. row_content .. "\n"
-- - Header and data interactions
 
-- -- Header and normal data --> Normal row
return row
-- -- No header and normal data --> Headerless row (used for a header, footer, or spacer)
end
-- -- Header and nested table --> Category with subcategories (nested table has no title and no collapse options)
-- -- No header and nested table --> Nested navboxes (both navboxes have collapse options)
-- - Add a navbox type option to specify whether a navbox has a title bar (normal or nested navbox) or not (navbox for subcategories)


-- Navbox row
-- Navbox row
function p.navbox_row(row_content)
function p.navbox_row(row_content, is_navbox)
local row_header    = row_content["Header"]
local is_navbox = (is_navbox ~= nil and is_navbox or false)
local row_data      = row_content["Data"]
local is_row_navbox = row_content["Is Navbox"]


local row = '<tr>\n'
local row = "|-\n"
if row_header == nil then
if #row_content == 1 then
-- Headerless row
-- Headerless row; takes up two cells
if is_row_navbox then
if is_navbox then
-- Row data is a child navbox
-- Row data is a child navbox; data cell has no padding
row = row
row = row
.. '<td style="width:5%; text-align:center; background-color:#eaecf0; white-space:nowrap; padding:0em; border:1px solid white" colspan="2">\n'
.. '| style="padding: 0;" colspan="2" | \n'
        .. row_data
.. row_content[1] .. "\n"
    .. '</td>\n'
else
else
-- Row data is normal data
-- Row data is normal data
row = row
row = row .. '| style="font-size: 0.9em; padding: 0.25em 0.5em;" colspan="2" | ' .. row_content[1] .. "\n"
.. '<td style="width:5%; text-align:center; background-color:#eaecf0; white-space:nowrap; padding:0em; border:1px solid white" colspan="2">\n'
        .. '<div style="padding:0.25em 0.5em">' .. row_data .. '</div>\n'
    .. '</td>\n'
     end
     end
else
else
-- Simple row with header and data
-- Row with header and data
if is_row_navbox then
if is_navbox then
-- Row data is a child navbox
-- Row data is a child navbox; data cell has no padding
row = row
row = row
.. '<th style="width:5%; text-align:right; background-color:#eaecf0; white-space:nowrap; padding:0.25em 0.5em; border:1px solid white">' .. row_header .. '</th>\n'
.. '! 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;" |'
.. '<td style="padding:0em">' .. row_data .. '</td>\n'
.. row_content[1] .. "\n"
.. '| style="padding: 0;" |\n'  
.. row_content[2] .. "\n"
else
else
-- Row data is normal data
-- Row data is normal data
row = row
row = row
.. '<th style="width:5%; text-align:right; background-color:#eaecf0; white-space:nowrap; padding:0.25em 0.5em; border:1px solid white">' .. row_header .. '</th>\n'
.. '! 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;" |'
.. '<td style="padding:0em">\n'
.. row_content[1] .. "\n"
.. '<div style="padding:0.25em 0.5em">' .. row_data .. '</div>\n'
.. '| style="font-size: 0.9em; padding: 0.25em 0.5em;" | ' .. row_content[2] .. "\n"
.. '</td>\n'
end
end
end
end
local row = row .. '</tr>\n'
return row
return row
Line 61: Line 54:


-- Navbox title
-- Navbox title
function p.navbox_title(title)
function p.navbox_title(title, is_collapsible, name)
local is_root_navbox = (is_root_navbox == nil and is_root_navbox or true) -- If not specified, default to TRUE
local has_navbar = name ~= nil
local navbox_title = ''
if title ~= nil then
navbox_title = "|-\n"
.. '! style="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" | '
.. '<span style="display: inline-block; float: left; text-align: left; font-weight: normal; font-style: normal; min-width: 4em; padding: 0px; margin: 0px;">'
.. (has_navbar and navbar(name, "mini", "") or "") .. '</span>'
.. '<span style="font-size: 1.05em;">' .. title .. "</span>"
.. (is_collapsible and '' or '<span style="display: inline-block; float: right; font-size: 0.8em; width: 5em;">&nbsp;</span>')
.. '\n'
end
return navbox_title
end
 
-- Navbox title for nested navboxes
function p.nested_navbox_title(title, is_collapsible)
local navbox_title = ''
local navbox_title = ''
if title ~= nil then
if title ~= nil then
navbox_title = '<th style="width:5%; 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'
navbox_title = "|-\n"
.. '! style="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" | '
.. (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
Line 72: Line 88:
function p._navbox(args)
function p._navbox(args)
local title          = args["Title"] or "Navbox Title"
local title          = args["Title"] or "Navbox Title"
local name            = args["name"]
local rows            = args["Rows"]
local rows            = args["Rows"]
local is_data_navbox  = args["Is Data Navbox"]
local is_collapsible  = yesno(args["Is Collapsible"], true )
local is_collapsible  = yesno(args["Is Collapsible"], true )
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 footer_row = args["Footer Row"]
-- Start of table
-- Start of table
local navbox = ""
local navbox = ''
if navbox_type == "Normal" then
if navbox_type == "Nested" then
-- Navbox has a title, wikitable border, and collapse options.
-- Navbox has a title, wikitable border, collapse options, and extra
-- This navbox is a normal navbox or root navbox.
-- margin.
navbox = '<div class="wikitable">\n'
-- This navbox is meant to be a sub-navbox, placed on a headerless row.
.. '<table class="mw-collapsible' .. (is_collapsed and ' mw-collapsed ' or '') .. 'nowraplinks" style="width: 100%; border-spacing:0px">\n'
navbox = '<div class="wikitable" style="overflow-x: auto; padding: 0; margin: 2px;">\n'
.. p.navbox_title(title)
.. '{| style="mw-border-collapse: collapse; border-spacing: 0; margin: 0; width: 100%;"'
.. (is_collapsible and ('class="mw-collapsible' .. (is_collapsed and ' mw-collapsed"' or '"')) or '') .. '\n'
.. p.nested_navbox_title(title, is_collapsible)
-- Add header
if header_row ~= nil then
navbox = navbox .. p.navbox_header_footer(header_row)
end
-- Add rows
for i = 1, #rows do
for i = 1, #rows do
navbox = navbox .. p.navbox_row(rows[i])
navbox = navbox .. p.navbox_row(rows[i], is_data_navbox[i])
end
end
-- Add footer
if footer_row ~= nil then
navbox = navbox .. p.navbox_header_footer(footer_row)
end
-- End of table
navbox = navbox
navbox = navbox
.. '</table>\n'
.. '|}\n'
.. '</div>'
.. '</div>'
elseif navbox_type == "Nested" then
elseif navbox_type == "Subheader" then
-- Navbox has a title and collapse options, and no border.
-- Navbox has no title, border, or collapse options.
-- This navbox is meant to be a sub-navbox, placed on a headerless row.
-- This navbox is meant to display subheaders.
navbox = '<table class="mw-collapsible' .. (is_collapsed and ' mw-collapsed ' or '') .. 'nowraplinks" style="width: 100%; border-spacing:0px">\n'
navbox = '{| style="mw-border-collapse: collapse; border-spacing: 0; margin: 0; width: 100%;\n'
.. p.navbox_title(title)
-- Add rows
for i = 1, #rows do
for i = 1, #rows do
navbox = navbox .. p.navbox_row(rows[i])
navbox = navbox .. p.navbox_row(rows[i], is_data_navbox[i])
end
end
navbox = navbox .. '</table>\n'
-- End of table
navbox = navbox .. '|}\n'
elseif navbox_type == "Subheader" then
else
-- Navbox has no title, border, or collapse options.
-- Navbox has a title, wikitable border, and collapse options.
-- This navbox is meant to display subheaders.
-- This navbox is a normal navbox or a nested navbox.
navbox = '<table style="width:100%; border-spacing:0px">\n'
navbox = '<div class="wikitable" style="overflow-x: auto; padding: 0">\n'
.. '{| style="mw-border-collapse: collapse; border-spacing: 0; margin: 0; width: 100%;"'
.. (is_collapsible and ('class="mw-collapsible' .. (is_collapsed and 'mw-collapsed"' or '"')) or '') .. '\n'
.. p.navbox_title(title, is_collapsible, name)
-- Add header
if header_row ~= nil then
navbox = navbox .. p.navbox_header_footer(header_row)
end
-- Add rows
for i = 1, #rows do
for i = 1, #rows do
navbox = navbox .. p.navbox_row(rows[i])
navbox = navbox .. p.navbox_row(rows[i], is_data_navbox[i])
end
-- Add header
if footer_row ~= nil then
navbox = navbox .. p.navbox_header_footer(footer_row)
end
end
navbox = navbox .. '</table>\n'
-- End of table
end
navbox = navbox
.. '|}\n'
.. '</div>'
end
return navbox
return navbox
end
end


-- Navbox to be #invoke'd
-- Navbox to be invoked
-- Wrapper function for template-based navboxes
-- Wrapper function for template-based navboxes
function p.navbox(frame)
function p.navbox(frame)
Line 130: Line 181:
-- Both the Wikipedia and RsWiki navboxes go up to 20 rows so follow that.
-- Both the Wikipedia and RsWiki navboxes go up to 20 rows so follow that.
local rows = {}
local rows = {}
for i = 1, 20 do
local is_data_navbox = {}
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 = yesno(args["Is Data " .. i .. " Navbox"])
local is_navbox = args["Is Data " .. i .. " Navbox"] ~= nil and args["Is Data " .. i .. " Navbox"] or false
local row = nil
local row = nil
if (header ~= nil or data ~= nil or is_navbox ~= nil) then
if (header == nil and data ~= nil) then
row = {
-- Headerless row
["Header"] = header,
row = {}
["Data"] = ((header ~= nil and data == nil) and "" or data),
table.insert(row, data)
["Is Navbox"] = is_navbox
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
if row ~= nil then
table.insert(rows, row)
table.insert(rows, row)
table.insert(is_data_navbox, is_navbox)
end
end
Line 153: Line 214:
end
end
args["Rows"] = rows
args["Rows"] = rows
args["Is Data Navbox"] = is_data_navbox
return p._navbox(args)
local result = p._navbox(args)
-- Debugger option
local debugg = yesno(args["debug"])
if debugg == true then
result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
end
return result
end
end


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