Editing Module:Message box

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. Read the Privacy Policy to learn what information we collect about you and how we use it.

If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
-- This is a meta-module for producing message box templates, including
-- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.


-- Load necessary modules.
-- Require necessary modules.
require('Module:No globals')
local htmlBuilder = require('Module:HtmlBuilder')
local getArgs
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()


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


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


local function getTitleObject(...)
local function getTitleObject(page)
-- Get the title object, passing the function through pcall
if type(page) == 'string' then
-- in case we are over the expensive function count limit.
-- Get the title object, passing the function through pcall  
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
return title
end
end
end
end
end
Line 38: Line 42:
local ret = {}
local ret = {}
for k in pairs(vals) do
for k in pairs(vals) do
table.insert(ret, k)
tinsert(ret, k)
end
end
table.sort(ret)
table.sort(ret)
Line 49: Line 53:
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
table.insert(nums, tonumber(num))
tinsert(nums, tonumber(num))
end
end
end
end
Line 56: Line 60:
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))
if ns == 'Main' then
ns = 0
end
end
local nsTable = mw.site.namespaces[ns]
if nsTable then
return nsTable.id
end
end


local MessageBox = {}
function box.getMboxType(nsid)
MessageBox.__index = MessageBox
-- Gets the mbox type from a namespace number.
 
if nsid == 0 then
function MessageBox.new(boxType, args, cfg)
return 'ambox' -- main namespace
args = args or {}
elseif nsid == 6 then
local obj = {}
return 'imbox' -- file namespace
 
elseif nsid == 14 then
-- Set the title object and the namespace.
return 'cmbox' -- category namespace
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
else
 
local nsTable = mw.site.namespaces[nsid]
-- Set the config for our box type.
if nsTable and nsTable.isTalk then
obj.cfg = cfg[boxType]
return 'tmbox' -- any talk namespace
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
else
local nsTable = mw.site.namespaces[ns]
return 'ombox' -- other namespaces or invalid input
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


-- Set the arguments, and remove all blank arguments except for the ones
function box:addCat(ns, cat, sort)
-- listed in cfg.allowBlankParams.
if type(cat) ~= 'string' then return end
do
local nsVals = {'main', 'template', 'all'}
local newArgs = {}
local tname
for k, v in pairs(args) do
for i, val in ipairs(nsVals) do
if v ~= '' then
if ns == val then
newArgs[k] = v
tname = ns .. 'Cats'
end
end
end
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
end
newArgs[param] = args[param]
if not tname then
for i, val in ipairs(nsVals) do
nsVals[i] = format('"%s"', val)
end
end
obj.args = newArgs
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


-- Define internal data structure.
function box:addClass(class)
obj.categories = {}
if type(class) ~= 'string' then return end
obj.classes = {}
self.classes = self.classes or {}
-- For lazy loading of [[Module:Category handler]].
tinsert(self.classes, class)
obj.hasCategories = false
end


return setmetatable(obj, MessageBox)
function box:setTitle(args)
-- Get the title object and the namespace.
self.pageTitle = getTitleObject(args.page ~= '' and args.page)
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
end


function MessageBox:addCat(ns, cat, sort)
function box:getConfig(boxType)
if not cat then
-- Get the box config data from the data page.
return nil
if boxType == 'mbox' then
boxType = box.getMboxType(self.nsid)
end
end
if sort then
local cfg = cfgTables[boxType]
cat = string.format('[[Category:%s|%s]]', cat, sort)
if not cfg then
else
local boxTypes = {}
cat = string.format('[[Category:%s]]', cat)
for k, v in pairs(dataTables) do
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
self.hasCategories = true
return cfg
self.categories[ns] = self.categories[ns] or {}
table.insert(self.categories[ns], cat)
end
end


function MessageBox:addClass(class)
function box:removeBlankArgs(cfg, args)
if not class then
-- Only allow blank arguments for the parameter names listed in cfg.allowBlankParams.
return nil
local newArgs = {}
for k, v in pairs(args) do
if v ~= '' then
newArgs[k] = v
end
end
end
table.insert(self.classes, class)
for i, param in ipairs(cfg.allowBlankParams or {}) do
newArgs[param] = args[param]
end
return newArgs
end
end


function MessageBox:setParameters()
function box:setBoxParameters(cfg, args)
local args = self.args
local cfg = self.cfg
 
-- Get type data.
-- Get type data.
self.type = args.type
self.type = args.type
local typeData = cfg.types[self.type]
local typeData = cfg.types[self.type]
self.invalidTypeError = cfg.showInvalidTypeError
self.invalidTypeError = cfg.showInvalidTypeError and self.type and not typeData and true or false
and self.type
and not typeData
typeData = typeData or cfg.types[cfg.default]
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
self.typeClass = typeData.class
Line 164: Line 170:


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


-- Find whether we are using a small message box.
-- Find whether we are using a small message box.
self.isSmall = cfg.allowSmall and (
if 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.
self.id = args.id
if cfg.allowId then
self.name = args.name
self.id = args.id
if self.name then
self:addClass('box-' .. string.gsub(self.name,' ','_'))
end
if yesno(args.plainlinks) ~= false then
self:addClass('plainlinks')
end
end
self:addClass(cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks')
for _, class in ipairs(cfg.classes or {}) do
for _, class in ipairs(cfg.classes or {}) do
self:addClass(class)
self:addClass(class)
Line 190: Line 199:
self:addClass(args.class)
self:addClass(args.class)
self.style = args.style
self.style = args.style
self.attrs = args.attrs


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


-- Find if we are on the template page or not. This functionality is only
-- Process data for collapsible text fields. At the moment these are only used in {{ambox}}.
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
-- 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
if self.useCollapsibleTextFields then
self.name = args.name
local nameTitle = getTitleObject(self.name)
self.isTemplatePage = nameTitle and self.title.prefixedText == ('Template:' .. nameTitle.text) and true or false
-- Get the self.issue value.
-- Get the self.issue value.
if self.isSmall and args.smalltext then
if self.isSmall and args.smalltext then
Line 233: Line 225:
text = type(text) == 'string' and text or nil
text = type(text) == 'string' and text or nil
local issues = {}
local issues = {}
table.insert(issues, sect)
tinsert(issues, sect)
table.insert(issues, issue)
tinsert(issues, issue)
table.insert(issues, text)
tinsert(issues, text)
self.issue = table.concat(issues, ' ')
self.issue = tconcat(issues, ' ')
end
end


-- Get the self.talk value.
-- Get the self.talk value.
local talk = args.talk
local talk = args.talk
-- Show talk links on the template page or template subpages if the talk
if talk == '' and self.isTemplatePage then
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
or self.title:isSubpageOf(self.templateTitle)
)
then
talk = '#'
talk = '#'
elseif talk == '' then
talk = nil
end
end
if talk then
if talk then
-- If the talk value is a talk page, make a link to that page. Else
-- See if the talk link exists and is for a talk or a content namespace.
-- 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 talkTitle = getTitleObject(talk)
local talkArgIsTalkPage = true
if not talkTitle or not talkTitle.isTalkPage then
if not talkTitle or not talkTitle.isTalkPage then
talkArgIsTalkPage = false
-- If we couldn't process the talk page link, get the talk page of the current page.
talkTitle = getTitleObject(
local success
self.title.text,
success, talkTitle = pcall(self.title.talkPageTitle, self.title)
mw.site.namespaces[self.title.namespace].talk.id
if not success then
)
talkTitle = nil
end
end
end
if talkTitle and talkTitle.exists then
if talkTitle and talkTitle.exists then
                local talkText
local talkText = 'Relevant discussion may be found on'
                if self.isSmall then
if talkTitle.isTalkPage then
                    local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. '#' .. talk)
talkText = format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText)
                    talkText = string.format('([[%s|talk]])', talkLink)
else
                else
talkText = format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk)
                    talkText = 'Relevant discussion may be found on'
end
                    if talkArgIsTalkPage then
                        talkText = string.format(
                            '%s [[%s|%s]].',
                            talkText,
                            talk,
                            talkTitle.prefixedText
                        )
                    else
                        talkText = string.format(
                            '%s the [[%s#%s|talk page]].',
                            talkText,
                            talkTitle.prefixedText,
                            talk
                        )
                    end
                end
self.talk = talkText
self.talk = talkText
end
end
Line 303: Line 267:
end
end
if date then
if date then
self.date = string.format(" <small class='date-container'>''(<span class='date'>%s</span>)''</small>", date)
self.date = format(" <small>''(%s)''</small>", date)
end
end
self.info = args.info
self.info = args.info
if yesno(args.removalnotice) then
self.removalNotice = cfg.removalNotice
end
end
end


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


-- General image settings.
-- General image settings.
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
self.imageEmptyCell = cfg.imageEmptyCell
self.imageEmptyCell = cfg.imageEmptyCell
if cfg.imageEmptyCellStyle then
if cfg.imageEmptyCellStyle then
Line 336: Line 297:
self.imageLeft = imageLeft
self.imageLeft = imageLeft
if not imageLeft then
if not imageLeft then
local imageSize = self.isSmall
local imageSize = self.isSmall and (cfg.imageSmallSize or '30x30px') or '40x40px'
and (cfg.imageSmallSize or '30x30px')
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage or 'Imbox notice.png', imageSize)
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
or 'Imbox notice.png', imageSize)
end
end
end
end
Line 349: Line 307:
self.imageRight = imageRight
self.imageRight = imageRight
end
end
end


function MessageBox:setMainspaceCategories()
-- Add mainspace categories. At the moment these are only used in {{ambox}}.
local args = self.args
if cfg.allowMainspaceCategories then
local cfg = self.cfg
if args.cat then
 
args.cat1 = args.cat
if not cfg.allowMainspaceCategories then
end
return nil
self.catNums = getArgNums(args, 'cat')
end
if args.category then
 
args.category1 = args.category
local nums = {}
end
for _, prefix in ipairs{'cat', 'category', 'all'} do
self.categoryNums = getArgNums(args, 'category')
args[prefix .. '1'] = args[prefix]
if args.all then
nums = union(nums, getArgNums(args, prefix))
args.all1 = args.all
end
end
 
self.allNums = getArgNums(args, 'all')
-- The following is roughly equivalent to the old {{Ambox/category}}.
self.categoryParamNums = union(self.catNums, self.categoryNums)
local date = args.date
self.categoryParamNums = union(self.categoryParamNums, self.allNums)
date = type(date) == 'string' and date
-- The following is roughly equivalent to the old {{Ambox/category}}.
local preposition = 'from'
local date = args.date
for _, num in ipairs(nums) do
date = type(date) == 'string' and date
local mainCat = args['cat' .. tostring(num)]
local preposition = 'from'
or args['category' .. tostring(num)]
for _, num in ipairs(self.categoryParamNums) do
local allCat = args['all' .. tostring(num)]
local mainCat = args['cat' .. 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()
-- Add template-namespace categories.
local args = self.args
self.isTemplatePage = type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name)
local cfg = self.cfg
 
-- Add template categories.
if cfg.templateCategory then
if cfg.templateCategory then
if cfg.templateCategoryRequireName then
if self.name then
if self.isTemplatePage then
if self.isTemplatePage then
self:addCat(10, cfg.templateCategory)
self:addCat('template', cfg.templateCategory)
end
end
elseif not self.title.isSubpage then
elseif not self.title.isSubpage then
self:addCat(10, cfg.templateCategory)
self:addCat('template', cfg.templateCategory)
end
end
end
end


-- Add template error categories.
-- Add template error category.
if cfg.templateErrorCategory then
if cfg.templateErrorCategory then
local templateErrorCategory = cfg.templateErrorCategory
local templateErrorCategory = cfg.templateErrorCategory
Line 412: Line 367:
if not self.name and not self.title.isSubpage then
if not self.name and not self.title.isSubpage then
templateCat = templateErrorCategory
templateCat = templateErrorCategory
elseif self.isTemplatePage then
elseif type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name) then
local paramsToCheck = cfg.templateErrorParamsToCheck or {}
local paramsToCheck = cfg.templateErrorParamsToCheck or {}
local count = 0
local count = 0
Line 429: Line 384:
end
end
end
end
self:addCat(10, templateCat, templateSort)
self:addCat('template', templateCat, templateSort)
end
end
end


function MessageBox:setAllNamespaceCategories()
-- Categories for all namespaces.
-- Set categories for all namespaces.
if self.invalidTypeError then
if self.invalidTypeError then
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
local allSort = (self.nsid == 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 442: Line 395:
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 [[Module:Category handler]].
if not self.hasCategories then
self.categories = categoryHandler{
-- No categories added, no need to pass them to Category handler so,
main = tconcat(self.mainCats or {}),
-- if it was invoked, it would return the empty string.
template = tconcat(self.templateCats or {}),
-- So we shortcut and return the empty string.
all = tconcat(self.allCats or {}),
return ""
nocat = args.nocat,
end
demospace = self.demospace,
-- Convert category tables to strings and pass them through
page = self.pageTitle and self.pageTitle.prefixedText or nil
-- [[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
end


function MessageBox:export()
function box:export()
local root = mw.html.create()
local root = htmlBuilder.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:tag('b')
root
:addClass('error')
.tag('b')
:wikitext(string.format(
.addClass('error')
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
.wikitext(format(
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
))
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:attr('id', self.id or nil)
boxTable
.attr('id', self.id)
for i, class in ipairs(self.classes or {}) do
for i, class in ipairs(self.classes or {}) do
boxTable:addClass(class or nil)
boxTable
.addClass(class)
end
end
boxTable
boxTable
:cssText(self.style or nil)
.cssText(self.style)
:attr('role', 'presentation')
.attr('role', 'presentation')
 
if self.attrs then
boxTable:attr(self.attrs)
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 is inside it.
-- is inside it. Divs use style="width: 52px;", which limits the
-- Divs use style="width: 52px;", which limits the image width to 52px. If any
-- image width to 52px. If any images in a div are wider than that,
-- images in a div are wider than that, they may overlap with the text or cause
-- they may overlap with the text or cause other display problems.
-- other display problems.
imageLeftCell = imageLeftCell:tag('div'):css('width', '52px')
imageLeftCell = imageLeftCell.tag('div').css('width', '52px')  
end
end
imageLeftCell:wikitext(self.imageLeft or nil)
imageLeftCell
.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 some don't.
-- some don't. The old template code in templates where empty cells are
-- The old template code in templates where empty cells are specified gives the following hint:
-- specified gives the following hint: "No image. Cell with some width
-- "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
-- collapsible. At the moment, only ambox uses this.
-- moment, only ambox uses this.
textCell:cssText(self.textstyle or nil)
textCell
local textCellDiv = textCell:tag('div')
.cssText(self.textstyle)
textCellDiv
local textCellSpan = textCell.tag('span')
:addClass('mbox-text-span')
textCellSpan
:wikitext(self.issue or nil)
.addClass('mbox-text-span')
if (self.talk or self.fix) then
.wikitext(self.issue)
textCellDiv:tag('span')
if not self.isSmall then
:addClass('hide-when-compact')
textCellSpan
:wikitext(self.talk and (' ' .. self.talk) or nil)
.tag('span')
:wikitext(self.fix and (' ' .. self.fix) or nil)
.addClass('hide-when-compact')
.wikitext(self.talk and ' ' .. self.talk)
.wikitext(self.fix and ' ' .. self.fix)
end
end
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
textCellSpan
if self.info and not self.isSmall then
.wikitext(self.date and ' ' .. self.date)
textCellDiv
if not self.isSmall then
:tag('span')
textCellSpan
:addClass('hide-when-compact')
.tag('span')
:wikitext(self.info and (' ' .. self.info) or nil)
.addClass('hide-when-compact')
end
.wikitext(self.info and ' ' .. self.info)
if self.removalNotice then
textCellDiv:tag('small')
:addClass('hide-when-compact')
:tag('i')
:wikitext(string.format(" (%s)", self.removalNotice))
end
end
else
else
-- Default text formatting - anything goes.
-- Default text formatting - anything goes.
textCell
textCell
:cssText(self.textstyle or nil)
.cssText(self.textstyle)
:wikitext(self.text or nil)
.wikitext(self.text)
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
imageRightCell = imageRightCell.tag('div').css('width', '52px') -- 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')
end
end
imageRightCell
imageRightCell
:wikitext(self.imageRight or nil)
.wikitext(self.imageRight)
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 or nil)
.cssText(self.textstyle)
:wikitext(self.below or nil)
.wikitext(self.below)
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:tag('div')
root
:css('text-align', 'center')
.tag('div')
:wikitext(string.format(
.css('text-align', 'center')
'This message box is using an invalid "type=%s" parameter and needs fixing.',
.wikitext(format('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:wikitext(self:renderCategories() or nil)
root
.wikitext(self.categories)


return tostring(root)
return tostring(root)
end
end


--------------------------------------------------------------------------------
local function main(boxType, args)
-- Exports
box:setTitle(args)
--------------------------------------------------------------------------------
local cfg = box:getConfig(boxType)
 
args = box:removeBlankArgs(cfg, args)
local p, mt = {}, {}
box:setBoxParameters(cfg, args)
 
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()
return box:export()
return box:export()
end
end


function mt.__index(t, k)
local function makeWrapper(boxType)
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
-- assume args are being passed directly in from the debug console
-- or from another Lua module.
local origArgs
if frame == mw.getCurrentFrame() then
origArgs = frame:getParent().args
for k, v in pairs(frame.args) do
origArgs = frame.args
break
end
else
origArgs = frame
end
end
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
-- Trim whitespace.
local args = {}
for k, v in pairs(origArgs) do
if type(v) == 'string' then
v = trim(v)
end
args[k] = v
end
return main(boxType, args)
end
end
end
end


return setmetatable(p, mt)
local p = {
main = main,
mbox = makeWrapper('mbox')
}
 
for boxType in pairs(cfgTables) do
p[boxType] = makeWrapper(boxType)
end
 
return p
Please note that all contributions to Nonbinary Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see Nonbinary Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Template used on this page:

Retrieved from "https://nonbinary.wiki/wiki/Module:Message_box"