Module:Infobox
Revision as of 13:12, 4 June 2013 by en>WOSlinker (move the \n to different spot in code)
| 50x40px | This {{#switch:Module|Module=module|#default=template}}'s documentation is missing, inadequate, or does not accurately describe its functionality and/or the parameters in its code. Please help [{{fullurl:Module:Infobox{{#ifexist:Module:Infobox/doc|/doc}}|action=edit}} to expand and improve it]. {{#if: |See talk page for details.|}} {{#if:October 2018 |{{#if:(October 2018)
|(October 2018) |90% }}}} |
| {{ safesubst:#titleparts:{{ safesubst:#if:|{{{1}}}|Module:Infobox}}|1}}
| {{ safesubst:#if:|{{{1}}}|Module:Infobox}}
}}|Wikipedia:Template messages||{{#ifexpr:{{#if:Module|0|1}}+{{#ifeq:no|yes|0|1}}
|{{#if:Templates with missing or incorrect documentation
|{{#ifexist:Category: Templates with missing or incorrect documentation
||}}
|[[Category:{{#if:
|{{{5}}}|}}]]}}{{#if:
|[[Category:{{{4}}}]]}}}}}}
{{#switch:
|editnotice = Template:Editnotice |#default = Lua error in package.lua at line 80: module 'Module:Category handler' not found.
}} {{#switch:
{{#if:
|
| {{#ifeq:Module|Module
| module
| other
}}
}}
| module = {{#switch: protected
| pre-alpha | prealpha | pa = 40x40px | alpha | a = 26x26px | beta | b = 40x40px | release | r | general | g = 40x40px | protected | protect | p = [[File:{{#switch:Lua error in Module:Effective_protection_level at line 14: attempt to index local 'title' (a nil value).|autoconfirmed=Semi|extendedconfirmed=Extended|accountcreator|templateeditor=Template|#default=Full}}-protection-shackle.svg|40x40px|link=|alt=Protected]] | semiprotected | semiprotect | semi =40x40px}} | {{#switch: protected
| pre-alpha | prealpha | pa = This module is rated as pre-alpha. It is unfinished, and may or may not be in active development. It should not be used from article namespace pages. Modules remain pre-alpha until the original editor (or someone who takes one over if it is abandoned for some time) is satisfied with the basic structure.{{#switch: Infobox|doc|sandbox= | {{#ifeq: | true | | }} }} | alpha | a = This module is rated as alpha. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome.{{#switch: Infobox|doc|sandbox= | {{#ifeq: | true | | }} }} | beta | b = This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.{{#switch: Infobox|doc|sandbox= | {{#ifeq: | true | | }} }} | release | r | general | g = This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.{{#switch: Infobox|doc|sandbox= | {{#ifeq: | true | | }} }} | protected | protect | p = This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.{{#switch: Infobox|doc|sandbox= | {{#ifeq: | true | | }} }} | semiprotected | semiprotect | semi = This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is semi-protected from editing.{{#switch: Infobox|doc|sandbox= | {{#ifeq: | true | | }} }} | #default = Template:Error}} |
| other | #default = Template:Error }}
| 30px | This module uses Lua: |
Module:Infobox is a module which implements the {{Infobox}} template. Please see the template page for usage instructions.
Tracking categories
- [[:Category:{{#ifeq:Articles |Category:|Template:Str right|Articles which use infobox templates with no data rows}}|{{#if:|{{{name}}}|Category:{{#ifeq:Articles |Category:|Template:Str right|Articles which use infobox templates with no data rows}}}}]] (0)
- [[:Category:{{#ifeq:Pages whi|Category:|Template:Str right|Pages which use embedded infobox templates with the title parameter}}|{{#if:|{{{name}}}|Category:{{#ifeq:Pages whi|Category:|Template:Str right|Pages which use embedded infobox templates with the title parameter}}}}]] (0)
{{#ifeq:Infobox|sandbox|| }}
--
-- This module implements {{Infobox}}
--
local p = {}
local HtmlBuilder = require('Module:HtmlBuilder')
local args
local root
function union(t1, t2)
-- Returns the union of the values of two tables, as a sequence.
local vals = {}
for k, v in pairs(t1) do
vals[v] = true
end
for k, v in pairs(t2) do
vals[v] = true
end
local ret = {}
for k, v in pairs(vals) do
table.insert(ret, k)
end
return ret
end
local function getArgNums(prefix)
-- Returns a table containing the numbers of the arguments that exist
-- for the specified prefix. For example, if the prefix was 'data', and
-- 'data1', 'data2', and 'data5' exist, it would return {1, 2, 5}.
local nums = {}
for k, v in pairs(args) do
local num = tostring(k):match('^' .. prefix .. '([1-9]%d*)$')
if num then table.insert(nums, tonumber(num)) end
end
table.sort(nums)
return nums
end
local function addRow(rowArgs)
-- Adds a row to the infobox, with either a header cell
-- or a label/data cell combination.
if rowArgs.header then
root
.tag('tr')
.tag('th')
.attr('colspan', 2)
.addClass(rowArgs.class)
.css('text-align', 'center')
.cssText(args.headerstyle)
.wikitext('\n' .. rowArgs.header)
elseif rowArgs.data then
local row = root.tag('tr')
row.addClass(rowArgs.rowclass)
if rowArgs.label then
row
.tag('th')
.attr('scope', 'row')
.css('text-align', 'left')
.cssText(args.labelstyle)
.wikitext('\n' .. rowArgs.label)
.done()
end
local dataCell = row.tag('td')
if not rowArgs.label then
dataCell
.attr('colspan', 2)
.css('text-align', 'center')
end
dataCell
.addClass(rowArgs.class)
.cssText(rowArgs.datastyle)
.wikitext('\n' .. rowArgs.data)
end
end
local function renderTitle()
if not args.title then return end
root
.tag('caption')
.addClass(args.titleclass)
.cssText(args.titlestyle)
.wikitext(args.title)
end
local function renderAboveRow()
if not args.above then return end
root
.tag('tr')
.tag('th')
.attr('colspan', 2)
.addClass(args.aboveclass)
.css('text-align', 'center')
.css('font-size', '125%')
.css('font-weight', 'bold')
.cssText(args.abovestyle)
.wikitext(args.above)
end
local function renderBelowRow()
if not args.below then return end
root
.tag('tr')
.tag('td')
.attr('colspan', '2')
.addClass(args.belowclass)
.css('text-align', 'center')
.cssText(args.belowstyle)
.newline()
.wikitext(args.below)
.newline()
end
local function renderSubheaders()
if args.subheader then
args.subheader1 = args.subheader
end
if args.subheaderrowclass then
args.subheaderrowclass1 = args.subheaderrowclass
end
local subheadernums = getArgNums('subheader')
for k, num in ipairs(subheadernums) do
addRow({
data = args['subheader' .. num],
datastyle = args.subheaderstyle or args['subheaderstyle' .. num],
class = args.subheaderclass,
rowclass = args['subheaderrowclass' .. num]
})
end
end
local function renderImages()
if args.image then
args.image1 = args.image
end
if args.caption then
args.caption1 = args.caption
end
local imagenums = getArgNums('image')
for k, num in ipairs(imagenums) do
local caption = args['caption' .. num]
local data = HtmlBuilder.create().wikitext(args['image' .. num])
if caption then
data
.tag('br', {selfClosing = true})
.done()
.tag('span')
.cssText(args.captionstyle)
.wikitext(caption)
end
addRow({
data = tostring(data),
datastyle = args.imagestyle,
class = args.imageclass,
rowclass = args['imagerowclass' .. num]
})
end
end
local function renderRows()
-- Gets the union of the header and data argument numbers,
-- and renders them all in order using addRow.
local rownums = union(getArgNums('header'), getArgNums('data'))
table.sort(rownums)
for k, num in ipairs(rownums) do
addRow({
header = args['header' .. num],
label = args['label' .. num],
data = args['data' .. num],
datastyle = args.datastyle,
class = args['class' .. num],
rowclass = args['rowclass' .. num]
})
end
end
local function renderNavBar()
if not args.name then return end
root
.tag('tr')
.tag('td')
.attr('colspan', '2')
.css('text-align', 'right')
.wikitext(mw.getCurrentFrame():expandTemplate({
title = 'navbar',
args = { args.name, mini = 1 }
}))
end
local function renderItalicTitle()
local italicTitle = args['italic title'] and mw.ustring.lower(args['italic title'])
if italicTitle == '' or italicTitle == 'force' or italicTitle == 'yes' then
root.wikitext(mw.getCurrentFrame():expandTemplate({title = 'italic title'}))
end
end
local function renderTrackingCategories()
if args.decat ~= 'yes' then
if #(getArgNums('data')) == 0 and mw.title.getCurrentTitle().namespace == 0 then
root.wikitext('[[Category:Articles which use infobox templates with no data rows]]')
end
if args.child == 'yes' and args.title then
root.wikitext('[[Category:Articles which use embedded infobox templates with the title parameter]]')
end
end
end
local function _infobox()
-- Specify the overall layout of the infobox, with special settings
-- if the infobox is used as a 'child' inside another infobox.
if args.child ~= 'yes' then
root = HtmlBuilder.create('table')
root
.addClass('infobox')
.addClass(args.bodyclass)
.attr('cellspacing', 3)
.css('border-spacing', '3px')
if args.subbox == 'yes' then
root
.css('padding', '0')
.css('border', 'none')
.css('margin', '-3px')
.css('width', 'auto')
.css('min-width', '100%')
.css('font-size', '100%')
.css('clear', 'none')
.css('float', 'none')
.css('background-color', 'transparent')
else
root
.css('width', '22em')
end
root
.cssText(args.bodystyle)
renderTitle()
renderAboveRow()
else
root = HtmlBuilder.create()
end
renderSubheaders()
renderImages()
renderRows()
renderBelowRow()
renderNavBar()
renderItalicTitle()
renderTrackingCategories()
return tostring(root)
end
local function touchParameters(prefixTable, origArgs, step)
-- Parse the parameters with the given prefixes, in order, in batches
-- of the step size specified. This is to prevent references etc. from
-- appearing in the wrong order.
if type(prefixTable) ~= 'table' or type(origArgs) ~= 'table' then
error("Invalid input to the touchParameters function detected. Both parameters must be tables.", 2)
end
if step and type(step) ~= 'number' then
error("Non-numerical step value detected.", 2)
end
step = step or 20 -- If the step size is not given, the default is 20.
local temp
local a = 1 -- Counter variable.
local moreArgumentsExist = true
for j,v in ipairs(prefixTable) do
if not type(v) == "string" then
error("Non-string value detected in the prefix table in the touchParameters function.", 2)
end
temp = origArgs[v]
end
while moreArgumentsExist == true do
moreArgumentsExist = false
for i = a, a + step - 1 do
for j,v in ipairs(prefixTable) do
temp = origArgs[v .. tostring(i)]
if temp then
moreArgumentsExist = true
end
end
end
a = a + step
end
end
function p.infobox(frame)
local origArgs
-- If called via #invoke, use the args passed into the invoking template.
-- Otherwise, for testing purposes, assume args are being passed directly in.
if frame == mw.getCurrentFrame() then
origArgs = frame:getParent().args
else
origArgs = frame
end
-- Parse the data parameters in the same order that the old {{infobox}} did, so that
-- references etc. will display in the expected places.
local temp
temp = origArgs.title
temp = origArgs.above
touchParameters({'subheader'}, origArgs, 5)
touchParameters({'image', 'caption'}, origArgs, 5)
touchParameters({'header', 'label', 'data'}, origArgs, 20)
temp = origArgs.below
-- ParserFunctions considers whitespace to be false, so to preserve the previous
-- behavior of {{infobox}}, change any whitespace arguments to nil, so Lua will consider
-- them false too. (Except the 'italic title' param, which specifies different behavior
-- depending on whether it's absent or empty)
args = {}
for k, v in pairs(origArgs) do
if mw.ustring.match(v, '%S') or k == 'italic title' then
args[k] = v
end
end
return _infobox()
end
return p
Categories:
- Pages with script errors
- Pages with broken file links
- Templates with missing or incorrect documentation
- Articles with invalid date parameter in template
- Modules in pre-alpha development
- Modules in alpha
- Modules in beta
- Modules for general use
- Modules subject to page protection
- Pages with templates in the wrong namespace
- Modules that add a tracking category
- Wikipedia infoboxes
- Infobox modules