Changes
Allow passing attributes per protected edit request by User:Jackmcbarn. Also remove undocumented "hidden" parameter and format the module so it mostly fits within 80 chars.
-- This is a meta-module for producing message box templates, including -- {{mbox}}, {{ambox}},-- {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
-- Require necessary modules.
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 {}
self.classes = self.classes or {}
tinsert(self.classes, class)
end
function box:addAttr(attr, val)
if type(attr) ~= 'string' or type(val) ~= 'string' then return end
self.attrs = self.attrs or {}
tinsert(self.attrs, attr)
end
end
tinsert(boxTypes, '"mbox"')
error(format( 'invalid message box type "%s"; valid types are %s', tostring(boxType), mw.text.listToText(boxTypes) ), 2)
end
return cfg
function box:removeBlankArgs(cfg, args)
-- Only allow blank arguments for the parameter names listed in -- cfg.allowBlankParams.
local newArgs = {}
for k, v in pairs(args) do
self.type = args.type
local typeData = cfg.types[self.type]
self.invalidTypeError = cfg.showInvalidTypeError and self.type and not typeData and true or false
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
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)
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) or false
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.
-- Get the self.talk value.
local talk = args.talk
and self.templateTitle
and ( mw.title.equals(self.templateTitle, self.title) or self.title:isSubpageOf(self.templateTitle) )
then
talk = '#'
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 = 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
-- 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
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
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
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 or date == '') then
end
-- Convert category tables to strings and pass them through -- [[Module:Category handler]].
self.categories = categoryHandler{
main = tconcat(self.mainCats or {}),
.cssText(self.style)
.attr('role', 'presentation')
for attr, val in pairs(self.attrs or {}) do
boxTable
.attr(attr, val)
end
-- Add the left-hand image.
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
.wikitext(self.imageLeft)
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')
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)
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') -- If we are using a div, redefine imageRightCell so that the image is inside it.
end
imageRightCell
.tag('div')
.css('text-align', 'center')
.wikitext(format( 'This message box is using an invalid "type=%s" parameter and needs fixing.', self.type or '' ))
end