Module:Message box: Difference between revisions

From All Skies Encyclopaedia
imported>Mr. Stradivarius
(on second thoughts, I like this way of passing params to category handler better)
m (1 revision imported)
 
(60 intermediate revisions by 15 users not shown)
Line 1: Line 1:
require('strict')
-- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
local getArgs

-- Require necessary modules.
local htmlBuilder = require('Module:HtmlBuilder')
local categoryHandler = require('Module:Category handler').main
local yesno = require('Module:Yesno')
local yesno = require('Module:Yesno')

-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()
local lang = mw.language.getContentLanguage()


local CONFIG_MODULE = 'Module:Message box/configuration'
-- Set aliases for often-used functions to reduce table lookups.
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}
local format = mw.ustring.format
local tinsert = table.insert
local tconcat = table.concat


--------------------------------------------------------------------------------
local box = {}
-- Helper functions
--------------------------------------------------------------------------------


local function getTitleObject(page)
local function getTitleObject(...)
-- Get the title object, passing the function through pcall
if type(page) == 'string' then
-- Get the title object, passing the function through pcall
-- in case we are over the expensive function count limit.
local success, title = pcall(mw.title.new, ...)
-- in case we are over the expensive function count limit.
if success then
local success, title = pcall(mw.title.new, page)
return title
if success then
end
return title
end
end
end

local function presentButBlank(s)
if type(s) ~= 'string' then return end
if s and not mw.ustring.find(s, '%S') then
return true
else
return false
end
end
end


local function union(t1, t2)
local function union(t1, t2)
-- Returns the union of two arrays.
-- Returns the union of two arrays.
local vals = {}
local vals = {}
for i, v in ipairs(t1) do
for i, v in ipairs(t1) do
vals[v] = true
vals[v] = true
end
end
for i, v in ipairs(t2) do
for i, v in ipairs(t2) do
vals[v] = true
vals[v] = true
end
end
local ret = {}
local ret = {}
for k in pairs(vals) do
for k in pairs(vals) do
tinsert(ret, k)
table.insert(ret, k)
end
end
table.sort(ret)
table.sort(ret)
return ret
return ret
end
end


local function getArgNums(args, prefix)
local function getArgNums(args, prefix)
local nums = {}
local nums = {}
for k, v in pairs(args) do
for k, v in pairs(args) do
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
if num then
if num then
tinsert(nums, tonumber(num))
table.insert(nums, tonumber(num))
end
end
end
end
table.sort(nums)
table.sort(nums)
return nums
return nums
end
end


--------------------------------------------------------------------------------
function box.getNamespaceId(ns)
-- Box class definition
if not ns then return end
--------------------------------------------------------------------------------
if type(ns) == 'string' then

ns = lang:ucfirst(mw.ustring.lower(ns))
local MessageBox = {}
if ns == 'Main' then
MessageBox.__index = MessageBox
ns = 0

end
function MessageBox.new(boxType, args, cfg)
end
args = args or {}
local nsTable = mw.site.namespaces[ns]
local obj = {}
if nsTable then

return nsTable.id
-- Set the title object and the namespace.
end
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()

-- Set the config for our box type.
obj.cfg = cfg[boxType]
if not obj.cfg then
local ns = obj.title.namespace
-- boxType is "mbox" or invalid input
if args.demospace and args.demospace ~= '' then
-- implement demospace parameter of mbox
local demospace = string.lower(args.demospace)
if DEMOSPACES[demospace] then
-- use template from DEMOSPACES
obj.cfg = cfg[DEMOSPACES[demospace]]
elseif string.find( demospace, 'talk' ) then
-- demo as a talk page
obj.cfg = cfg.tmbox
else
-- default to ombox
obj.cfg = cfg.ombox
end
elseif ns == 0 then
obj.cfg = cfg.ambox -- main namespace
elseif ns == 6 then
obj.cfg = cfg.imbox -- file namespace
elseif ns == 14 then
obj.cfg = cfg.cmbox -- category namespace
else
local nsTable = mw.site.namespaces[ns]
if nsTable and nsTable.isTalk then
obj.cfg = cfg.tmbox -- any talk namespace
else
obj.cfg = cfg.ombox -- other namespaces or invalid input
end
end
end

-- Set the arguments, and remove all blank arguments except for the ones
-- listed in cfg.allowBlankParams.
do
local newArgs = {}
for k, v in pairs(args) do
if v ~= '' then
newArgs[k] = v
end
end
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
newArgs[param] = args[param]
end
obj.args = newArgs
end

-- Define internal data structure.
obj.categories = {}
obj.classes = {}
-- For lazy loading of [[Module:Category handler]].
obj.hasCategories = false

return setmetatable(obj, MessageBox)
end
end


function box.getMboxType(nsid)
function MessageBox:addCat(ns, cat, sort)
if not cat then
-- Gets the mbox type from a namespace number.
return nil
if nsid == 0 then
end
return 'ambox' -- main namespace
elseif nsid == 6 then
if sort then
cat = string.format('[[Category:%s|%s]]', cat, sort)
return 'imbox' -- file namespace
else
elseif nsid == 14 then
cat = string.format('[[Category:%s]]', cat)
return 'cmbox' -- category namespace
end
else
self.hasCategories = true
local nsTable = mw.site.namespaces[nsid]
self.categories[ns] = self.categories[ns] or {}
if nsTable and nsTable.isTalk then
table.insert(self.categories[ns], cat)
return 'tmbox' -- any talk namespace
else
return 'ombox' -- other namespaces or invalid input
end
end
end
end


function box:addCat(ns, cat, sort)
function MessageBox:addClass(class)
if type(cat) ~= 'string' then return end
if not class then
return nil
local nsVals = {'main', 'template', 'all'}
end
local tname
table.insert(self.classes, class)
for i, val in ipairs(nsVals) do
if ns == val then
tname = ns .. 'Cats'
end
end
if not tname then
for i, val in ipairs(nsVals) do
nsVals[i] = format('"%s"', val)
end
error('invalid ns parameter passed to box:addCat; valid values are ' .. mw.text.listToText(nsVals, nil, ' or '))
end
self[tname] = self[tname] or {}
if type(sort) == 'string' then
tinsert(self[tname], format('[[Category:%s|%s]]', cat, sort))
else
tinsert(self[tname], format('[[Category:%s]]', cat))
end
end
end


function box:addClass(class)
function MessageBox:setParameters()
local args = self.args
if type(class) ~= 'string' then return end
self.classes = self.classes or {}
local cfg = self.cfg

tinsert(self.classes, class)
-- Get type data.
self.type = args.type
local typeData = cfg.types[self.type]
self.invalidTypeError = cfg.showInvalidTypeError
and self.type
and not typeData
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
self.typeImage = typeData.image
self.typeImageNeedsLink = typeData.imageNeedsLink

-- Find if the box has been wrongly substituted.
self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'

-- Find whether we are using a small message box.
self.isSmall = cfg.allowSmall and (
cfg.smallParam and args.small == cfg.smallParam
or not cfg.smallParam and yesno(args.small)
)

-- Set the below row.
self.below = cfg.below and args.below
-- Add attributes, classes and styles.
self.id = args.id
self.name = args.name
if self.name then
self:addClass('box-' .. string.gsub(self.name,' ','_'))
end
if yesno(args.plainlinks) ~= false then
self:addClass('plainlinks')
end
if self.below then
self:addClass('mbox-with-below')
end
for _, class in ipairs(cfg.classes or {}) do
self:addClass(class)
end
if self.isSmall then
self:addClass(cfg.smallClass or 'mbox-small')
end
self:addClass(self.typeClass)
self:addClass(args.class)
self.style = args.style
self.attrs = args.attrs

-- Set text style.
self.textstyle = args.textstyle

-- Set image classes.
self.imageRightClass = args.imagerightclass or args.imageclass
self.imageLeftClass = args.imageleftclass or args.imageclass

-- Find if we are on the template page or not. This functionality is only
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
-- and cfg.templateCategoryRequireName are set.
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
if self.useCollapsibleTextFields
or cfg.templateCategory
and cfg.templateCategoryRequireName
then
if self.name then
local templateName = mw.ustring.match(
self.name,
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
) or self.name
templateName = 'Template:' .. templateName
self.templateTitle = getTitleObject(templateName)
end
self.isTemplatePage = self.templateTitle
and mw.title.equals(self.title, self.templateTitle)
end
-- Process data for collapsible text fields. At the moment these are only
-- used in {{ambox}}.
if self.useCollapsibleTextFields then
-- Get the self.issue value.
if self.isSmall and args.smalltext then
self.issue = args.smalltext
else
local sect
if args.sect == '' then
sect = 'This ' .. (cfg.sectionDefault or 'page')
elseif type(args.sect) == 'string' then
sect = 'This ' .. args.sect
end
local issue = args.issue
issue = type(issue) == 'string' and issue ~= '' and issue or nil
local text = args.text
text = type(text) == 'string' and text or nil
local issues = {}
table.insert(issues, sect)
table.insert(issues, issue)
table.insert(issues, text)
self.issue = table.concat(issues, ' ')
end

-- Get the self.talk value.
local talk = args.talk
-- Show talk links on the template page or template subpages if the talk
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
or self.title:isSubpageOf(self.templateTitle)
)
then
talk = '#'
elseif talk == '' then
talk = nil
end
if talk then
-- If the talk value is a talk page, make a link to that page. Else
-- assume that it's a section heading, and make a link to the talk
-- page of the current page with that section heading.
local talkTitle = getTitleObject(talk)
local talkArgIsTalkPage = true
if not talkTitle or not talkTitle.isTalkPage then
talkArgIsTalkPage = false
talkTitle = getTitleObject(
self.title.text,
mw.site.namespaces[self.title.namespace].talk.id
)
end
if talkTitle and talkTitle.exists then
local talkText
if self.isSmall then
local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. (talk == '#' and '' or '#') .. talk)
talkText = string.format('([[%s|talk]])', talkLink)
else
talkText = 'Relevant discussion may be found on'
if talkArgIsTalkPage then
talkText = string.format(
'%s [[%s|%s]].',
talkText,
talk,
talkTitle.prefixedText
)
else
talkText = string.format(
'%s the [[%s' .. (talk == '#' and '' or '#') .. '%s|talk page]].',
talkText,
talkTitle.prefixedText,
talk
)
end
end
self.talk = talkText
end
end

-- Get other values.
self.fix = args.fix ~= '' and args.fix or nil
local date
if args.date and args.date ~= '' then
date = args.date
elseif args.date == '' and self.isTemplatePage then
date = lang:formatDate('F Y')
end
if date then
self.date = string.format(" <span class='date-container'><i>(<span class='date'>%s</span>)</i></span>", date)
end
self.info = args.info
if yesno(args.removalnotice) then
self.removalNotice = cfg.removalNotice
end
end

-- Set the non-collapsible text field. At the moment this is used by all box
-- types other than ambox, and also by ambox when small=yes.
if self.isSmall then
self.text = args.smalltext or args.text
else
self.text = args.text
end

-- General image settings.
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
self.imageEmptyCell = cfg.imageEmptyCell

-- Left image settings.
local imageLeft = self.isSmall and args.smallimage or args.image
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
or not cfg.imageCheckBlank and imageLeft ~= 'none'
then
self.imageLeft = imageLeft
if not imageLeft then
local imageSize = self.isSmall
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s%s|alt=]]', self.typeImage
or 'Information icon4.svg', imageSize, self.typeImageNeedsLink and "" or "|link=" )
end
end

-- Right image settings.
local imageRight = self.isSmall and args.smallimageright or args.imageright
if not (cfg.imageRightNone and imageRight == 'none') then
self.imageRight = imageRight
end
-- set templatestyles
self.base_templatestyles = cfg.templatestyles
self.templatestyles = args.templatestyles
end
end


function box:setTitle(args)
function MessageBox:setMainspaceCategories()
local args = self.args
-- Get the title object and the namespace.
local cfg = self.cfg
self.pageTitle = getTitleObject(args.page ~= '' and args.page)

self.title = self.pageTitle or mw.title.getCurrentTitle()
if not cfg.allowMainspaceCategories then
self.demospace = args.demospace ~= '' and args.demospace or nil
return nil
self.nsid = box.getNamespaceId(self.demospace) or self.title.namespace
end

local nums = {}
for _, prefix in ipairs{'cat', 'category', 'all'} do
args[prefix .. '1'] = args[prefix]
nums = union(nums, getArgNums(args, prefix))
end

-- The following is roughly equivalent to the old {{Ambox/category}}.
local date = args.date
date = type(date) == 'string' and date
local preposition = 'from'
for _, num in ipairs(nums) do
local mainCat = args['cat' .. tostring(num)]
or args['category' .. tostring(num)]
local allCat = args['all' .. tostring(num)]
mainCat = type(mainCat) == 'string' and mainCat
allCat = type(allCat) == 'string' and allCat
if mainCat and date and date ~= '' then
local catTitle = string.format('%s %s %s', mainCat, preposition, date)
self:addCat(0, catTitle)
catTitle = getTitleObject('Category:' .. catTitle)
if not catTitle or not catTitle.exists then
self:addCat(0, 'Articles with invalid date parameter in template')
end
elseif mainCat and (not date or date == '') then
self:addCat(0, mainCat)
end
if allCat then
self:addCat(0, allCat)
end
end
end
end


function box:getConfig(boxType)
function MessageBox:setTemplateCategories()
local args = self.args
-- Get the box config data from the data page.
local cfg = self.cfg
if boxType == 'mbox' then

boxType = box.getMboxType(self.nsid)
-- Add template categories.
end
if cfg.templateCategory then
local cfgTables = mw.loadData('Module:Message box/configuration')
if cfg.templateCategoryRequireName then
local cfg = cfgTables[boxType]
if not cfg then
if self.isTemplatePage then
self:addCat(10, cfg.templateCategory)
local boxTypes = {}
end
for k, v in pairs(dataTables) do
elseif not self.title.isSubpage then
tinsert(boxTypes, format('"%s"', k))
self:addCat(10, cfg.templateCategory)
end
end
tinsert(boxTypes, '"mbox"')
end
error(format('invalid message box type "%s"; valid types are %s', tostring(boxType), mw.text.listToText(boxTypes)), 2)

end
-- Add template error categories.
return cfg
if cfg.templateErrorCategory then
local templateErrorCategory = cfg.templateErrorCategory
local templateCat, templateSort
if not self.name and not self.title.isSubpage then
templateCat = templateErrorCategory
elseif self.isTemplatePage then
local paramsToCheck = cfg.templateErrorParamsToCheck or {}
local count = 0
for i, param in ipairs(paramsToCheck) do
if not args[param] then
count = count + 1
end
end
if count > 0 then
templateCat = templateErrorCategory
templateSort = tostring(count)
end
if self.categoryNums and #self.categoryNums > 0 then
templateCat = templateErrorCategory
templateSort = 'C'
end
end
self:addCat(10, templateCat, templateSort)
end
end
end

function box:removeBlankArgs(cfg, args)
function MessageBox:setAllNamespaceCategories()
-- Set categories for all namespaces.
-- Only allow blank arguments for the parameter names listed in cfg.allowBlankParams.
if self.invalidTypeError then
local newArgs = {}
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
for k, v in pairs(args) do
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
for i, param in ipairs(cfg.allowBlankParams or {}) do
end
if v ~= '' or k == param then
if self.isSubstituted then
newArgs[k] = v
self:addCat('all', 'Pages with incorrectly substituted templates')
end
end
end
end
return newArgs
end
end


function box:setBoxParameters(cfg, args)
function MessageBox:setCategories()
if self.title.namespace == 0 then
-- Get type data.
self:setMainspaceCategories()
self.type = args.type
elseif self.title.namespace == 10 then
local typeData = cfg.types[self.type]
self:setTemplateCategories()
self.invalidType = self.type and not typeData and true or false
end
typeData = typeData or cfg.types[cfg.default]
self:setAllNamespaceCategories()
self.typeClass = typeData.class
end
self.typeImage = typeData.image


function MessageBox:renderCategories()
-- Find if the box has been wrongly substituted.
if not self.hasCategories then
if cfg.substCheck and args.subst == 'SUBST' then
-- No categories added, no need to pass them to Category handler so,
self.isSubstituted = true
-- if it was invoked, it would return the empty string.
end
-- So we shortcut and return the empty string.
return ""
end
-- Convert category tables to strings and pass them through
-- [[Module:Category handler]].
return require('Module:Category handler')._main{
main = table.concat(self.categories[0] or {}),
template = table.concat(self.categories[10] or {}),
all = table.concat(self.categories.all or {}),
nocat = self.args.nocat,
page = self.args.page
}
end


function MessageBox:exportDiv()
-- Find whether we are using a small message box.
local root = mw.html.create()
self.isSmall = cfg.allowSmall and (args.small == 'yes' or args.small == true) and true or false


-- Add attributes, classes and styles.
-- Add the subst check error.
if self.isSubstituted and self.name then
self.id = args.id
root:tag('b')
self:addClass(cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks')
:addClass('error')
for _, class in ipairs(cfg.classes or {}) do
:wikitext(string.format(
self:addClass(class)
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
end
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
if self.isSmall then
))
self:addClass(cfg.smallClass or 'mbox-small')
end
end
self:addClass(self.typeClass)
self.style = args.style


local frame = mw.getCurrentFrame()
-- Set text style.
root:wikitext(frame:extensionTag{
self.textstyle = args.textstyle
name = 'templatestyles',
args = { src = self.base_templatestyles },
})
-- Add support for a single custom templatestyles sheet. Undocumented as
-- need should be limited and many templates using mbox are substed; we
-- don't want to spread templatestyles sheets around to arbitrary places
if self.templatestyles then
root:wikitext(frame:extensionTag{
name = 'templatestyles',
args = { src = self.templatestyles },
})
end


-- Create the box.
-- Process data for collapsible text fields. At the moment these are only used in {{ambox}}.
local mbox = root:tag('div')
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
mbox:attr('id', self.id or nil)
if self.useCollapsibleTextFields then
self.name = args.name
for i, class in ipairs(self.classes or {}) do
mbox:addClass(class or nil)
local nameTitle = getTitleObject(name)
end
self.isTemplatePage = nameTitle and title.prefixedText == ('Template:' .. nameTitle.text) and true or false
mbox
:cssText(self.style or nil)


if self.attrs then
-- Get the self.issue value.
mbox:attr(self.attrs)
local sect = args.sect
end
if presentButBlank(sect) then
sect = 'This ' .. (cfg.sectionDefault or 'page')
local flex_container
elseif type(sect) == 'string' then
if self.below then
sect = 'This ' .. sect
-- we need to wrap the flex components (`image(right)` and `text`) in their
else
-- own container div to support the `below` parameter
sect = nil
flex_container = mw.html.create('div')
end
flex_container:addClass('mbox-flex')
local issue = args.issue
else
issue = type(issue) == 'string' and issue or nil
-- the mbox itself is the parent, so we need no HTML flex_container
local text = args.text
flex_container = mw.html.create()
text = type(text) == 'string' and text or nil
end
local issues = {}
tinsert(issues, sect)
tinsert(issues, issue)
tinsert(issues, text)
self.issue = tconcat(issues, ' ')


-- Get the self.talk value.
-- Add the left-hand image.
if self.imageLeft then
local talk = args.talk
local imageLeftCell = flex_container:tag('div'):addClass('mbox-image')
if presentButBlank(talk) and self.isTemplatePage then
imageLeftCell
talk = '#'
:addClass(self.imageLeftClass)
end
:wikitext(self.imageLeft or nil)
if talk then
end
-- See if the talk link exists and is for a talk or a content namespace.
local talkTitle = getTitleObject(talk)
if not talkTitle or not talkTitle.isTalkPage then
-- If we couldn't process the talk page link, get the talk page of the current page.
local success
success, talkTitle = pcall(title.talkPageTitle, title)
if not success then
talkTitle = nil
end
end
if talkTitle and talkTitle.exists then
local talkText = 'Relevant discussion may be found on'
if talkTitle.isTalkPage then
talkText = format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText)
else
talkText = format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk)
end
self.talk = talkText
end
end


-- Get other values.
-- Add the text.
local textCell = flex_container:tag('div'):addClass('mbox-text')
self.fix = args.fix
if self.useCollapsibleTextFields then
local date = args.date
-- The message box uses advanced text parameters that allow things to be
self.date = date and format(" <small>''(%s)''</small>", date)
-- collapsible. At the moment, only ambox uses this.
if presentButBlank(self.date) and self.isTemplatePage then
textCell:cssText(self.textstyle or nil)
self.date = lang:formatDate('F Y')
local textCellDiv = textCell:tag('div')
end
textCellDiv
self.info = args.info
:addClass('mbox-text-span')
end
:wikitext(self.issue or nil)
if (self.talk or self.fix) then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:wikitext(self.talk and (' ' .. self.talk) or nil)
:wikitext(self.fix and (' ' .. self.fix) or nil)
end
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
if self.info and not self.isSmall then
textCellDiv
:tag('span')
:addClass('hide-when-compact')
:wikitext(self.info and (' ' .. self.info) or nil)
end
if self.removalNotice then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:tag('i')
:wikitext(string.format(" (%s)", self.removalNotice))
end
else
-- Default text formatting - anything goes.
textCell
:cssText(self.textstyle or nil)
:wikitext(self.text or nil)
end


-- Add the right-hand image.
-- Set the non-collapsible text field. At the moment this is used by all box types other than ambox,
if self.imageRight then
-- and also by ambox when small=yes.
local imageRightCell = flex_container:tag('div'):addClass('mbox-imageright')
if self.isSmall then
imageRightCell
if self.useCollapsibleTextFields then
:addClass(self.imageRightClass)
self.text = args.smalltext or self.issue
:wikitext(self.imageRight or nil)
else
end
self.text = args.smalltext or args.text
end
mbox:node(flex_container)
else
self.text = args.text
end


-- Set the below row.
-- Add the below row.
self.below = cfg.below and args.below
if self.below then
mbox:tag('div')
:addClass('mbox-text mbox-below')
:cssText(self.textstyle or nil)
:wikitext(self.below or nil)
end


-- Add error message for invalid type parameters.
-- General image settings.
if self.invalidTypeError then
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
root:tag('div')
self.imageEmptyCell = cfg.imageEmptyCell
:addClass('mbox-invalid-type')
if cfg.imageEmptyCellStyle then
:wikitext(string.format(
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
'This message box is using an invalid "type=%s" parameter and needs fixing.',
end
self.type or ''
))
end


-- Add categories.
-- Left image settings.
root:wikitext(self:renderCategories() or nil)
local imageCheckBlank = cfg.imageCheckBlank
local imageLeft = self.isSmall and args.smallimage or args.image
if imageLeft ~= 'none' and not imageCheckBlank or imageLeft ~= 'none' and imageCheckBlank and image ~= 'blank' then
self.imageLeft = imageLeft
if not imageLeft then
local imageSize = self.isSmall and (cfg.imageSmallSize or '30x30px') or '40x40px'
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage or 'Imbox notice.png', imageSize)
end
end


return tostring(root)
-- Right image settings.
end
local imageRight = self.isSmall and args.smallimageright or args.imageright
if not (cfg.imageRightNone and imageRight == 'none') then
self.imageRight = imageRight
end


function MessageBox:export()
-- Add mainspace categories. At the moment these are only used in {{ambox}}.
if cfg.allowMainspaceCategories then
if args.cat then
args.cat1 = args.cat
end
self.catNums = getArgNums(args, 'cat')
if args.category then
args.category1 = args.category
end
self.categoryNums = getArgNums(args, 'category')
self.categoryParamNums = union(self.catNums, self.categoryNums)
-- The following is roughly equivalent to the old {{Ambox/category}}.
local date = args.date
date = type(date) == 'string' and date
local preposition = 'from'
for _, num in ipairs(self.categoryParamNums) do
local mainCat = args['cat' .. tostring(num)] or args['category' .. tostring(num)]
local allCat = args['all' .. tostring(num)]
mainCat = type(mainCat) == 'string' and mainCat
allCat = type(allCat) == 'string' and allCat
if mainCat and date then
local catTitle = format('%s %s %s', mainCat, preposition, date)
self:addCat('main', catTitle)
catTitle = getTitleObject('Category:' .. catTitle)
if not catTitle or not catTitle.exists then
self:addCat('main', 'Articles with invalid date parameter in template')
end
elseif mainCat and not date then
self:addCat('main', mainCat)
end
if allCat then
self:addCat('main', allCat)
end
end
end


local root = mw.html.create()
-- Add template-namespace categories.
self.isTemplatePage = type(self.name) == 'string' and title.prefixedText == ('Template:' .. self.name)
if cfg.templateCategory then
if self.name then
if self.isTemplatePage then
self:addCat('template', cfg.templateCategory)
end
elseif not self.title.isSubpage then
self:addCat('template', cfg.templateCategory)
end
end
-- Add template error category.
if cfg.templateErrorCategory then
local templateErrorCategory = cfg.templateErrorCategory
local templateCat, templateSort
if not self.name and not self.title.isSubpage then
templateCat = templateErrorCategory
elseif type(self.name) == 'string' and title.prefixedText == ('Template:' .. name) then
local paramsToCheck = cfg.templateErrorParamsToCheck or {}
local count = 0
for i, param in ipairs(paramsToCheck) do
if not args[param] then
count = count + 1
end
end
if count > 0 then
templateCat = templateErrorCategory
templateSort = tostring(count)
end
if self.categoryNums and #self.categoryNums > 0 then
templateCat = templateErrorCategory
templateSort = 'C'
end
end
self:addCat('template', templateCat, templateSort)
end


-- Add the subst check error.
-- Categories for all namespaces.
if self.invalidType then
if self.isSubstituted and self.name then
root:tag('b')
local allSort = (nsid == 0 and 'Main:' or '') .. title.prefixedText
:addClass('error')
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
:wikitext(string.format(
end
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
if self.isSubstituted then
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
self:addCat('all', 'Pages with incorrectly substituted templates')
))
end
end


local frame = mw.getCurrentFrame()
-- Convert category tables to strings and pass them through [[Module:Category handler]].
root:wikitext(frame:extensionTag{
self.categories = categoryHandler{
name = 'templatestyles',
main = tconcat(self.mainCats or {}),
template = tconcat(self.templateCats or {}),
args = { src = self.base_templatestyles },
})
all = tconcat(self.allCats or {}),
-- Add support for a single custom templatestyles sheet. Undocumented as
nocat = args.nocat,
-- need should be limited and many templates using mbox are substed; we
demospace = self.demospace,
-- don't want to spread templatestyles sheets around to arbitrary places
page = self.pageTitle and pageTitle.prefixedText or nil
if self.templatestyles then
}
root:wikitext(frame:extensionTag{
end
name = 'templatestyles',
args = { src = self.templatestyles },
})
end


-- Create the box table.
function box:export()
local root = htmlBuilder.create()
local boxTable = root:tag('table')
boxTable:attr('id', self.id or nil)
for i, class in ipairs(self.classes or {}) do
boxTable:addClass(class or nil)
end
boxTable
:cssText(self.style or nil)
:attr('role', 'presentation')


if self.attrs then
-- Add the subst check error.
boxTable:attr(self.attrs)
if self.isSubstituted and self.name then
end
root
.tag('b')
.addClass('error')
.wikitext(format(
'Template <code>%s%s%s</code> has been incorrectly substituted.',
mw.text.nowiki('{{'), self.name, mw.text.nowiki('}}')
))
end


-- Create the box table.
-- Add the left-hand image.
local boxTable = root.tag('table')
local row = boxTable:tag('tr')
if self.imageLeft then
boxTable
local imageLeftCell = row:tag('td'):addClass('mbox-image')
.attr('id', self.id)
if self.imageCellDiv then
for i, class in ipairs(self.classes or {}) do
-- If we are using a div, redefine imageLeftCell so that the image
boxTable
-- is inside it. Divs use style="width: 52px;", which limits the
.addClass(class)
-- image width to 52px. If any images in a div are wider than that,
end
-- they may overlap with the text or cause other display problems.
boxTable
imageLeftCell = imageLeftCell:tag('div'):addClass('mbox-image-div')
.cssText(self.style)
end
.attr('role', 'presentation')
imageLeftCell
:addClass(self.imageLeftClass)
:wikitext(self.imageLeft or nil)
elseif self.imageEmptyCell then
-- Some message boxes define an empty cell if no image is specified, and
-- some don't. The old template code in templates where empty cells are
-- specified gives the following hint: "No image. Cell with some width
-- or padding necessary for text cell to have 100% width."
row:tag('td')
:addClass('mbox-empty-cell')
end


-- Add the left-hand image.
-- Add the text.
local row = boxTable.tag('tr')
local textCell = row:tag('td'):addClass('mbox-text')
if self.imageLeft then
if self.useCollapsibleTextFields then
-- The message box uses advanced text parameters that allow things to be
local imageLeftCell = row.tag('td').addClass('mbox-image')
-- collapsible. At the moment, only ambox uses this.
if self.imageCellDiv then
textCell:cssText(self.textstyle or nil)
-- If we are using a div, redefine imageLeftCell so that the image is inside it.
local textCellDiv = textCell:tag('div')
-- Not sure why only some box types use divs, but it probably has something to do
textCellDiv
-- with that style="width: 52px;". @TODO: find out exactly what this does and fix this comment.
:addClass('mbox-text-span')
imageLeftCell = imageLeftCell.tag('div').css('width', '52px')
:wikitext(self.issue or nil)
end
if (self.talk or self.fix) then
imageLeftCell
textCellDiv:tag('span')
.wikitext(self.imageLeft)
:addClass('hide-when-compact')
elseif self.imageEmptyCell then
:wikitext(self.talk and (' ' .. self.talk) or nil)
-- Some message boxes define an empty cell if no image is specified, and some don't.
:wikitext(self.fix and (' ' .. self.fix) or nil)
-- The old template code in templates where empty cells are specified gives the following hint:
end
-- "No image. Cell with some width or padding necessary for text cell to have 100% width."
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
row.tag('td')
if self.info and not self.isSmall then
.addClass('mbox-empty-cell')
textCellDiv
.cssText(self.imageEmptyCellStyle)
:tag('span')
end
:addClass('hide-when-compact')
:wikitext(self.info and (' ' .. self.info) or nil)
end
if self.removalNotice then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:tag('i')
:wikitext(string.format(" (%s)", self.removalNotice))
end
else
-- Default text formatting - anything goes.
textCell
:cssText(self.textstyle or nil)
:wikitext(self.text or nil)
end


-- Add the text.
-- Add the right-hand image.
if self.imageRight then
local textCell = row.tag('td').addClass('mbox-text')
local imageRightCell = row:tag('td'):addClass('mbox-imageright')
if self.useCollapsibleTextFields then
if self.imageCellDiv then
-- The message box uses advanced text parameters that allow things to be collapsible. At the
-- If we are using a div, redefine imageRightCell so that the image
-- moment, only ambox uses this.
-- is inside it.
textCell
imageRightCell = imageRightCell:tag('div'):addClass('mbox-image-div')
.cssText(self.textstyle)
end
local textCellSpan = textCell.tag('span')
imageRightCell
textCellSpan
.addClass('mbox-text-span')
:addClass(self.imageRightClass)
.wikitext(self.issue)
:wikitext(self.imageRight or nil)
end
if not isSmall then
textCellSpan
.tag('span')
.addClass('hide-when-compact')
.wikitext(self.talk and ' ' .. self.talk)
.wikitext(self.fix and ' ' .. self.fix)
end
textCellSpan
.wikitext(self.date and ' ' .. self.date)
if not isSmall then
textCellSpan
.tag('span')
.addClass('hide-when-compact')
.wikitext(self.info and ' ' .. self.info)
end
else
-- Default text formatting - anything goes.
textCell
.cssText(self.textstyle)
.wikitext(self.text)
end


-- Add the right-hand image.
-- Add the below row.
if self.imageRight then
if self.below then
boxTable:tag('tr')
local imageRightCell = row.tag('td').addClass('mbox-imageright')
:tag('td')
if not self.imageCellDiv then
:attr('colspan', self.imageRight and '3' or '2')
imageRightCell = imageRightCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
:addClass('mbox-text')
end
:cssText(self.textstyle or nil)
imageRightCell
.wikitext(self.imageRight)
:wikitext(self.below or nil)
end
end


-- Add error message for invalid type parameters.
-- Add the below row.
if self.below then
if self.invalidTypeError then
boxTable.tag('tr')
root:tag('div')
:addClass('mbox-invalid-type')
.tag('td')
:wikitext(string.format(
.attr('colspan', self.imageRight and '3' or '2')
'This message box is using an invalid "type=%s" parameter and needs fixing.',
.addClass('mbox-text')
self.type or ''
.cssText(self.textstyle)
))
.wikitext(self.below)
end
end

-- Add categories.
root:wikitext(self:renderCategories() or nil)

return tostring(root)
end


--------------------------------------------------------------------------------
-- Add error message for invalid type parameters.
-- Exports
if self.invalidType then
--------------------------------------------------------------------------------
root
.tag('div')
.addClass('error')
.css('text-align', 'center')
.wikitext(format('This message box is using an invalid type parameter (<code>type=%s</code>) and needs fixing.', self.type or ''))
end


local p, mt = {}, {}
-- Add categories.
root
.wikitext(self.categories)


function p._exportClasses()
return tostring(root)
-- For testing.
return {
MessageBox = MessageBox
}
end
end


local function makeBox(boxType, args)
function p.main(boxType, args, cfgTables)
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE))
box:setTitle(args)
box:setParameters()
local cfg = box:getConfig(boxType)
box:setCategories()
args = box:removeBlankArgs(cfg, args)
-- DIV MIGRATION CONDITIONAL
box:setBoxParameters(cfg, args)
if box.cfg.div_structure then
return box:export()
return box:exportDiv()
end
-- END DIV MIGRATION CONDITIONAL
return box:export()
end
end


local function makeWrapper(boxType)
function mt.__index(t, k)
return function (frame)
return function (frame)
if not getArgs then
-- If called via #invoke, use the args passed into the invoking
getArgs = require('Module:Arguments').getArgs
-- template, or the args passed to #invoke if any exist. Otherwise
end
-- assume args are being passed directly in from the debug console
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
-- or from another Lua module.
end
local args
if frame == mw.getCurrentFrame() then
args = frame:getParent().args
for k, v in pairs(frame.args) do
args = frame.args
break
end
else
args = frame
end
return makeBox(boxType, args)
end
end
end


return {
return setmetatable(p, mt)
box = box,
makeBox = makeBox,
mbox = makeWrapper('mbox'),
ambox = makeWrapper('ambox'),
cmbox = makeWrapper('cmbox'),
fmbox = makeWrapper('fmbox'),
imbox = makeWrapper('imbox'),
ombox = makeWrapper('ombox'),
tmbox = makeWrapper('tmbox')
}

Latest revision as of 13:57, 29 October 2025

Template:Used in system

Lua error: bad argument #1 to "get" (not a valid title).

This is a meta-module that implements the message box templates {{mbox}}, {{ambox}}, {{cmbox}}, {{fmbox}}, {{imbox}}, {{ombox}}, and {{tmbox}}. It is intended to be used from Lua modules, and should not be used directly from wiki pages. If you want to use this module's functionality from a wiki page, please use the individual message box templates instead.

Usage

To use this module from another Lua module, first you need to load it.

local messageBox = require('Module:Message box')

To create a message box, use the main function. It takes two parameters: the first is the box type (as a string), and the second is a table containing the message box parameters.

local box = messageBox.main( boxType, {
    param1 = param1,
    param2 = param2,
    -- More parameters...
})

There are seven available box types:

Box type Template Purpose
mbox {{mbox}} For message boxes to be used in multiple namespaces
ambox {{ambox}} For article message boxes
cmbox {{cmbox}} For category message boxes
fmbox {{fmbox}} For interface message boxes
imbox {{imbox}} For file namespace message boxes
tmbox {{tmbox}} For talk page message boxes
ombox {{ombox}} For message boxes in other namespaces

See the template page of each box type for the available parameters.

Usage from #invoke

As well as the main function, this module has separate functions for each box type. They are accessed using the code {{#invoke:Message box|mbox|...}}, {{#invoke:Message box|ambox|...}}, etc. These will work when called from other modules, but they access code used to process arguments passed from #invoke, and so calling them will be less efficient than calling main.

Technical details

The module uses the same basic code for each of the templates listed above; the differences between each of them are configured using the data at Module:Message box/configuration. Here are the various configuration options and what they mean:

  • types – a table containing data used by the type parameter of the message box. The table keys are the values that can be passed to the type parameter, and the table values are tables containing the class and the image used by that type.
  • default – the type to use if no value was passed to the type parameter, or if an invalid value was specified.
  • showInvalidTypeError – whether to show an error if the value passed to the type parameter was invalid.
  • allowBlankParams – usually blank values are stripped from parameters passed to the module. However, whitespace is preserved for the parameters included in the allowBlankParams table.
  • allowSmall – whether a small version of the message box can be produced with "small=yes".
  • smallParam – a custom name for the small parameter. For example, if set to "left" you can produce a small message box using "small=left".
  • smallClass – the class to use for small message boxes.
  • substCheck – whether to perform a subst check or not.
  • classes – an array of classes to use with the message box.
  • imageEmptyCell – whether to use an empty <td>...</td> cell if there is no image set. This is used to preserve spacing for message boxes with a width of less than 100% of the screen.
  • imageEmptyCellStyle – whether empty image cells should be styled.
  • imageCheckBlank – whether "image=blank" results in no image being displayed.
  • imageSmallSize – usually, images used in small message boxes are set to 30x30px. This sets a custom size.
  • imageCellDiv – whether to enclose the image in a div enforcing a maximum image size.
  • useCollapsibleTextFields – whether to use text fields that can be collapsed, i.e. "issue", "fix", "talk", etc. Currently only used in ambox.
  • imageRightNone – whether imageright=none results in no image being displayed on the right-hand side of the message box.
  • sectionDefault – the default name for the "section" parameter. Depends on useCollapsibleTextFields.
  • allowMainspaceCategories – allow categorisation in the main namespace.
  • templateCategory – the name of a category to be placed on the template page.
  • templateCategoryRequireName – whether the name parameter is required to display the template category.
  • templateErrorCategory – the name of the error category to be used on the template page.
  • templateErrorParamsToCheck – an array of parameter names to check. If any are absent, the templateErrorCategory is applied to the template page.

require('strict')
local getArgs
local yesno = require('Module:Yesno')
local lang = mw.language.getContentLanguage()

local CONFIG_MODULE = 'Module:Message box/configuration'
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function getTitleObject(...)
	-- Get the title object, passing the function through pcall
	-- in case we are over the expensive function count limit.
	local success, title = pcall(mw.title.new, ...)
	if success then
		return title
	end
end

local function union(t1, t2)
	-- Returns the union of two arrays.
	local vals = {}
	for i, v in ipairs(t1) do
		vals[v] = true
	end
	for i, v in ipairs(t2) do
		vals[v] = true
	end
	local ret = {}
	for k in pairs(vals) do
		table.insert(ret, k)
	end
	table.sort(ret)
	return ret
end

local function getArgNums(args, prefix)
	local nums = {}
	for k, v in pairs(args) do
		local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
		if num then
			table.insert(nums, tonumber(num))
		end
	end
	table.sort(nums)
	return nums
end

--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------

local MessageBox = {}
MessageBox.__index = MessageBox

function MessageBox.new(boxType, args, cfg)
	args = args or {}
	local obj = {}

	-- Set the title object and the namespace.
	obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()

	-- Set the config for our box type.
	obj.cfg = cfg[boxType]
	if not obj.cfg then
		local ns = obj.title.namespace
		-- boxType is "mbox" or invalid input
		if args.demospace and args.demospace ~= '' then
			-- implement demospace parameter of mbox
			local demospace = string.lower(args.demospace)
			if DEMOSPACES[demospace] then
				-- use template from DEMOSPACES
				obj.cfg = cfg[DEMOSPACES[demospace]]
			elseif string.find( demospace, 'talk' ) then
				-- demo as a talk page
				obj.cfg = cfg.tmbox
			else
				-- default to ombox
				obj.cfg = cfg.ombox
			end
		elseif ns == 0 then
			obj.cfg = cfg.ambox -- main namespace
		elseif ns == 6 then
			obj.cfg = cfg.imbox -- file namespace
		elseif ns == 14 then
			obj.cfg = cfg.cmbox -- category namespace
		else
			local nsTable = mw.site.namespaces[ns]
			if nsTable and nsTable.isTalk then
				obj.cfg = cfg.tmbox -- any talk namespace
			else
				obj.cfg = cfg.ombox -- other namespaces or invalid input
			end
		end
	end

	-- Set the arguments, and remove all blank arguments except for the ones
	-- listed in cfg.allowBlankParams.
	do
		local newArgs = {}
		for k, v in pairs(args) do
			if v ~= '' then
				newArgs[k] = v
			end
		end
		for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
			newArgs[param] = args[param]
		end
		obj.args = newArgs
	end

	-- Define internal data structure.
	obj.categories = {}
	obj.classes = {}
	-- For lazy loading of [[Module:Category handler]].
	obj.hasCategories = false

	return setmetatable(obj, MessageBox)
end

function MessageBox:addCat(ns, cat, sort)
	if not cat then
		return nil
	end
	if sort then
		cat = string.format('[[Category:%s|%s]]', cat, sort)
	else
		cat = string.format('[[Category:%s]]', cat)
	end
	self.hasCategories = true
	self.categories[ns] = self.categories[ns] or {}
	table.insert(self.categories[ns], cat)
end

function MessageBox:addClass(class)
	if not class then
		return nil
	end
	table.insert(self.classes, class)
end

function MessageBox:setParameters()
	local args = self.args
	local cfg = self.cfg

	-- Get type data.
	self.type = args.type
	local typeData = cfg.types[self.type]
	self.invalidTypeError = cfg.showInvalidTypeError
		and self.type
		and not typeData
	typeData = typeData or cfg.types[cfg.default]
	self.typeClass = typeData.class
	self.typeImage = typeData.image
	self.typeImageNeedsLink = typeData.imageNeedsLink

	-- Find if the box has been wrongly substituted.
	self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'

	-- Find whether we are using a small message box.
	self.isSmall = cfg.allowSmall and (
		cfg.smallParam and args.small == cfg.smallParam
		or not cfg.smallParam and yesno(args.small)
	)

	-- Set the below row.
	self.below = cfg.below and args.below
	
	-- Add attributes, classes and styles.
	self.id = args.id
	self.name = args.name
	if self.name then
		self:addClass('box-' .. string.gsub(self.name,' ','_'))
	end
	if yesno(args.plainlinks) ~= false then
		self:addClass('plainlinks')
	end
	if self.below then
		self:addClass('mbox-with-below')
	end
	for _, class in ipairs(cfg.classes or {}) do
		self:addClass(class)
	end
	if self.isSmall then
		self:addClass(cfg.smallClass or 'mbox-small')
	end
	self:addClass(self.typeClass)
	self:addClass(args.class)
	self.style = args.style
	self.attrs = args.attrs

	-- Set text style.
	self.textstyle = args.textstyle

	-- Set image classes.
	self.imageRightClass = args.imagerightclass or args.imageclass
	self.imageLeftClass = args.imageleftclass or args.imageclass

	-- Find if we are on the template page or not. This functionality is only
	-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
	-- and cfg.templateCategoryRequireName are set.
	self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
	if self.useCollapsibleTextFields
		or cfg.templateCategory
		and cfg.templateCategoryRequireName
	then
		if self.name then
			local templateName = mw.ustring.match(
				self.name,
				'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
			) or self.name
			templateName = 'Template:' .. templateName
			self.templateTitle = getTitleObject(templateName)
		end
		self.isTemplatePage = self.templateTitle
			and mw.title.equals(self.title, self.templateTitle)
	end
	
	-- Process data for collapsible text fields. At the moment these are only
	-- used in {{ambox}}.
	if self.useCollapsibleTextFields then
		-- Get the self.issue value.
		if self.isSmall and args.smalltext then
			self.issue = args.smalltext
		else
			local sect
			if args.sect == '' then
				sect = 'This ' .. (cfg.sectionDefault or 'page')
			elseif type(args.sect) == 'string' then
				sect = 'This ' .. args.sect
			end
			local issue = args.issue
			issue = type(issue) == 'string' and issue ~= '' and issue or nil
			local text = args.text
			text = type(text) == 'string' and text or nil
			local issues = {}
			table.insert(issues, sect)
			table.insert(issues, issue)
			table.insert(issues, text)
			self.issue = table.concat(issues, ' ')
		end

		-- Get the self.talk value.
		local talk = args.talk
		-- Show talk links on the template page or template subpages if the talk
		-- parameter is blank.
		if talk == ''
			and self.templateTitle
			and (
				mw.title.equals(self.templateTitle, self.title)
				or self.title:isSubpageOf(self.templateTitle)
			)
		then
			talk = '#'
		elseif talk == '' then
			talk = nil
		end
		if talk then
			-- If the talk value is a talk page, make a link to that page. Else
			-- assume that it's a section heading, and make a link to the talk
			-- page of the current page with that section heading.
			local talkTitle = getTitleObject(talk)
			local talkArgIsTalkPage = true
			if not talkTitle or not talkTitle.isTalkPage then
				talkArgIsTalkPage = false
				talkTitle = getTitleObject(
					self.title.text,
					mw.site.namespaces[self.title.namespace].talk.id
				)
			end
			if talkTitle and talkTitle.exists then
                local talkText
                if self.isSmall then
                    local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. (talk == '#' and '' or '#') .. talk)
                    talkText = string.format('([[%s|talk]])', talkLink)
                else
                    talkText = 'Relevant discussion may be found on'
                    if talkArgIsTalkPage then
                        talkText = string.format(
                            '%s [[%s|%s]].',
                            talkText,
                            talk,
                            talkTitle.prefixedText
                        )
                    else
                        talkText = string.format(
                            '%s the [[%s' .. (talk == '#' and '' or '#') .. '%s|talk page]].',
                            talkText,
                            talkTitle.prefixedText,
                            talk
                        )
                    end
                end
				self.talk = talkText
			end
		end

		-- Get other values.
		self.fix = args.fix ~= '' and args.fix or nil
		local date
		if args.date and args.date ~= '' then
			date = args.date
		elseif args.date == '' and self.isTemplatePage then
			date = lang:formatDate('F Y')
		end
		if date then
			self.date = string.format(" <span class='date-container'><i>(<span class='date'>%s</span>)</i></span>", date)
		end
		self.info = args.info
		if yesno(args.removalnotice) then
			self.removalNotice = cfg.removalNotice
		end
	end

	-- Set the non-collapsible text field. At the moment this is used by all box
	-- types other than ambox, and also by ambox when small=yes.
	if self.isSmall then
		self.text = args.smalltext or args.text
	else
		self.text = args.text
	end

	-- General image settings.
	self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
	self.imageEmptyCell = cfg.imageEmptyCell

	-- Left image settings.
	local imageLeft = self.isSmall and args.smallimage or args.image
	if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
		or not cfg.imageCheckBlank and imageLeft ~= 'none'
	then
		self.imageLeft = imageLeft
		if not imageLeft then
			local imageSize = self.isSmall
				and (cfg.imageSmallSize or '30x30px')
				or '40x40px'
			self.imageLeft = string.format('[[File:%s|%s%s|alt=]]', self.typeImage
				or 'Information icon4.svg', imageSize, self.typeImageNeedsLink and "" or "|link=" )
		end
	end

	-- Right image settings.
	local imageRight = self.isSmall and args.smallimageright or args.imageright
	if not (cfg.imageRightNone and imageRight == 'none') then
		self.imageRight = imageRight
	end
	
	-- set templatestyles
	self.base_templatestyles = cfg.templatestyles
	self.templatestyles = args.templatestyles
end

function MessageBox:setMainspaceCategories()
	local args = self.args
	local cfg = self.cfg

	if not cfg.allowMainspaceCategories then
		return nil
	end

	local nums = {}
	for _, prefix in ipairs{'cat', 'category', 'all'} do
		args[prefix .. '1'] = args[prefix]
		nums = union(nums, getArgNums(args, prefix))
	end

	-- The following is roughly equivalent to the old {{Ambox/category}}.
	local date = args.date
	date = type(date) == 'string' and date
	local preposition = 'from'
	for _, num in ipairs(nums) do
		local mainCat = args['cat' .. tostring(num)]
			or args['category' .. tostring(num)]
		local allCat = args['all' .. tostring(num)]
		mainCat = type(mainCat) == 'string' and mainCat
		allCat = type(allCat) == 'string' and allCat
		if mainCat and date and date ~= '' then
			local catTitle = string.format('%s %s %s', mainCat, preposition, date)
			self:addCat(0, catTitle)
			catTitle = getTitleObject('Category:' .. catTitle)
			if not catTitle or not catTitle.exists then
				self:addCat(0, 'Articles with invalid date parameter in template')
			end
		elseif mainCat and (not date or date == '') then
			self:addCat(0, mainCat)
		end
		if allCat then
			self:addCat(0, allCat)
		end
	end
end

function MessageBox:setTemplateCategories()
	local args = self.args
	local cfg = self.cfg

	-- Add template categories.
	if cfg.templateCategory then
		if cfg.templateCategoryRequireName then
			if self.isTemplatePage then
				self:addCat(10, cfg.templateCategory)
			end
		elseif not self.title.isSubpage then
			self:addCat(10, cfg.templateCategory)
		end
	end

	-- Add template error categories.
	if cfg.templateErrorCategory then
		local templateErrorCategory = cfg.templateErrorCategory
		local templateCat, templateSort
		if not self.name and not self.title.isSubpage then
			templateCat = templateErrorCategory
		elseif self.isTemplatePage then
			local paramsToCheck = cfg.templateErrorParamsToCheck or {}
			local count = 0
			for i, param in ipairs(paramsToCheck) do
				if not args[param] then
					count = count + 1
				end
			end
			if count > 0 then
				templateCat = templateErrorCategory
				templateSort = tostring(count)
			end
			if self.categoryNums and #self.categoryNums > 0 then
				templateCat = templateErrorCategory
				templateSort = 'C'
			end
		end
		self:addCat(10, templateCat, templateSort)
	end
end

function MessageBox:setAllNamespaceCategories()
	-- Set categories for all namespaces.
	if self.invalidTypeError then
		local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
		self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
	end
	if self.isSubstituted then
		self:addCat('all', 'Pages with incorrectly substituted templates')
	end
end

function MessageBox:setCategories()
	if self.title.namespace == 0 then
		self:setMainspaceCategories()
	elseif self.title.namespace == 10 then
		self:setTemplateCategories()
	end
	self:setAllNamespaceCategories()
end

function MessageBox:renderCategories()
	if not self.hasCategories then
		-- No categories added, no need to pass them to Category handler so,
		-- if it was invoked, it would return the empty string.
		-- So we shortcut and return the empty string.
		return ""
	end
	-- Convert category tables to strings and pass them through
	-- [[Module:Category handler]].
	return require('Module:Category handler')._main{
		main = table.concat(self.categories[0] or {}),
		template = table.concat(self.categories[10] or {}),
		all = table.concat(self.categories.all or {}),
		nocat = self.args.nocat,
		page = self.args.page
	}
end

function MessageBox:exportDiv()
	local root = mw.html.create()

	-- Add the subst check error.
	if self.isSubstituted and self.name then
		root:tag('b')
			:addClass('error')
			:wikitext(string.format(
				'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
				mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
			))
	end

	local frame = mw.getCurrentFrame()
	root:wikitext(frame:extensionTag{
		name = 'templatestyles',
		args = { src = self.base_templatestyles },
	})
	-- Add support for a single custom templatestyles sheet. Undocumented as
	-- need should be limited and many templates using mbox are substed; we
	-- don't want to spread templatestyles sheets around to arbitrary places
	if self.templatestyles then
		root:wikitext(frame:extensionTag{
			name = 'templatestyles',
			args = { src = self.templatestyles },
		})
	end

	-- Create the box.
	local mbox = root:tag('div')
	mbox:attr('id', self.id or nil)
	for i, class in ipairs(self.classes or {}) do
		mbox:addClass(class or nil)
	end
	mbox
		:cssText(self.style or nil)

	if self.attrs then
		mbox:attr(self.attrs)
	end
	
	local flex_container
	if self.below then
		-- we need to wrap the flex components (`image(right)` and `text`) in their
		-- own container div to support the `below` parameter
		flex_container = mw.html.create('div')
		flex_container:addClass('mbox-flex')
	else
		-- the mbox itself is the parent, so we need no HTML flex_container
		flex_container = mw.html.create()
	end

	-- Add the left-hand image.
	if self.imageLeft then
		local imageLeftCell = flex_container:tag('div'):addClass('mbox-image')
		imageLeftCell
			:addClass(self.imageLeftClass)
			:wikitext(self.imageLeft or nil)
	end

	-- Add the text.
	local textCell = flex_container:tag('div'):addClass('mbox-text')
	if self.useCollapsibleTextFields then
		-- The message box uses advanced text parameters that allow things to be
		-- collapsible. At the moment, only ambox uses this.
		textCell:cssText(self.textstyle or nil)
		local textCellDiv = textCell:tag('div')
		textCellDiv
			:addClass('mbox-text-span')
			:wikitext(self.issue or nil)
		if (self.talk or self.fix) then
			textCellDiv:tag('span')
				:addClass('hide-when-compact')
				:wikitext(self.talk and (' ' .. self.talk) or nil)
				:wikitext(self.fix and (' ' .. self.fix) or nil)
		end
		textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
		if self.info and not self.isSmall then
			textCellDiv
				:tag('span')
				:addClass('hide-when-compact')
				:wikitext(self.info and (' ' .. self.info) or nil)
		end
		if self.removalNotice then
			textCellDiv:tag('span')
				:addClass('hide-when-compact')
				:tag('i')
					:wikitext(string.format(" (%s)", self.removalNotice))
		end
	else
		-- Default text formatting - anything goes.
		textCell
			:cssText(self.textstyle or nil)
			:wikitext(self.text or nil)
	end

	-- Add the right-hand image.
	if self.imageRight then
		local imageRightCell = flex_container:tag('div'):addClass('mbox-imageright')
		imageRightCell
			:addClass(self.imageRightClass)
			:wikitext(self.imageRight or nil)
	end
	
	mbox:node(flex_container)

	-- Add the below row.
	if self.below then
		mbox:tag('div')
			:addClass('mbox-text mbox-below')
			:cssText(self.textstyle or nil)
			:wikitext(self.below or nil)
	end

	-- Add error message for invalid type parameters.
	if self.invalidTypeError then
		root:tag('div')
			:addClass('mbox-invalid-type')
			:wikitext(string.format(
				'This message box is using an invalid "type=%s" parameter and needs fixing.',
				self.type or ''
			))
	end

	-- Add categories.
	root:wikitext(self:renderCategories() or nil)

	return tostring(root)
end

function MessageBox:export()

	local root = mw.html.create()

	-- Add the subst check error.
	if self.isSubstituted and self.name then
		root:tag('b')
			:addClass('error')
			:wikitext(string.format(
				'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
				mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
			))
	end

	local frame = mw.getCurrentFrame()
	root:wikitext(frame:extensionTag{
		name = 'templatestyles',
		args = { src = self.base_templatestyles },
	})
	-- Add support for a single custom templatestyles sheet. Undocumented as
	-- need should be limited and many templates using mbox are substed; we
	-- don't want to spread templatestyles sheets around to arbitrary places
	if self.templatestyles then
		root:wikitext(frame:extensionTag{
			name = 'templatestyles',
			args = { src = self.templatestyles },
		})
	end

	-- Create the box table.
	local boxTable = root:tag('table')
	boxTable:attr('id', self.id or nil)
	for i, class in ipairs(self.classes or {}) do
		boxTable:addClass(class or nil)
	end
	boxTable
		:cssText(self.style or nil)
		:attr('role', 'presentation')

	if self.attrs then
		boxTable:attr(self.attrs)
	end

	-- Add the left-hand image.
	local row = boxTable:tag('tr')
	if self.imageLeft then
		local imageLeftCell = row:tag('td'):addClass('mbox-image')
		if self.imageCellDiv then
			-- If we are using a div, redefine imageLeftCell so that the image
			-- is inside it. Divs use style="width: 52px;", which limits the
			-- image width to 52px. If any images in a div are wider than that,
			-- they may overlap with the text or cause other display problems.
			imageLeftCell = imageLeftCell:tag('div'):addClass('mbox-image-div')
		end
		imageLeftCell
			:addClass(self.imageLeftClass)
			:wikitext(self.imageLeft or nil)
	elseif self.imageEmptyCell then
		-- Some message boxes define an empty cell if no image is specified, and
		-- some don't. The old template code in templates where empty cells are
		-- specified gives the following hint: "No image. Cell with some width
		-- or padding necessary for text cell to have 100% width."
		row:tag('td')
			:addClass('mbox-empty-cell')
	end

	-- Add the text.
	local textCell = row:tag('td'):addClass('mbox-text')
	if self.useCollapsibleTextFields then
		-- The message box uses advanced text parameters that allow things to be
		-- collapsible. At the moment, only ambox uses this.
		textCell:cssText(self.textstyle or nil)
		local textCellDiv = textCell:tag('div')
		textCellDiv
			:addClass('mbox-text-span')
			:wikitext(self.issue or nil)
		if (self.talk or self.fix) then
			textCellDiv:tag('span')
				:addClass('hide-when-compact')
				:wikitext(self.talk and (' ' .. self.talk) or nil)
				:wikitext(self.fix and (' ' .. self.fix) or nil)
		end
		textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
		if self.info and not self.isSmall then
			textCellDiv
				:tag('span')
				:addClass('hide-when-compact')
				:wikitext(self.info and (' ' .. self.info) or nil)
		end
		if self.removalNotice then
			textCellDiv:tag('span')
				:addClass('hide-when-compact')
				:tag('i')
					:wikitext(string.format(" (%s)", self.removalNotice))
		end
	else
		-- Default text formatting - anything goes.
		textCell
			:cssText(self.textstyle or nil)
			:wikitext(self.text or nil)
	end

	-- Add the right-hand image.
	if self.imageRight then
		local imageRightCell = row:tag('td'):addClass('mbox-imageright')
		if self.imageCellDiv then
			-- If we are using a div, redefine imageRightCell so that the image
			-- is inside it.
			imageRightCell = imageRightCell:tag('div'):addClass('mbox-image-div')
		end
		imageRightCell
			:addClass(self.imageRightClass)
			:wikitext(self.imageRight or nil)
	end

	-- Add the below row.
	if self.below then
		boxTable:tag('tr')
			:tag('td')
				:attr('colspan', self.imageRight and '3' or '2')
				:addClass('mbox-text')
				:cssText(self.textstyle or nil)
				:wikitext(self.below or nil)
	end

	-- Add error message for invalid type parameters.
	if self.invalidTypeError then
		root:tag('div')
			:addClass('mbox-invalid-type')
			:wikitext(string.format(
				'This message box is using an invalid "type=%s" parameter and needs fixing.',
				self.type or ''
			))
	end

	-- Add categories.
	root:wikitext(self:renderCategories() or nil)

	return tostring(root)
end

--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------

local p, mt = {}, {}

function p._exportClasses()
	-- For testing.
	return {
		MessageBox = MessageBox
	}
end

function p.main(boxType, args, cfgTables)
	local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE))
	box:setParameters()
	box:setCategories()
	-- DIV MIGRATION CONDITIONAL
	if box.cfg.div_structure then
		return box:exportDiv()
	end
	-- END DIV MIGRATION CONDITIONAL
	return box:export()
end

function mt.__index(t, k)
	return function (frame)
		if not getArgs then
			getArgs = require('Module:Arguments').getArgs
		end
		return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
	end
end

return setmetatable(p, mt)