Module:Infobox
.svg){kind=icon}
- This module implements a metatemplate, and may be invoked by templates using its corresponding template Template:Infobox, or used directly from other modules.
Module:Infobox is a module that implements the {{Infobox}} template. Infobox templates can be made by using the template or by calling the _sidebar function from another module.
On templates, you can create an infobox by using {{Infobox}}, which calls this module's wrapper function.
local infobox= require("Module:Infobox")._infobox to create an infobox.
| Introspection summary for Module:Infobox | ||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
| |||||||||||||||||||||||||||||||||
No function descriptions were provided. The Lua code may have further information.
-- This module follows [[User:Ganaram inukshuk/Provisional style guide for Lua]]
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 p = {}
-- TODO (medium priority):
-- - Add the following backwards-compatibility feature: if rows are entered as
-- a jagged array instead of the expected format of header-data pairs, convert
-- it from a jagged array to a table of header-data pairs.
--------------------------------------------------------------------------------
-------------------------------- MAIN FUNCTIONS --------------------------------
--------------------------------------------------------------------------------
-- Function to be called by other modules; also called by wrapper function
function p._infobox(args)
local title = args["Title"] or "Infobox Title"
local adjacent_links = args["Adjacent Links"]
local header_row = args["Header Row"]
local rows = args["Rows" ]
local footer_row = args["Footer Row"]
local name = args["name"]
-- Nested helper function
-- Produces the title and, if present, prev/next links
function infobox_title()
if adjacent_links == nil then
return title
elseif #adjacent_links == 2 then
lines = {}
--table.insert(lines, "\n")
table.insert(lines, '{| style="width: 100%;"')
table.insert(lines, '|-')
table.insert(lines, '| style="font-size: 0.75em;" | ' .. adjacent_links[1])
table.insert(lines, '| style="width: 50%;" | ' .. title)
table.insert(lines, '| style="font-size: 0.75em;" | ' .. adjacent_links[2])
table.insert(lines, '|}')
return table.concat(lines, "\n")
elseif #adjacent_links == 8 then
lines = {}
--table.insert(lines, "\n")
table.insert(lines, '{| style="width: 100%;"')
table.insert(lines, '|-')
table.insert(lines, '| style="font-size: 0.75em;" | ' .. adjacent_links[1])
table.insert(lines, '| style="font-size: 0.75em; width: 50%;" | ' .. adjacent_links[2])
table.insert(lines, '| style="font-size: 0.75em;" | ' .. adjacent_links[3])
table.insert(lines, '|-')
table.insert(lines, '| style="font-size: 0.75em;" | ' .. adjacent_links[4])
table.insert(lines, '| style="width: 50%;" | ' .. title)
table.insert(lines, '| style="font-size: 0.75em;" | ' .. adjacent_links[5])
table.insert(lines, '|-')
table.insert(lines, '| style="font-size: 0.75em;" | ' .. adjacent_links[6])
table.insert(lines, '| style="font-size: 0.75em; width: 50%;" | ' .. adjacent_links[7])
table.insert(lines, '| style="font-size: 0.75em;" | ' .. adjacent_links[8])
table.insert(lines, '|}')
return table.concat(lines, "\n")
else
return title
end
end
-- Nested helper function
-- Produces a row in the infobox
function infobox_row(row_content)
local header = row_content["Header"]
local data = row_content["Data" ]
if header and data then
local lines = {}
table.insert(lines, '|-')
table.insert(lines, '| style="text-align: right; padding-right: 0.25em;" | ' .. header)
table.insert(lines, '| style="background-color: white; padding-left: 0.25em; font-weight: bold;" | ' .. data)
return table.concat(lines, "\n")
elseif header and not data then
local lines = {}
table.insert(lines, '|-')
table.insert(lines, '| colspan="2" style="text-align: center;" | ' .. header)
return table.concat(lines, "\n")
elseif data and not header then
local lines = {}
table.insert(lines, '|-')
table.insert(lines, '| colspan="2" style="text-align: center;" | ' .. data)
return table.concat(lines, "\n")
end
end
-- Nested helper function
-- Produces a header or footer row
function header_footer_row(row_content)
local lines = {}
table.insert(lines, '|-')
table.insert(lines, '| colspan="2" style="text-align: center; font-size: 0.8em;" | ' .. row_content)
return table.concat(lines, "\n")
end
-- Nested helper function
-- Produces the navbar, if specified
function navbar_row()
local lines = {}
table.insert(lines, '|-')
table.insert(lines, '| colspan="2" style="text-align: center;" | ' .. navbar(name, "mini", ""))
return table.concat(lines, "\n")
end
-- Start of infobox; outer div and start of table
local lines = {}
-- Infobox boilerplate
table.insert(lines,
[[<div style="
border: 1px solid #999;
margin: 0;
margin-left: 1em;
margin-bottom: 0.5em;
padding: 0.5em;
background-color: #f0f0f0;
min-width: 15em;
float: right;
max-width: 100%;
overflow: auto;">]]
)
table.insert(lines, '{| style="border-collapse: collapse; width: 100%;"')
table.insert(lines, '|+ style="font-size: 105%; font-weight: bold; text-align: center;" | ')
-- Title
table.insert(lines, infobox_title())
-- Header
if header_row then
table.insert(lines, header_footer_row(header_row))
end
-- Rows
for i = 1, #rows do
table.insert(lines, infobox_row(rows[i]))
end
-- Footer
if footer_row then
table.insert(lines, header_footer_row(footer_row))
end
-- Template navbar
if name then
table.insert(lines, navbar_row())
end
-- End of infobox
table.insert(lines, "|}")
table.insert(lines, "</div>")
return table.concat(lines, "\n")
end
-- Function to be #invoke'd
-- Wrapper function for template-based infoboxes
-- Modeled off of navbox
function p.infobox(frame)
local args = getArgs(frame)
-- Preprocess adjacent links
-- If there are two adjacent links (such as with edos), then links will be
-- placed on the left and right of the title:
-- [Link 1] Title [Link 2]
-- - Link 1 is previous, link 2 is next
-- If there are eight adjacent links (such as with mosses), then links
-- surround the title in a 3x3 grid:
-- [Link 1] [Link 2] [Link 3]
-- [Link 4] Title [Link 5]
-- [Link 6] [Link 7] [Link 8]
-- Individual links can be omitted. If at least one upper or lower link is
-- present, then rows for those two sets of links are added. Having no links
-- defaults to having only the title.
local is_upper_lower_links_present = args["Upper Left Link"] ~= nil or args["Upper Link"] ~= nil or args["Upper Right Link"] ~= nil
or args["Lower Left Link"] ~= nil or args["Lower Link"] ~= nil or args["Lower Right Link"] ~= nil
local is_side_links_present = args["Left Link"] ~= nil or args["Right Link"] ~= nil
local adjacent_links = {}
if is_upper_lower_links_present then
table.insert(adjacent_links, args["Upper Left Link" ] or "")
table.insert(adjacent_links, args["Upper Link" ] or "")
table.insert(adjacent_links, args["Upper Right Link"] or "")
end
if is_side_links_present then
table.insert(adjacent_links, args["Left Link" ] or "")
table.insert(adjacent_links, args["Right Link"] or "")
end
if is_upper_lower_links_present then
table.insert(adjacent_links, args["Lower Left Link" ] or "")
table.insert(adjacent_links, args["Lower Link" ] or "")
table.insert(adjacent_links, args["Lower Right Link"] or "")
end
args["Adjacent Links"] = adjacent_links
-- Cleanup individual links, as they've been combined into one table
args["Upper Left Link" ] = nil
args["Upper Link" ] = nil
args["Upper Right Link"] = nil
args["Left Link" ] = nil
args["Right Link" ] = nil
args["Lower Left Link" ] = nil
args["Lower Link" ] = nil
args["Lower Right Link"] = nil
-- Preprocess rows
-- Set row count to 30, under the reasoning that an infobox may need more
-- rows and/or headers. This may be increased to 40 if needed.
args["Rows"] = tiu.header_data_pairs_to_table(args, 30)
local result = p._infobox(args)
local debugg = yesno(args["debug"])
if debugg == true then
result = "<syntaxhighlight lang=\"wikitext\">" .. result .. "</syntaxhighlight>"
end
return result
end
--------------------------------------------------------------------------------
------------------------------- LEGACY FUNCTIONS -------------------------------
--------------------------------------------------------------------------------
-- These functions are kept in the meantime to support older infoboxes and WILL
-- be entirely deleted later! Please switch to the new functions!
-- Helper function; preprocess infobox rows from old format to new format
-- One-element entries are interpreted as dataless headers, as it already is.
function p.preprocess_entries(entries)
local processed = {}
for i = 1, #entries do
local entry = entries[i]
if #entry == 1 then
table.insert(processed, { ["Header"] = entry[1] })
elseif #entry == 2 then
table.insert(processed, { ["Header"] = entry[1], ["Data"] = entry[2] })
end
end
return processed
end
-- Original function signature, kept for legacy support (for now).
function p.build(title, entries, prev_link, next_link)
local args = {
["Adjacent Links"] = { (prev_link or ""), (next_link or "") },
["Title"] = title,
["Rows"] = p.preprocess_entries(entries),
}
return p._infobox(args)
end
-- Original 8-link function signature, pulled from infobox mos.
function p.build_multilink(title, entries, adjacent_links)
local args = {
["Adjacent Links"] = adjacent_links,
["Title"] = title,
["Rows"] = p.preprocess_entries(entries),
}
return p._infobox(args)
end
return p