Editing Module:Message box

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. 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:
require('Module:No globals')
-- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
local getArgs
 
local htmlBuilder = require('Module:HtmlBuilder')
local nsDetect = require('Module:Namespace detect')
local categoryHandler = require('Module:Category handler').main
local yesno = require('Module:Yesno')
local yesno = require('Module:Yesno')
local lang = mw.language.getContentLanguage()


local CONFIG_MODULE = 'Module:Message box/configuration'
local p = {}
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}
 
local function getTitleObject(page)
    if type(page) == 'string' then
        -- Get the title object, passing the function through pcall
        -- in case we are over the expensive function count limit.
        local success
        success, page = pcall(mw.title.new, page)
        if not success then
            page = nil
        end
    end
    return page
end


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


local function getTitleObject(...)
local function formatCategory(cat, date, all)
-- Get the title object, passing the function through pcall
    local ret = {}
-- in case we are over the expensive function count limit.
    cat = type(cat) == 'string' and cat
local success, title = pcall(mw.title.new, ...)
    date = type(date) == 'string' and date
if success then
    all = type(all) == 'string' and all
return title
    local preposition = 'from'
end
    if cat and date then
        local catTitle = mw.ustring.format('Category:%s %s %s', cat, preposition, date)
        table.insert(ret, mw.ustring.format('[[%s]]', catTitle))
        catTitle = getTitleObject(catTitle)
        if not catTitle or not catTitle.exists then
            table.insert(ret, '[[Category:Articles with invalid date parameter in template]]')
        end
    elseif cat and not date then
        table.insert(ret, mw.ustring.format('[[Category:%s]]', cat))
    end
    if all then
        table.insert(ret, mw.ustring.format('[[Category:%s]]', all))
    end
    return table.concat(ret)
end
end


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


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


--------------------------------------------------------------------------------
function p.build(boxType, args)
-- Box class definition
    -- Get the box config data from the data page.
--------------------------------------------------------------------------------
    local dataTables = mw.loadData('Module:Message box/data')
    local data = dataTables[boxType]
    if not data then
        local boxTypes = {}
        for k, v in pairs(dataTables) do
            table.insert(boxTypes, mw.ustring.format('"%s"', k))
        end
        error(mw.ustring.format('invalid message box type "%s"; valid types are %s', tostring(boxType), mw.text.listToText(boxTypes)), 2)
    end


local MessageBox = {}
    -- Get the title object and the namespace.
MessageBox.__index = MessageBox
    local title = mw.title.getCurrentTitle()
    local nsid = title.namespace


function MessageBox.new(boxType, args, cfg)
    -- Get a language object for formatDate.
args = args or {}
    local lang = mw.language.getContentLanguage()
local obj = {}
   
-- Commenting this out for now - this will require tinkering with Namespace detect to differentiate between
-- invalid titles and pages where the expensive parser function count has been exceeded.
--[[
    local title = nsDetect.getPageObject(args.page)
    local namespace = nsDetect.main{
        page = args.page,
        demospace = args.demospace,
        main = 'main',
        talk = 'talk',
        file = 'file',
        category = 'category',
        other = 'other'
    }
]]


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


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


-- Set the arguments, and remove all blank arguments except for the ones
    -- Process data for collapsible text fields
-- listed in cfg.allowBlankParams.
    local name, issue, talk, fix, date, info
do
    if data.useCollapsibleTextFields then
local newArgs = {}
        name = args.name
for k, v in pairs(args) do
        local nameTitle = getTitleObject(name)
if v ~= '' then
        local isTemplatePage = nameTitle and title.prefixedText == ('Template:' .. nameTitle.text) and true or false
newArgs[k] = v
        local sect = args.sect
end
        if presentButBlank(sect) then
end
            sect = mw.ustring.format('This %s ', data.sectionDefault or 'page')
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
        elseif type(sect) == 'string' then
newArgs[param] = args[param]
            sect = 'This ' .. sect .. ' '
end
        end
obj.args = newArgs
        issue = (sect or '') .. (args.issue or '') .. ' ' .. (args.text or '')
end
        talk = args.talk
        if presentButBlank(talk) and isTemplatePage then
            talk = '#'
        end
        fix = args.fix
        date = args.date
        if presentButBlank(date) and isTemplatePage then
            date = lang:formatDate('F Y')
        end
        info = args.info
    end


-- Define internal data structure.
    -- Process the talk link, if present.
obj.categories = {}
    if talk then
obj.classes = {}
        -- See if the talk link exists and is for a talk or a content namespace.
-- For lazy loading of [[Module:Category handler]].
        local talkTitle = type(talk) == 'string' and getTitleObject(talk)
obj.hasCategories = false
        if not talkTitle or not talkTitle.isTalkPage then
            -- If we couldn't process the talk page link, get the talk page of the current page.
            local success
            success, talkTitle = pcall(title.talkPageTitle, title)
            if not success then
                talkTitle = nil
            end
        end
        if talkTitle and talkTitle.exists then
            local talkText = ' Relevant discussion may be found on'
            if talkTitle.isTalkPage then
                talkText = mw.ustring.format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText)
            else
                talkText = mw.ustring.format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk)
            end
            talk = talkText
        end
    end


return setmetatable(obj, MessageBox)
    -- Find whether we are using a small message box and process our data accordingly.
end
    local isSmall = data.allowSmall and (args.small == 'yes' or args.small == true) and true or false
    local smallClass, image, imageRight, text, imageSize
    if isSmall then
        smallClass = data.smallClass or 'mbox-small'
        image = args.smallimage or args.image
        imageRight = args.smallimageright or args.imageright
        if data.useCollapsibleTextFields then
            text = args.smalltext or issue
        else
            text = args.smalltext or args.text
        end
        imageSize = data.imageSmallSize or '30x30px'
    else
        image = args.image
        imageRight = args.imageright
        imageSize = '40x40px'
        text = args.text
    end


function MessageBox:addCat(ns, cat, sort)
    -- Process mainspace categories.
if not cat then
    local mainCats = {}
return nil
    local origCategoryNums -- origCategoryNums might be used in computing the template error category.
end
    if data.allowMainspaceCategories then
if sort then
        -- Categories for the main namespace.
cat = string.format('[[Category:%s|%s]]', cat, sort)
        local origCatNums = getArgNums(args, 'cat')
else
        local origCategoryNums = getArgNums(args, 'category')
cat = string.format('[[Category:%s]]', cat)
        local catNums = union(origCatNums, origCategoryNums)
end
        for _, num in ipairs(catNums) do
self.hasCategories = true
            local cat = args['cat' .. tostring(num)] or args['category' .. tostring(num)]
self.categories[ns] = self.categories[ns] or {}
            local all = args['all' .. tostring(num)]
table.insert(self.categories[ns], cat)
            table.insert(mainCats, formatCategory(cat, args.date, all))
end
        end
    end


function MessageBox:addClass(class)
    -- Process template namespace categories
if not class then
    local templateCats = {}
return nil
    if data.templateCategory and not title.isSubpage and not yesno(args.nocat) then
end
        table.insert(templateCats, mw.ustring.format('[[Category:%s]]', data.templateCategory))
table.insert(self.classes, class)
    end
end


function MessageBox:setParameters()
    -- Add an error category for the template namespace if appropriate.
local args = self.args
    if data.templateErrorCategory then
local cfg = self.cfg
        local catName = data.templateErrorCategory
 
        local templateCat
-- Get type data.
        if not name and not title.isSubpage then
self.type = args.type
            templateCat = mw.ustring.format('[[Category:%s]]', catName)
local typeData = cfg.types[self.type]
        elseif type(name) == 'string' and title.prefixedText == ('Template:' .. name) then
self.invalidTypeError = cfg.showInvalidTypeError
            local paramsToCheck = data.templateErrorParamsToCheck or {}
and self.type
            local count = 0
and not typeData
            for i, param in ipairs(paramsToCheck) do
typeData = typeData or cfg.types[cfg.default]
                if not args[param] then
self.typeClass = typeData.class
                     count = count + 1
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.
self.id = args.id
self.name = args.name
if self.name then
self:addClass('box-' .. string.gsub(self.name,' ','_'))
end
if yesno(args.plainlinks) ~= false then
self:addClass('plainlinks')
end
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
if self.name then
local templateName = mw.ustring.match(
self.name,
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
) or self.name
templateName = 'Template:' .. templateName
self.templateTitle = getTitleObject(templateName)
end
self.isTemplatePage = self.templateTitle
and mw.title.equals(self.title, self.templateTitle)
end
-- Process data for collapsible text fields. At the moment these are only
-- used in {{ambox}}.
if self.useCollapsibleTextFields then
-- Get the self.issue value.
if self.isSmall and args.smalltext then
self.issue = args.smalltext
else
local sect
if args.sect == '' then
sect = 'This ' .. (cfg.sectionDefault or 'page')
elseif type(args.sect) == 'string' then
sect = 'This ' .. args.sect
end
local issue = args.issue
issue = type(issue) == 'string' and issue ~= '' and issue or nil
local text = args.text
text = type(text) == 'string' and text or nil
local issues = {}
table.insert(issues, sect)
table.insert(issues, issue)
table.insert(issues, text)
self.issue = table.concat(issues, ' ')
end
 
-- Get the self.talk value.
local talk = args.talk
-- Show talk links on the template page or template subpages if the talk
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
or self.title:isSubpageOf(self.templateTitle)
)
then
talk = '#'
elseif talk == '' then
talk = nil
end
if talk then
-- If the talk value is a talk page, make a link to that page. Else
-- assume that it's a section heading, and make a link to the talk
-- page of the current page with that section heading.
local talkTitle = getTitleObject(talk)
local talkArgIsTalkPage = true
if not talkTitle or not talkTitle.isTalkPage then
talkArgIsTalkPage = false
talkTitle = getTitleObject(
self.title.text,
mw.site.namespaces[self.title.namespace].talk.id
)
end
if talkTitle and talkTitle.exists then
                local talkText
                if self.isSmall then
                    local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. '#' .. talk)
                     talkText = string.format('([[%s|talk]])', talkLink)
                else
                    talkText = 'Relevant discussion may be found on'
                    if talkArgIsTalkPage then
                        talkText = string.format(
                            '%s [[%s|%s]].',
                            talkText,
                            talk,
                            talkTitle.prefixedText
                        )
                    else
                        talkText = string.format(
                            '%s the [[%s#%s|talk page]].',
                            talkText,
                            talkTitle.prefixedText,
                            talk
                        )
                    end
                 end
                 end
self.talk = talkText
            end
end
            if count > 0 then
end
                templateCat = mw.ustring.format('[[Category:%s|%d]]', catName, count)
 
            end
-- Get other values.
            if origCategoryNums and #origCategoryNums > 0 then
self.fix = args.fix ~= '' and args.fix or nil
                templateCat = mw.ustring.format('[[Category:%s|C]]', catName)
local date
            end
if args.date and args.date ~= '' then
        end
date = args.date
        table.insert(templateCats, templatecat)
elseif args.date == '' and self.isTemplatePage then
    end
date = lang:formatDate('F Y')
end
if date then
self.date = string.format(" <span class='date-container'><i>(<span class='date'>%s</span>)</i></span>", date)
end
self.info = args.info
if yesno(args.removalnotice) then
self.removalNotice = cfg.removalNotice
end
end
 
-- Set the non-collapsible text field. At the moment this is used by all box
-- types other than ambox, and also by ambox when small=yes.
if self.isSmall then
self.text = args.smalltext or args.text
else
self.text = args.text
end
 
-- 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
 
-- Left image settings.
local imageLeft = self.isSmall and args.smallimage or args.image
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
or not cfg.imageCheckBlank and imageLeft ~= 'none'
then
self.imageLeft = imageLeft
if not imageLeft then
local imageSize = self.isSmall
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', 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
-- set templatestyles
self.base_templatestyles = cfg.templatestyles
self.templatestyles = args.templatestyles
end
 
function MessageBox:setMainspaceCategories()
local args = self.args
local cfg = self.cfg


if not cfg.allowMainspaceCategories then
    -- Categories for all namespaces.
return nil
    local allCats = {}
end
    if invalidType then
        local catsort = (nsid == 0 and 'Main:' or '') .. title.prefixedText
        table.insert(allCats, mw.ustring.format('[[Category:Wikipedia message box parameter needs fixing|%s]]', catsort))
    end


local nums = {}
    ------------------------ Build the box ----------------------------
for _, prefix in ipairs{'cat', 'category', 'all'} do
   
args[prefix .. '1'] = args[prefix]
    local root = htmlBuilder.create()
nums = union(nums, getArgNums(args, prefix))
end


-- The following is roughly equivalent to the old {{Ambox/category}}.
    -- Do the subst check.
local date = args.date
    if data.substCheck and args.subst == 'SUBST' then
date = type(date) == 'string' and date
        if type(name) == 'string' then
local preposition = 'from'
            root
for _, num in ipairs(nums) do
                .tag('b')
local mainCat = args['cat' .. tostring(num)]
                    .addClass('error')
or args['category' .. tostring(num)]
                    .wikitext(mw.ustring.format(
local allCat = args['all' .. tostring(num)]
                        'Template <code>%s%s%s</code> has been incorrectly substituted.',
mainCat = type(mainCat) == 'string' and mainCat
                        mw.text.nowiki('{{'), name, mw.text.nowiki('}}')
allCat = type(allCat) == 'string' and allCat
                    ))
if mainCat and date and date ~= '' then
        end
local catTitle = string.format('%s %s %s', mainCat, preposition, date)
        table.insert(allCats, '[[Category:Pages with incorrectly substituted templates]]')
self:addCat(0, catTitle)
    end
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()
    -- Create the box table.
local args = self.args
    local box = root.tag('table')
local cfg = self.cfg
    box
        .attr('id', args.id)
    for i, class in ipairs(data.classes) do
        box
            .addClass(class)
    end
    box
        .addClass(isSmall and smallClass)
        .addClass(data.classPlainlinksYesno and yesno(args.plainlinks or true) and 'plainlinks')
        .addClass(typeData.class)
        .addClass(args.class)
        .cssText(args.style)
        .attr('role', 'presentation')


-- Add template categories.
    -- Add the left-hand image.
if cfg.templateCategory then
    local row = box.tag('tr')
if cfg.templateCategoryRequireName then
    local imageCheckBlank = data.imageCheckBlank
if self.isTemplatePage then
    if image ~= 'none' and not imageCheckBlank or image ~= 'none' and imageCheckBlank and image ~= 'blank' then
self:addCat(10, cfg.templateCategory)
        local imageLeftCell = row.tag('td').addClass('mbox-image')
end
        if not isSmall and data.imageCellDiv then
elseif not self.title.isSubpage then
            imageLeftCell = imageLeftCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageLeftCell so that the image is inside it.
self:addCat(10, cfg.templateCategory)
        end
end
        imageLeftCell
end
            .wikitext(image or mw.ustring.format('[[File:%s|%s|link=|alt=]]', typeData.image, imageSize))
    elseif data.imageEmptyCell then
        row.tag('td')
            .addClass('mbox-empty-cell') -- No image. Cell with some width or padding necessary for text cell to have 100% width.
            .cssText(data.imageEmptyCellStyle and 'border:none;padding:0px;width:1px')
    end


-- Add template error categories.
    -- Add the text.
if cfg.templateErrorCategory then
    local textCell = row.tag('td').addClass('mbox-text')
local templateErrorCategory = cfg.templateErrorCategory
    if data.useCollapsibleTextFields then
local templateCat, templateSort
        textCell
if not self.name and not self.title.isSubpage then
            .cssText(args.textstyle)
templateCat = templateErrorCategory
        local textCellSpan = textCell.tag('span')
elseif self.isTemplatePage then
        textCellSpan
local paramsToCheck = cfg.templateErrorParamsToCheck or {}
            .addClass('mbox-text-span')
local count = 0
            .wikitext(issue)
for i, param in ipairs(paramsToCheck) do
        if not isSmall then
if not args[param] then
            textCellSpan
count = count + 1
                .tag('span')
end
                    .addClass('hide-when-compact')
end
                    .wikitext(talk)
if count > 0 then
                    .wikitext(' ')
templateCat = templateErrorCategory
                    .wikitext(fix)
templateSort = tostring(count)
                    .done()
end
        end
if self.categoryNums and #self.categoryNums > 0 then
        textCellSpan
templateCat = templateErrorCategory
            .wikitext(date and mw.ustring.format(" <small>''(%s)''</small>", date))
templateSort = 'C'
        if not isSmall then
end
            textCellSpan
end
                .tag('span')
self:addCat(10, templateCat, templateSort)
                    .addClass('hide-when-compact')
end
                    .wikitext(info and ' ' .. info)
end
        end
    else
        textCell
            .cssText(args.textstyle)
            .wikitext(text)
    end


function MessageBox:setAllNamespaceCategories()
    -- Add the right-hand image.
-- Set categories for all namespaces.
    if imageRight and not (data.imageRightNone and imageRight == 'none') then
if self.invalidTypeError then
        local imageRightCell = row.tag('td').addClass('mbox-imageright')
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
        if not isSmall and data.imageCellDiv then
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
            imageRightCell = imageRightCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
end
        end
if self.isSubstituted then
        imageRightCell
self:addCat('all', 'Pages with incorrectly substituted templates')
            .wikitext(imageRight)
end
    end
end


function MessageBox:setCategories()
    -- Add the below row.
if self.title.namespace == 0 then
    if data.below and args.below then
self:setMainspaceCategories()
        box.tag('tr')
elseif self.title.namespace == 10 then
            .tag('td')
self:setTemplateCategories()
                .attr('colspan', args.imageright and '3' or '2')
end
                .addClass('mbox-text')
self:setAllNamespaceCategories()
                .cssText(args.textstyle)
end
                .wikitext(args.below)
    end


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


function MessageBox:export()
    -- Add error message for invalid type parameters.
local root = mw.html.create()
    if invalidType then
        root
            .tag('div')
                .addClass('error')
                .css('text-align', 'center')
                .wikitext(mw.ustring.format('This message box is using an invalid type parameter (<code>type=%s</code>) and needs fixing.', args.type or ''))
    end


-- Add the subst check error.
    -- Add categories using categoryHandler.
if self.isSubstituted and self.name then
    root
root:tag('b')
        .wikitext(categoryHandler{
:addClass('error')
            main = table.concat(mainCats),
:wikitext(string.format(
            template = table.concat(templateCats),
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
            all = table.concat(allCats)
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
        })
))
   
end
    return tostring(root)
 
local frame = mw.getCurrentFrame()
root:wikitext(frame:extensionTag{
name = 'templatestyles',
args = { src = self.base_templatestyles },
})
-- Add support for a single custom templatestyles sheet. Undocumented as
-- need should be limited and many templates using mbox are substed; we
-- don't want to spread templatestyles sheets around to arbitrary places
if self.templatestyles then
root:wikitext(frame:extensionTag{
name = 'templatestyles',
args = { src = self.templatestyles },
})
end
 
-- Create the box table.
local boxTable = root:tag('table')
boxTable:attr('id', self.id or nil)
for i, class in ipairs(self.classes or {}) do
boxTable:addClass(class or nil)
end
boxTable
:cssText(self.style or nil)
:attr('role', 'presentation')
 
if self.attrs then
boxTable:attr(self.attrs)
end
 
-- Add the left-hand image.
local row = boxTable:tag('tr')
if self.imageLeft then
local imageLeftCell = row:tag('td'):addClass('mbox-image')
if self.imageCellDiv then
-- If we are using a div, redefine imageLeftCell so that the image
-- is inside it. Divs use style="width: 52px;", which limits the
-- image width to 52px. If any images in a div are wider than that,
-- they may overlap with the text or cause other display problems.
imageLeftCell = imageLeftCell:tag('div'):addClass('mbox-image-div')
end
imageLeftCell:wikitext(self.imageLeft or nil)
elseif self.imageEmptyCell then
-- Some message boxes define an empty cell if no image is specified, and
-- some don't. The old template code in templates where empty cells are
-- specified gives the following hint: "No image. Cell with some width
-- or padding necessary for text cell to have 100% width."
row:tag('td')
:addClass('mbox-empty-cell')
end
 
-- Add the text.
local textCell = row:tag('td'):addClass('mbox-text')
if self.useCollapsibleTextFields then
-- The message box uses advanced text parameters that allow things to be
-- collapsible. At the moment, only ambox uses this.
textCell:cssText(self.textstyle or nil)
local textCellDiv = textCell:tag('div')
textCellDiv
:addClass('mbox-text-span')
:wikitext(self.issue or nil)
if (self.talk or self.fix) then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:wikitext(self.talk and (' ' .. self.talk) or nil)
:wikitext(self.fix and (' ' .. self.fix) or nil)
end
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
if self.info and not self.isSmall then
textCellDiv
:tag('span')
:addClass('hide-when-compact')
:wikitext(self.info and (' ' .. self.info) or nil)
end
if self.removalNotice then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:tag('i')
:wikitext(string.format(" (%s)", self.removalNotice))
end
else
-- Default text formatting - anything goes.
textCell
:cssText(self.textstyle or nil)
:wikitext(self.text or nil)
end
 
-- Add the right-hand image.
if self.imageRight then
local imageRightCell = row:tag('td'):addClass('mbox-imageright')
if self.imageCellDiv then
-- If we are using a div, redefine imageRightCell so that the image
-- is inside it.
imageRightCell = imageRightCell:tag('div'):addClass('mbox-image-div')
end
imageRightCell
:wikitext(self.imageRight or nil)
end
 
-- Add the below row.
if self.below then
boxTable:tag('tr')
:tag('td')
:attr('colspan', self.imageRight and '3' or '2')
:addClass('mbox-text')
:cssText(self.textstyle or nil)
:wikitext(self.below or nil)
end
 
-- Add error message for invalid type parameters.
if self.invalidTypeError then
root:tag('div')
:addClass('mbox-invalid-type')
:wikitext(string.format(
'This message box is using an invalid "type=%s" parameter and needs fixing.',
self.type or ''
))
end
 
-- Add categories.
root:wikitext(self:renderCategories() or nil)
 
return tostring(root)
end
end


--------------------------------------------------------------------------------
local function makeWrapper(boxType)
-- Exports
    return function (frame)
--------------------------------------------------------------------------------
        -- If called via #invoke, use the args passed into the invoking
 
        -- template, or the args passed to #invoke if any exist. Otherwise
local p, mt = {}, {}
        -- assume args are being passed directly in from the debug console
 
        -- or from another Lua module.
function p._exportClasses()
        local origArgs
-- For testing.
        if frame == mw.getCurrentFrame() then
return {
            origArgs = frame:getParent().args
MessageBox = MessageBox
            for k, v in pairs(frame.args) do
}
                origArgs = frame.args
                break
            end
        else
            origArgs = frame
        end
        -- Trim whitespace and remove blank arguments.
        local args = {}
        for k, v in pairs(origArgs) do
            if type(v) == 'string' then
                v = mw.text.trim(v)
            end
            if v ~= '' or k == 'talk' or k == 'sect' or k == 'date' then
                args[k] = v
            end
        end
        return p.build(boxType, args)
    end
end
end


function p.main(boxType, args, cfgTables)
p.ambox = makeWrapper('ambox')
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE))
p.fmbox = makeWrapper('fmbox')
box:setParameters()
p.imbox = makeWrapper('imbox')
box:setCategories()
p.ombox = makeWrapper('ombox')
return box:export()
p.cmbox = makeWrapper('cmbox')
end
p.tmbox = makeWrapper('tmbox')
 
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)
return p
Please note that all contributions to Meta Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, 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 (see Meta Wiki:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Template used on this page:

Retrieved from "https://meta.skywiki.org/wiki/Module:Message_box"