Difference between revisions of ":Message box"

From MediaWiki
Jump to: navigation, search
m (1 revision: Ref support copy from Wikipedia)
(bring in changes from sandbox)
Line 2: Line 2:
 
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
 
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
  
−
-- Require necessary modules.
+
-- Load necessary modules.
−
local getArgs = require('Module:Arguments').getArgs
+
require('Module:No globals')
−
local htmlBuilder = require('Module:HtmlBuilder')
+
local getArgs
−
local categoryHandler = require('Module:Category handler').main
+
local categoryHandler = require('Module:Category handler')._main
 
local yesno = require('Module:Yesno')
 
local yesno = require('Module:Yesno')
−
 
−
-- Load the configuration page.
 
−
local cfgTables = mw.loadData('Module:Message box/configuration')
 
  
 
-- Get a language object for formatDate and ucfirst.
 
-- Get a language object for formatDate and ucfirst.
 
local lang = mw.language.getContentLanguage()
 
local lang = mw.language.getContentLanguage()
−
 
−
-- Set aliases for often-used functions to reduce table lookups.
 
−
local format = mw.ustring.format
 
−
local tinsert = table.insert
 
−
local tconcat = table.concat
 
−
local trim = mw.text.trim
 
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
Line 24: Line 15:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local function getTitleObject(page, ...)
+
local function getTitleObject(...)
−
if type(page) == 'string' then
+
-- Get the title object, passing the function through pcall
−
-- Get the title object, passing the function through pcall  
+
-- in case we are over the expensive function count limit.
−
-- in case we are over the expensive function count limit.
+
local success, title = pcall(mw.title.new, ...)
−
local success, title = pcall(mw.title.new, page, ...)
+
if success then
−
if success then
+
return title
−
return title
+
−
end
+
 
end
 
end
 
end
 
end
Line 46: Line 35:
 
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)
Line 57: Line 46:
 
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
Line 68: Line 57:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local box = {}
+
local MessageBox = {}
−
box.__index = box
+
MessageBox.__index = MessageBox
  
−
function box.new()
+
function MessageBox.new(boxType, args, cfg)
 +
args = args or {}
 
local obj = {}
 
local obj = {}
−
setmetatable(obj, box)
 
−
return obj
 
−
end
 
  
−
function box.getNamespaceId(ns)
+
-- Set the title object and the namespace.
−
if not ns then return end
+
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
−
if type(ns) == 'string' then
+
−
ns = lang:ucfirst(mw.ustring.lower(ns))
+
−
if ns == 'Main' then
+
−
ns = 0
+
−
end
+
−
end
+
−
local nsTable = mw.site.namespaces[ns]
+
−
if nsTable then
+
−
return nsTable.id
+
−
end
+
−
end
+
  
−
function box.getMboxType(nsid)
+
-- Set the config for our box type.
−
-- Gets the mbox type from a namespace number.
+
obj.cfg = cfg[boxType]
−
if nsid == 0 then
+
if not obj.cfg then
−
return 'ambox' -- main namespace
+
local ns = obj.title.namespace
−
elseif nsid == 6 then
+
-- boxType is "mbox" or invalid input
−
return 'imbox' -- file namespace
+
if ns == 0 then
−
elseif nsid == 14 then
+
obj.cfg = cfg.ambox -- main namespace
−
return 'cmbox' -- category namespace
+
elseif ns == 6 then
−
else
+
obj.cfg = cfg.imbox -- file namespace
−
local nsTable = mw.site.namespaces[nsid]
+
elseif ns == 14 then
−
if nsTable and nsTable.isTalk then
+
obj.cfg = cfg.cmbox -- category namespace
−
return 'tmbox' -- any talk namespace
+
 
else
 
else
−
return 'ombox' -- other namespaces or invalid input
+
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
 
end
 
end
−
end
 
  
−
function box:addCat(ns, cat, sort)
+
-- Set the arguments, and remove all blank arguments except for the ones
−
if type(cat) ~= 'string' then return end
+
-- listed in cfg.allowBlankParams.
−
local nsVals = {'main', 'template', 'all'}
+
do
−
local tname
+
local newArgs = {}
−
for i, val in ipairs(nsVals) do
+
for k, v in pairs(args) do
−
if ns == val then
+
if v ~= '' then
−
tname = ns .. 'Cats'
+
newArgs[k] = v
 +
end
 
end
 
end
−
end
+
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
−
if not tname then
+
newArgs[param] = args[param]
−
for i, val in ipairs(nsVals) do
+
−
nsVals[i] = format('"%s"', val)
+
 
end
 
end
−
error(
+
obj.args = newArgs
−
'invalid ns parameter passed to box:addCat; valid values are '
+
−
.. mw.text.listToText(nsVals, nil, ' or ')
+
−
)
+
 
end
 
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
 
  
−
function box:addClass(class)
+
-- Define internal data structure.
−
if type(class) ~= 'string' then return end
+
obj.categories = {}
−
self.classes = self.classes or {}
+
obj.classes = {}
−
tinsert(self.classes, class)
+
−
end
+
  
−
function box:addAttr(attr, val)
+
return setmetatable(obj, MessageBox)
−
if type(attr) ~= 'string' or type(val) ~= 'string' then return end
+
−
self.attrs = self.attrs or {}
+
−
tinsert(self.attrs, attr)
+
 
end
 
end
  
−
function box:setTitle(args)
+
function MessageBox:addCat(ns, cat, sort)
−
-- Get the title object and the namespace.
+
if not cat then
−
self.pageTitle = getTitleObject(args.page ~= '' and args.page)
+
return nil
−
self.title = self.pageTitle or mw.title.getCurrentTitle()
+
−
self.demospace = args.demospace ~= '' and args.demospace or nil
+
−
self.nsid = box.getNamespaceId(self.demospace) or self.title.namespace
+
−
end
+
−
 
+
−
function box:getConfig(boxType)
+
−
-- Get the box config data from the data page.
+
−
if boxType == 'mbox' then
+
−
boxType = box.getMboxType(self.nsid)
+
 
end
 
end
−
local cfg = cfgTables[boxType]
+
if sort then
−
if not cfg then
+
cat = string.format('[[Category:%s|%s]]', cat, sort)
−
local boxTypes = {}
+
else
−
for k, v in pairs(dataTables) do
+
cat = string.format('[[Category:%s]]', cat)
−
tinsert(boxTypes, format('"%s"', k))
+
−
end
+
−
tinsert(boxTypes, '"mbox"')
+
−
error(format(
+
−
'invalid message box type "%s"; valid types are %s',
+
−
tostring(boxType),
+
−
mw.text.listToText(boxTypes)
+
−
), 2)
+
 
end
 
end
−
return cfg
+
self.categories[ns] = self.categories[ns] or {}
 +
table.insert(self.categories[ns], cat)
 
end
 
end
  
−
function box:removeBlankArgs(cfg, args)
+
function MessageBox:addClass(class)
−
-- Only allow blank arguments for the parameter names listed in
+
if not class then
−
-- cfg.allowBlankParams.
+
return nil
−
local newArgs = {}
+
−
for k, v in pairs(args) do
+
−
if v ~= '' then
+
−
newArgs[k] = v
+
−
end
+
−
end
+
−
for i, param in ipairs(cfg.allowBlankParams or {}) do
+
−
newArgs[param] = args[param]
+
 
end
 
end
−
return newArgs
+
table.insert(self.classes, class)
 
end
 
end
  
−
function box:setBoxParameters(cfg, args)
+
function MessageBox:setParameters()
 +
local args = self.args
 +
local cfg = self.cfg
 +
 
 
-- Get type data.
 
-- Get type data.
 
self.type = args.type
 
self.type = args.type
Line 198: Line 140:
 
and self.type
 
and self.type
 
and not typeData
 
and not typeData
−
and true
 
−
or false
 
 
typeData = typeData or cfg.types[cfg.default]
 
typeData = typeData or cfg.types[cfg.default]
 
self.typeClass = typeData.class
 
self.typeClass = typeData.class
Line 205: Line 145:
  
 
-- Find if the box has been wrongly substituted.
 
-- Find if the box has been wrongly substituted.
−
if cfg.substCheck and args.subst == 'SUBST' then
+
self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'
−
self.isSubstituted = true
+
−
end
+
  
 
-- Find whether we are using a small message box.
 
-- Find whether we are using a small message box.
−
if cfg.allowSmall and (
+
self.isSmall = cfg.allowSmall and (
 
cfg.smallParam and args.small == cfg.smallParam
 
cfg.smallParam and args.small == cfg.smallParam
 
or not cfg.smallParam and yesno(args.small)
 
or not cfg.smallParam and yesno(args.small)
 
)
 
)
−
then
 
−
self.isSmall = true
 
−
else
 
−
self.isSmall = false
 
−
end
 
  
 
-- Add attributes, classes and styles.
 
-- Add attributes, classes and styles.
Line 260: Line 193:
 
self.isTemplatePage = self.templateTitle
 
self.isTemplatePage = self.templateTitle
 
and mw.title.equals(self.title, self.templateTitle)
 
and mw.title.equals(self.title, self.templateTitle)
−
or false
 
 
end
 
end
  
Line 281: Line 213:
 
text = type(text) == 'string' and text or nil
 
text = type(text) == 'string' and text or nil
 
local issues = {}
 
local issues = {}
−
tinsert(issues, sect)
+
table.insert(issues, sect)
−
tinsert(issues, issue)
+
table.insert(issues, issue)
−
tinsert(issues, text)
+
table.insert(issues, text)
−
self.issue = tconcat(issues, ' ')
+
self.issue = table.concat(issues, ' ')
 
end
 
end
  
Line 292: Line 224:
 
-- parameter is blank.
 
-- parameter is blank.
 
if talk == ''
 
if talk == ''
−
and self.templateTitle  
+
and self.templateTitle
 
and (
 
and (
 
mw.title.equals(self.templateTitle, self.title)
 
mw.title.equals(self.templateTitle, self.title)
Line 318: Line 250:
 
local talkText = 'Relevant discussion may be found on'
 
local talkText = 'Relevant discussion may be found on'
 
if talkArgIsTalkPage then
 
if talkArgIsTalkPage then
−
talkText = format(
+
talkText = string.format(
 
'%s [[%s|%s]].',
 
'%s [[%s|%s]].',
 
talkText,
 
talkText,
Line 325: Line 257:
 
)
 
)
 
else
 
else
−
talkText = format(
+
talkText = string.format(
 
'%s the [[%s#%s|talk page]].',
 
'%s the [[%s#%s|talk page]].',
 
talkText,
 
talkText,
Line 345: Line 277:
 
end
 
end
 
if date then
 
if date then
−
self.date = format(" <small>''(%s)''</small>", date)
+
self.date = string.format(" <small>''(%s)''</small>", date)
 
end
 
end
 
self.info = args.info
 
self.info = args.info
Line 362: Line 294:
  
 
-- General image settings.
 
-- General image settings.
−
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
+
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
 
self.imageEmptyCell = cfg.imageEmptyCell
 
self.imageEmptyCell = cfg.imageEmptyCell
 
if cfg.imageEmptyCellStyle then
 
if cfg.imageEmptyCellStyle then
Line 378: Line 310:
 
and (cfg.imageSmallSize or '30x30px')
 
and (cfg.imageSmallSize or '30x30px')
 
or '40x40px'
 
or '40x40px'
−
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage
+
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
 
or 'Imbox notice.png', imageSize)
 
or 'Imbox notice.png', imageSize)
 
end
 
end
Line 388: Line 320:
 
self.imageRight = imageRight
 
self.imageRight = imageRight
 
end
 
end
 +
end
  
−
-- Add mainspace categories. At the moment these are only used in {{ambox}}.
+
function MessageBox:setMainspaceCategories()
−
if cfg.allowMainspaceCategories then
+
local args = self.args
−
if args.cat then
+
local cfg = self.cfg
−
args.cat1 = args.cat
+
 
−
end
+
if not cfg.allowMainspaceCategories then
−
self.catNums = getArgNums(args, 'cat')
+
return nil
−
if args.category then
+
end
−
args.category1 = args.category
+
 
−
end
+
local nums = {}
−
self.categoryNums = getArgNums(args, 'category')
+
for _, prefix in ipairs{'cat', 'category', 'all'} do
−
if args.all then
+
args[prefix .. '1'] = args[prefix]
−
args.all1 = args.all
+
nums = union(nums, getArgNums(args, prefix))
−
end
+
end
−
self.allNums = getArgNums(args, 'all')
+
 
−
self.categoryParamNums = union(self.catNums, self.categoryNums)
+
-- The following is roughly equivalent to the old {{Ambox/category}}.
−
self.categoryParamNums = union(self.categoryParamNums, self.allNums)
+
local date = args.date
−
-- The following is roughly equivalent to the old {{Ambox/category}}.
+
date = type(date) == 'string' and date
−
local date = args.date
+
local preposition = 'from'
−
date = type(date) == 'string' and date
+
for _, num in ipairs(nums) do
−
local preposition = 'from'
+
local mainCat = args['cat' .. tostring(num)]
−
for _, num in ipairs(self.categoryParamNums) do
+
or args['category' .. tostring(num)]
−
local mainCat = args['cat' .. tostring(num)]
+
local allCat = args['all' .. tostring(num)]
−
or args['category' .. tostring(num)]
+
mainCat = type(mainCat) == 'string' and mainCat
−
local allCat = args['all' .. tostring(num)]
+
allCat = type(allCat) == 'string' and allCat
−
mainCat = type(mainCat) == 'string' and mainCat
+
if mainCat and date and date ~= '' then
−
allCat = type(allCat) == 'string' and allCat
+
local catTitle = string.format('%s %s %s', mainCat, preposition, date)
−
if mainCat and date and date ~= '' then
+
self:addCat(0, catTitle)
−
local catTitle = format('%s %s %s', mainCat, preposition, date)
+
catTitle = getTitleObject('Category:' .. catTitle)
−
self:addCat('main', catTitle)
+
if not catTitle or not catTitle.exists then
−
catTitle = getTitleObject('Category:' .. catTitle)
+
self:addCat(0, 'Articles with invalid date parameter in template')
−
if not catTitle or not catTitle.exists then
+
−
self:addCat(
+
−
'main',
+
−
'Articles with invalid date parameter in template'
+
−
)
+
−
end
+
−
elseif mainCat and (not date or date == '') then
+
−
self:addCat('main', mainCat)
+
−
end
+
−
if allCat then
+
−
self:addCat('main', allCat)
+
 
end
 
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
 +
end
 +
 +
function MessageBox:setTemplateCategories()
 +
local args = self.args
 +
local cfg = self.cfg
  
−
-- Add template-namespace categories.
+
-- Add template categories.
 
if cfg.templateCategory then
 
if cfg.templateCategory then
 
if cfg.templateCategoryRequireName then
 
if cfg.templateCategoryRequireName then
 
if self.isTemplatePage then
 
if self.isTemplatePage then
−
self:addCat('template', cfg.templateCategory)
+
self:addCat(10, cfg.templateCategory)
 
end
 
end
 
elseif not self.title.isSubpage then
 
elseif not self.title.isSubpage then
−
self:addCat('template', cfg.templateCategory)
+
self:addCat(10, cfg.templateCategory)
 
end
 
end
 
end
 
end
  
−
-- Add template error category.
+
-- Add template error categories.
 
if cfg.templateErrorCategory then
 
if cfg.templateErrorCategory then
 
local templateErrorCategory = cfg.templateErrorCategory
 
local templateErrorCategory = cfg.templateErrorCategory
Line 468: Line 400:
 
end
 
end
 
end
 
end
−
self:addCat('template', templateCat, templateSort)
+
self:addCat(10, templateCat, templateSort)
 
end
 
end
 +
end
  
−
-- Categories for all namespaces.
+
function MessageBox:setAllNamespaceCategories()
 +
-- Set categories for all namespaces.
 
if self.invalidTypeError then
 
if self.invalidTypeError then
−
local allSort = (self.nsid == 0 and 'Main:' or '') .. self.title.prefixedText
+
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
 
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
 
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
 
end
 
end
Line 479: Line 413:
 
self:addCat('all', 'Pages with incorrectly substituted templates')
 
self:addCat('all', 'Pages with incorrectly substituted templates')
 
end
 
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()
 
-- Convert category tables to strings and pass them through
 
-- Convert category tables to strings and pass them through
 
-- [[Module:Category handler]].
 
-- [[Module:Category handler]].
−
self.categories = categoryHandler{
+
return categoryHandler{
−
main = tconcat(self.mainCats or {}),
+
main = table.concat(self.categories[0] or {}),
−
template = tconcat(self.templateCats or {}),
+
template = table.concat(self.categories[10] or {}),
−
all = tconcat(self.allCats or {}),
+
all = table.concat(self.categories.all or {}),
−
nocat = args.nocat,
+
nocat = self.args.nocat,
−
demospace = self.demospace,
+
page = self.args.page
−
page = self.pageTitle and self.pageTitle.prefixedText or nil
+
 
}
 
}
 
end
 
end
  
−
function box:export()
+
function MessageBox:export()
−
local root = htmlBuilder.create()
+
local root = mw.html.create()
  
 
-- Add the subst check error.
 
-- Add the subst check error.
 
if self.isSubstituted and self.name then
 
if self.isSubstituted and self.name then
−
root
+
root:tag('b')
−
.tag('b')
+
:addClass('error')
−
.addClass('error')
+
:wikitext(string.format(
−
.wikitext(format(
+
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
−
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
+
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
−
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
+
))
−
))
+
 
end
 
end
  
 
-- Create the box table.
 
-- Create the box table.
−
local boxTable = root.tag('table')
+
local boxTable = root:tag('table')
−
boxTable
+
boxTable:attr('id', self.id or nil)
−
.attr('id', self.id)
+
 
for i, class in ipairs(self.classes or {}) do
 
for i, class in ipairs(self.classes or {}) do
−
boxTable
+
boxTable:addClass(class or nil)
−
.addClass(class)
+
 
end
 
end
 
boxTable
 
boxTable
−
.cssText(self.style)
+
:cssText(self.style or nil)
−
.attr('role', 'presentation')
+
:attr('role', 'presentation')
−
for attr, val in pairs(self.attrs or {}) do
+
 
−
boxTable
+
if self.attrs then
−
.attr(attr, val)
+
boxTable:attr(self.attrs)
 
end
 
end
  
 
-- Add the left-hand image.
 
-- Add the left-hand image.
−
local row = boxTable.tag('tr')
+
local row = boxTable:tag('tr')
 
if self.imageLeft then
 
if self.imageLeft then
−
local imageLeftCell = row.tag('td').addClass('mbox-image')
+
local imageLeftCell = row:tag('td'):addClass('mbox-image')
 
if self.imageCellDiv then
 
if self.imageCellDiv then
 
-- If we are using a div, redefine imageLeftCell so that the image
 
-- If we are using a div, redefine imageLeftCell so that the image
Line 531: Line 472:
 
-- image width to 52px. If any images in a div are wider than that,
 
-- 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.
 
-- they may overlap with the text or cause other display problems.
−
imageLeftCell = imageLeftCell.tag('div').css('width', '52px')  
+
imageLeftCell = imageLeftCell:tag('div'):css('width', '52px')
 
end
 
end
−
imageLeftCell
+
imageLeftCell:wikitext(self.imageLeft or nil)
−
.wikitext(self.imageLeft)
+
 
elseif self.imageEmptyCell then
 
elseif self.imageEmptyCell then
 
-- Some message boxes define an empty cell if no image is specified, and
 
-- Some message boxes define an empty cell if no image is specified, and
Line 540: Line 480:
 
-- specified gives the following hint: "No image. Cell with some width
 
-- specified gives the following hint: "No image. Cell with some width
 
-- or padding necessary for text cell to have 100% width."
 
-- or padding necessary for text cell to have 100% width."
−
row.tag('td')
+
row:tag('td')
−
.addClass('mbox-empty-cell')  
+
:addClass('mbox-empty-cell')
−
.cssText(self.imageEmptyCellStyle)
+
:cssText(self.imageEmptyCellStyle or nil)
 
end
 
end
  
 
-- Add the text.
 
-- Add the text.
−
local textCell = row.tag('td').addClass('mbox-text')
+
local textCell = row:tag('td'):addClass('mbox-text')
 
if self.useCollapsibleTextFields then
 
if self.useCollapsibleTextFields then
 
-- The message box uses advanced text parameters that allow things to be
 
-- The message box uses advanced text parameters that allow things to be
 
-- collapsible. At the moment, only ambox uses this.
 
-- collapsible. At the moment, only ambox uses this.
−
textCell
+
textCell:cssText(self.textstyle or nil)
−
.cssText(self.textstyle)
+
local textCellSpan = textCell:tag('span')
−
local textCellSpan = textCell.tag('span')
+
 
textCellSpan
 
textCellSpan
−
.addClass('mbox-text-span')
+
:addClass('mbox-text-span')
−
.wikitext(self.issue)
+
:wikitext(self.issue or nil)
 
if not self.isSmall then
 
if not self.isSmall then
−
textCellSpan
+
textCellSpan:tag('span')
−
.tag('span')
+
:addClass('hide-when-compact')
−
.addClass('hide-when-compact')
+
:wikitext(self.talk and (' ' .. self.talk) or nil)
−
.wikitext(self.talk and ' ' .. self.talk)
+
:wikitext(self.fix and (' ' .. self.fix) or nil)
−
.wikitext(self.fix and ' ' .. self.fix)
+
 
end
 
end
−
textCellSpan
+
textCellSpan:wikitext(self.date and (' ' .. self.date) or nil)
−
.wikitext(self.date and ' ' .. self.date)
+
 
if not self.isSmall then
 
if not self.isSmall then
 
textCellSpan
 
textCellSpan
−
.tag('span')
+
:tag('span')
−
.addClass('hide-when-compact')
+
:addClass('hide-when-compact')
−
.wikitext(self.info and ' ' .. self.info)
+
:wikitext(self.info and (' ' .. self.info) or nil)
 
end
 
end
 
else
 
else
 
-- Default text formatting - anything goes.
 
-- Default text formatting - anything goes.
 
textCell
 
textCell
−
.cssText(self.textstyle)
+
:cssText(self.textstyle or nil)
−
.wikitext(self.text)
+
:wikitext(self.text or nil)
 
end
 
end
  
 
-- Add the right-hand image.
 
-- Add the right-hand image.
 
if self.imageRight then
 
if self.imageRight then
−
local imageRightCell = row.tag('td').addClass('mbox-imageright')
+
local imageRightCell = row:tag('td'):addClass('mbox-imageright')
 
if self.imageCellDiv then
 
if self.imageCellDiv then
 
-- If we are using a div, redefine imageRightCell so that the image
 
-- If we are using a div, redefine imageRightCell so that the image
 
-- is inside it.
 
-- is inside it.
−
imageRightCell = imageRightCell.tag('div').css('width', '52px')
+
imageRightCell = imageRightCell:tag('div'):css('width', '52px')
 
end
 
end
 
imageRightCell
 
imageRightCell
−
.wikitext(self.imageRight)
+
:wikitext(self.imageRight or nil)
 
end
 
end
  
 
-- Add the below row.
 
-- Add the below row.
 
if self.below then
 
if self.below then
−
boxTable.tag('tr')
+
boxTable:tag('tr')
−
.tag('td')
+
:tag('td')
−
.attr('colspan', self.imageRight and '3' or '2')
+
:attr('colspan', self.imageRight and '3' or '2')
−
.addClass('mbox-text')
+
:addClass('mbox-text')
−
.cssText(self.textstyle)
+
:cssText(self.textstyle or nil)
−
.wikitext(self.below)
+
:wikitext(self.below or nil)
 
end
 
end
  
 
-- Add error message for invalid type parameters.
 
-- Add error message for invalid type parameters.
 
if self.invalidTypeError then
 
if self.invalidTypeError then
−
root
+
root:tag('div')
−
.tag('div')
+
:css('text-align', 'center')
−
.css('text-align', 'center')
+
:wikitext(string.format(
−
.wikitext(format(
+
'This message box is using an invalid "type=%s" parameter and needs fixing.',
−
'This message box is using an invalid "type=%s" parameter and needs fixing.',
+
self.type or ''
−
self.type or ''
+
))
−
))
+
 
end
 
end
  
 
-- Add categories.
 
-- Add categories.
−
root
+
root:wikitext(self:renderCategories() or nil)
−
.wikitext(self.categories)
+
  
 
return tostring(root)
 
return tostring(root)
 
end
 
end
  
−
local function main(boxType, args)
+
--------------------------------------------------------------------------------
−
local outputBox = box.new()
+
-- Exports
−
outputBox:setTitle(args)
+
--------------------------------------------------------------------------------
−
local cfg = outputBox:getConfig(boxType)
+
 
−
args = outputBox:removeBlankArgs(cfg, args)
+
local p, mt = {}, {}
−
outputBox:setBoxParameters(cfg, args)
+
 
−
return outputBox:export()
+
function p._exportClasses()
 +
-- For testing.
 +
return {
 +
MessageBox = MessageBox
 +
}
 
end
 
end
  
−
local function makeWrapper(boxType)
+
function p.main(boxType, args, cfgTables)
−
return function (frame)
+
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData('Module:Message box/configuration'))
−
local args = getArgs(frame, {trim = false, removeBlanks = false})
+
box:setParameters()
−
return main(boxType, args)
+
box:setCategories()
−
end
+
return box:export()
 
end
 
end
  
−
local p = {
+
function mt.__index(t, k)
−
main = main,
+
return function (frame)
−
mbox = makeWrapper('mbox')
+
if not getArgs then
−
}
+
getArgs = require('Module:Arguments').getArgs
−
 
+
end
−
for boxType in pairs(cfgTables) do
+
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
−
p[boxType] = makeWrapper(boxType)
+
end
 
end
 
end
  
−
return p
+
return setmetatable(p, mt)

Revision as of 04:56, 30 November 2014

-- This is a meta-module for producing message box templates, including -- {{#invoke:Message box|mbox}}, {{#ifeq:{{{subst}}}|SUBST 

|{{#if:
 |<{{#switch:{{{tag}}}
|p=p
|span=span
|div=div
|#default=strong

}} class="error">Template {{{{#if: |subst:}}[[Template:{{{name}}}|{{{name}}}]]{{#if: ||{{{2}}}}}{{#if: ||{{{3}}}}}{{#if: ||{{{4}}}}}{{#if: ||{{{5}}}}}{{#if: ||{{{6}}}}}{{#if: ||{{{7}}}}}{{#if: ||{{{8}}}}}{{#if: ||{{{9}}}}}{{#if: ||{{{10}}}}}{{#if: ||{{{11}}}}}{{#if: ||…}}}} has been incorrectly substituted.</{{#switch:{{{tag}}} 

|p=p
|span=span
|div=div
|#default=strong

}}> 

}}

}}{{Ambox/{{#ifeq:{{{small}}}|left|small|core}} 

|type = 
|image = 
|smallimage = {{#if:|{{{smallimage}}}|}}
|imageright = 
|smallimageright = {{#if:|{{{smallimageright}}}|}}
|class = ambox-{{#switch:
 |speedy = speedy
 |delete = delete
 |content = content
 |style = style
 |move = move
 |protection = protection
 |notice|#default = notice
}} 
|style = 
|textstyle  = 
|smalltext  = 
|talk = {{#switch:¬
 |¬        = 
 |         = {{#ifeq:{{ safesubst:#if: {{safesubst:#invoke:Ns has subpages|main}} 
 | {{ safesubst:#titleparts:{{ safesubst:#if:|{{{1}}}|:Message box}}|1}}
 | {{ safesubst:#if:|{{{1}}}|:Message box}}

}}|Template:|#}} 

 |#default = {{{talk}}}
}}
|issue = {{#switch:¬
 |¬ = 
 |  = This article
 |This {{{sect}}}
}}  
|fix = 
|date = {{#switch:¬
 |¬        = 
 |         = {{#ifeq:{{ safesubst:#if: {{safesubst:#invoke:Ns has subpages|main}} 
 | {{ safesubst:#titleparts:{{ safesubst:#if:|{{{1}}}|:Message box}}|1}}
 | {{ safesubst:#if:|{{{1}}}|:Message box}}

}}|Template:|December 2024}} 

 |#default = {{{date}}}
}}
|info =

}}{{#if: 

 {{#ifeq:  | true
 | dontcat    
 }}{{#ifeq:  | no
 | dontcat
 }}{{#switch: ¬
 | yes
 | ¬   =   
 | #default = dontcat   
 }}{{#switch: 
 | no = 
   {{#switch:
 {{#if:
 | {{#if:{{#titleparts:|0|3}}
   | subsubpage    
   | {{#if:{{#titleparts:|0|2}}
     | subpage
     | basepage
     }}
   }}
 | {{#if:{{#titleparts::Message box|0|3}}
   | subsubpage    
   | {{#if:{{#titleparts::Message box|0|2}}
     | subpage
     | basepage
     }}
   }}
 }}

| basepage =

| subpage = dontcat

| subsubpage = dontcat

}} 

 | only = 
   {{#switch:
 {{#if:
 | {{#if:{{#titleparts:|0|3}}
   | subsubpage    
   | {{#if:{{#titleparts:|0|2}}
     | subpage
     | basepage
     }}
   }}
 | {{#if:{{#titleparts::Message box|0|3}}
   | subsubpage    
   | {{#if:{{#titleparts::Message box|0|2}}
     | subpage
     | basepage
     }}
   }}
 }}

| basepage = dontcat

| subpage = | subsubpage = }} 

 }}

| | 

 {{#switch:
   {{#ifeq:  | false
   |   
   | {{#ifeq:  | yes
     |   
     | {{#ifeq:  | yes
       |   
       | {{#if:x

| 


     {{#if:{{#titleparts:{{#if:|  | :Message box }}|0|2}}
     | 
        
          
            
              
                
                       
                 
               
             
           
         
       
     | 
             
       
     }}

}} 

       }}
     }}
   }}
 | hide = 
 | #default  = 
   {{#ifeq: h0#384!5nea+w9 |  {{#if:
|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}} 

   | 
     {{#switch:
 {{#if: 
   | {{{demospace}}}
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     }}
   }}

| main | = | talk = | user = | wikipedia = | file | image = | mediawiki = | template = | help = | category = | portal = | book = | other | #default =

}} 

   | 
     {{#iferror: {{#expr: 1 + {{#switch:
 {{#if: 
   | {{{demospace}}}
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     }}
   }}

| main | = {{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}} | talk = | user = | wikipedia = | file | image = | mediawiki = | template = {{#switch:Template: 

 |:Message box ={{#ifexpr:{{#ifeq:¬|¬|1|0}}+{{#ifeq:¬|¬|1|0}}+{{#ifeq:¬|¬|1|0}}
  |
 }}{{#if:
  |
 }}
 |Template:        = {{#ifeq:Message box|Message box|}}
}}

| help = | category = | portal = | book = | other | #default =

}} }} | {{#switch: 

 {{#if: 
   | {{{demospace}}}
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     }}
   }}

| main | = {{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}} | talk = | user = | wikipedia = | file | image = | mediawiki = | template = {{#switch:Template: 

 |:Message box ={{#ifexpr:{{#ifeq:¬|¬|1|0}}+{{#ifeq:¬|¬|1|0}}+{{#ifeq:¬|¬|1|0}}
  |
 }}{{#if:
  |
 }}
 |Template:        = {{#ifeq:Message box|Message box|}}
}}

| help = | category = | portal = | book = | other | #default =

}} | }} 

   }}
 }}
}}, Template:Imbox, Template:Tmbox, {{#invoke:Message box|ombox}}, {{#ifeq:|none | | }}

{{#if:

|

}} 

 {{#if:
 | {{{image}}}
 | [[File:{{#switch:
   | speedy     = Cmbox deletion.png
   | delete     = Cmbox deletion.png
   | content    = Cmbox content.png
   | style      = Edit-clear.svg
   | move       = Cmbox move.png
   | protection = Cmbox protection.png
   | notice          
   | #default   = Cmbox notice.png
   }}|40x40px|link=|alt=]]
}}		 {{{text}}} {{{imageright}}}
{{#switch:

| | speedy | delete | content | style | move | protection | notice =

| #default =
This message box is using an invalid "type=" parameter and needs fixing.
}} and {{#ifeq:|none | | }}

{{#if:

|

}} 

 {{#if:
 | {{{image}}}
 | [[File:{{#switch:
   | warning    = Cmbox deletion.png
   | editnotice = Imbox notice.png
   | system          
   | #default   = Imbox notice.png
   }}|40x40px|link=|alt=]]
}}		 {{{text}}} {{{imageright}}}
{{#switch:

| | warning | editnotice | system =

| #default =
This message box is using an invalid "type=" parameter and needs fixing.

}}.

-- Load necessary modules. require('Module:No globals') local getArgs local categoryHandler = require('Module:Category handler')._main local yesno = require('Module:Yesno')

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

-- 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 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 = {}

return setmetatable(obj, MessageBox) end

function MessageBox:addCat(ns, cat, sort) if not cat then return nil end if sort then cat = string.format(, cat, sort) else cat = string.format(, cat) end 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

-- 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) )

-- Add attributes, classes and styles. if cfg.allowId then self.id = args.id end self:addClass( cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks' ) 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

-- 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 self.name = args.name 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 {{#ifeq:{{{subst}}}|SUBST 

|{{#if:
 |<{{#switch:{{{tag}}}
|p=p
|span=span
|div=div
|#default=strong

}} class="error">Template {{{{#if: |subst:}}[[Template:{{{name}}}|{{{name}}}]]{{#if: ||{{{2}}}}}{{#if: ||{{{3}}}}}{{#if: ||{{{4}}}}}{{#if: ||{{{5}}}}}{{#if: ||{{{6}}}}}{{#if: ||{{{7}}}}}{{#if: ||{{{8}}}}}{{#if: ||{{{9}}}}}{{#if: ||{{{10}}}}}{{#if: ||{{{11}}}}}{{#if: ||…}}}} has been incorrectly substituted.</{{#switch:{{{tag}}} 

|p=p
|span=span
|div=div
|#default=strong

}}> 

}}

}}{{Ambox/{{#ifeq:{{{small}}}|left|small|core}} 

|type = 
|image = 
|smallimage = {{#if:|{{{smallimage}}}|}}
|imageright = 
|smallimageright = {{#if:|{{{smallimageright}}}|}}
|class = ambox-{{#switch:
 |speedy = speedy
 |delete = delete
 |content = content
 |style = style
 |move = move
 |protection = protection
 |notice|#default = notice
}} 
|style = 
|textstyle  = 
|smalltext  = 
|talk = {{#switch:¬
 |¬        = 
 |         = {{#ifeq:{{ safesubst:#if: {{safesubst:#invoke:Ns has subpages|main}} 
 | {{ safesubst:#titleparts:{{ safesubst:#if:|{{{1}}}|:Message box}}|1}}
 | {{ safesubst:#if:|{{{1}}}|:Message box}}

}}|Template:|#}} 

 |#default = {{{talk}}}
}}
|issue = {{#switch:¬
 |¬ = 
 |  = This article
 |This {{{sect}}}
}}  
|fix = 
|date = {{#switch:¬
 |¬        = 
 |         = {{#ifeq:{{ safesubst:#if: {{safesubst:#invoke:Ns has subpages|main}} 
 | {{ safesubst:#titleparts:{{ safesubst:#if:|{{{1}}}|:Message box}}|1}}
 | {{ safesubst:#if:|{{{1}}}|:Message box}}

}}|Template:|December 2024}} 

 |#default = {{{date}}}
}}
|info =

}}{{#if: 

 {{#ifeq:  | true
 | dontcat    
 }}{{#ifeq:  | no
 | dontcat
 }}{{#switch: ¬
 | yes
 | ¬   =   
 | #default = dontcat   
 }}{{#switch: 
 | no = 
   {{#switch:
 {{#if:
 | {{#if:{{#titleparts:|0|3}}
   | subsubpage    
   | {{#if:{{#titleparts:|0|2}}
     | subpage
     | basepage
     }}
   }}
 | {{#if:{{#titleparts::Message box|0|3}}
   | subsubpage    
   | {{#if:{{#titleparts::Message box|0|2}}
     | subpage
     | basepage
     }}
   }}
 }}

| basepage =

| subpage = dontcat

| subsubpage = dontcat

}} 

 | only = 
   {{#switch:
 {{#if:
 | {{#if:{{#titleparts:|0|3}}
   | subsubpage    
   | {{#if:{{#titleparts:|0|2}}
     | subpage
     | basepage
     }}
   }}
 | {{#if:{{#titleparts::Message box|0|3}}
   | subsubpage    
   | {{#if:{{#titleparts::Message box|0|2}}
     | subpage
     | basepage
     }}
   }}
 }}

| basepage = dontcat

| subpage = | subsubpage = }} 

 }}

| | 

 {{#switch:
   {{#ifeq:  | false
   |   
   | {{#ifeq:  | yes
     |   
     | {{#ifeq:  | yes
       |   
       | {{#if:x

| 


     {{#if:{{#titleparts:{{#if:|  | :Message box }}|0|2}}
     | 
        
          
            
              
                
                       
                 
               
             
           
         
       
     | 
             
       
     }}

}} 

       }}
     }}
   }}
 | hide = 
 | #default  = 
   {{#ifeq: h0#384!5nea+w9 |  {{#if:
|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}} 

   | 
     {{#switch:
 {{#if: 
   | {{{demospace}}}
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     }}
   }}

| main | = | talk = | user = | wikipedia = | file | image = | mediawiki = | template = | help = | category = | portal = | book = | other | #default =

}} 

   | 
     {{#iferror: {{#expr: 1 + {{#switch:
 {{#if: 
   | {{{demospace}}}
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     }}
   }}

| main | = {{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}} | talk = | user = | wikipedia = | file | image = | mediawiki = | template = {{#switch:Template: 

 |:Message box ={{#ifexpr:{{#ifeq:¬|¬|1|0}}+{{#ifeq:¬|¬|1|0}}+{{#ifeq:¬|¬|1|0}}
  |
 }}{{#if:
  |
 }}
 |Template:        = {{#ifeq:Message box|Message box|}}
}}

| help = | category = | portal = | book = | other | #default =

}} }} | {{#switch: 

 {{#if: 
   | {{{demospace}}}
   | {{#if: 
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     | 
       {{#ifeq:|
       | talk
       |  
       }}
     }}
   }}

| main | = {{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}{{#if: 

|{{#if:
 |{{#ifexist:Category: from |
  |
 }}
 |[[Category:]]
}}

}}{{#if: 

|[[Category:]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from ]]{{#ifexist:Category:{{{cat2}}} from |
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from ]]{{#ifexist:Category:{{{cat3}}} from |
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}} | talk = | user = | wikipedia = | file | image = | mediawiki = | template = {{#switch:Template: 

 |:Message box ={{#ifexpr:{{#ifeq:¬|¬|1|0}}+{{#ifeq:¬|¬|1|0}}+{{#ifeq:¬|¬|1|0}}
  |
 }}{{#if:
  |
 }}
 |Template:        = {{#ifeq:Message box|Message box|}}
}}

| help = | category = | portal = | book = | other | #default =

}} | }} 

   }}
 }}

}}. 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 = 'Relevant discussion may be found on' if talkArgIsTalkPage then talkText = string.format( '%s %s.', talkText, talk, talkTitle.prefixedText ) else talkText = string.format( '%s the talk page.', talkText, talkTitle.prefixedText, talk ) 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(" (%s)", date) end self.info = args.info 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

-- Set the below row. self.below = cfg.below and args.below

-- General image settings. self.imageCellDiv = not self.isSmall and cfg.imageCellDiv self.imageEmptyCell = cfg.imageEmptyCell if cfg.imageEmptyCellStyle then self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px' end

-- 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('%s', self.typeImage or 'Imbox notice.png', imageSize) 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 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 {{#if: 

|{{#if:
 |[[Category:{{{cat}}} from {{{date}}}]]{{#ifexist:Category:{{{cat}}} from {{{date}}}|
  |
 }}
 |[[Category:{{{cat}}}]]
}}

}}{{#if: 

|[[Category:{{{all}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat2}}} from {{{date}}}]]{{#ifexist:Category:{{{cat2}}} from {{{date}}}|
  |
 }}
 |[[Category:{{{cat2}}}]]
}}

}}{{#if: 

|[[Category:{{{all2}}}]]

}}{{#if: 

|{{#if:
 |[[Category:{{{cat3}}} from {{{date}}}]]{{#ifexist:Category:{{{cat3}}} from {{{date}}}|
  |
 }}
 |[[Category:{{{cat3}}}]]
}}

}}{{#if: 

|[[Category:{{{all3}}}]]

}}. 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() -- Convert category tables to strings and pass them through -- Module:Category handler. return categoryHandler{ 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: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 %s%s%s has been incorrectly substituted.', mw.text.nowiki('Template:'), self.name, self.name, mw.text.nowiki('') )) 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'):css('width', '52px') end imageLeftCell: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') :cssText(self.imageEmptyCellStyle or nil) 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 textCellSpan = textCell:tag('span') textCellSpan :addClass('mbox-text-span') :wikitext(self.issue or nil) if not self.isSmall then textCellSpan:tag('span') :addClass('hide-when-compact') :wikitext(self.talk and (' ' .. self.talk) or nil) :wikitext(self.fix and (' ' .. self.fix) or nil) end textCellSpan:wikitext(self.date and (' ' .. self.date) or nil) if not self.isSmall then textCellSpan :tag('span') :addClass('hide-when-compact') :wikitext(self.info and (' ' .. self.info) or nil) 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'):css('width', '52px') end imageRightCell :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') :css('text-align', 'center') :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('Module:Message box/configuration')) box:setParameters() box:setCategories() 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)

Retrieved from "https://rbem.org/wiki/index.php?title=:Message_box&oldid=43997"
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox