Module:Message box: Difference between revisions

    From Nonbinary Wiki
    m>Mr. Stradivarius
    (remove the presentButBlank function, fix bug with blank date values, and trim whitespace from all arguments)
    m (5 revisions imported from wikipedia:Module:Message_box: see Topic:Vtixlm0q28eo6jtf)
     
    (55 intermediate revisions by 25 users not shown)
    Line 1: Line 1:
    -- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
    -- This is a meta-module for producing message box templates, including
    -- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.


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


    Line 9: Line 10:
    local lang = mw.language.getContentLanguage()
    local lang = mw.language.getContentLanguage()


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


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


    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


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


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


    function box.getNamespaceId(ns)
    --------------------------------------------------------------------------------
        if not ns then return end
    -- Box class definition
        if type(ns) == 'string' then
    --------------------------------------------------------------------------------
            ns = lang:ucfirst(mw.ustring.lower(ns))
     
            if ns == 'Main' then
    local MessageBox = {}
                ns = 0
    MessageBox.__index = MessageBox
            end
     
        end
    function MessageBox.new(boxType, args, cfg)
        local nsTable = mw.site.namespaces[ns]
    args = args or {}
        if nsTable then
    local obj = {}
            return nsTable.id
     
        end
    -- Set the title object and the namespace.
    end
    obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
     
    -- Set the config for our box type.
    obj.cfg = cfg[boxType]
    if not obj.cfg then
    local ns = obj.title.namespace
    -- boxType is "mbox" or invalid input
    if args.demospace and args.demospace ~= '' then
    -- implement demospace parameter of mbox
    local demospace = string.lower(args.demospace)
    if DEMOSPACES[demospace] then
    -- use template from DEMOSPACES
    obj.cfg = cfg[DEMOSPACES[demospace]]
    elseif string.find( demospace, 'talk' ) then
    -- demo as a talk page
    obj.cfg = cfg.tmbox
    else
    -- default to ombox
    obj.cfg = cfg.ombox
    end
    elseif ns == 0 then
    obj.cfg = cfg.ambox -- main namespace
    elseif ns == 6 then
    obj.cfg = cfg.imbox -- file namespace
    elseif ns == 14 then
    obj.cfg = cfg.cmbox -- category namespace
    else
    local nsTable = mw.site.namespaces[ns]
    if nsTable and nsTable.isTalk then
    obj.cfg = cfg.tmbox -- any talk namespace
    else
    obj.cfg = cfg.ombox -- other namespaces or invalid input
    end
    end
    end


    function box.getMboxType(nsid)
    -- Set the arguments, and remove all blank arguments except for the ones
        -- Gets the mbox type from a namespace number.
    -- listed in cfg.allowBlankParams.
        if nsid == 0 then
    do
            return 'ambox' -- main namespace
    local newArgs = {}
        elseif nsid == 6 then
    for k, v in pairs(args) do
            return 'imbox' -- file namespace
    if v ~= '' then
        elseif nsid == 14 then
    newArgs[k] = v
            return 'cmbox' -- category namespace
    end
        else
    end
            local nsTable = mw.site.namespaces[nsid]
    for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
            if nsTable and nsTable.isTalk then
    newArgs[param] = args[param]
                return 'tmbox' -- any talk namespace
    end
            else
    obj.args = newArgs
                return 'ombox' -- other namespaces or invalid input
    end
            end
        end
    end


    function box:addCat(ns, cat, sort)
    -- Define internal data structure.
        if type(cat) ~= 'string' then return end
    obj.categories = {}
        local nsVals = {'main', 'template', 'all'}
    obj.classes = {}
        local tname
    -- For lazy loading of [[Module:Category handler]].
        for i, val in ipairs(nsVals) do
    obj.hasCategories = false
            if ns == val then
                tname = ns .. 'Cats'
            end
        end
        if not tname then
            for i, val in ipairs(nsVals) do
                nsVals[i] = format('"%s"', val)
            end
            error('invalid ns parameter passed to box:addCat; valid values are ' .. mw.text.listToText(nsVals, nil, ' or '))
        end
        self[tname] = self[tname] or {}
        if type(sort) == 'string' then
            tinsert(self[tname], format('[[Category:%s|%s]]', cat, sort))
        else
            tinsert(self[tname], format('[[Category:%s]]', cat))
        end
    end


    function box:addClass(class)
    return setmetatable(obj, MessageBox)
        if type(class) ~= 'string' then return end
        self.classes = self.classes or {}
        tinsert(self.classes, class)
    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()
    end
        self.demospace = args.demospace ~= '' and args.demospace or nil
    if sort then
        self.nsid = box.getNamespaceId(self.demospace) or self.title.namespace
    cat = string.format('[[Category:%s|%s]]', cat, sort)
    else
    cat = string.format('[[Category:%s]]', cat)
    end
    self.hasCategories = true
    self.categories[ns] = self.categories[ns] or {}
    table.insert(self.categories[ns], cat)
    end
    end


    function box:getConfig(boxType)
    function MessageBox:addClass(class)
        -- Get the box config data from the data page.
    if not class then
        if boxType == 'mbox' then
    return nil
            boxType = box.getMboxType(self.nsid)
    end
        end
    table.insert(self.classes, class)
        local cfgTables = mw.loadData('Module:Message box/configuration')
        local cfg = cfgTables[boxType]
        if not cfg then
            local boxTypes = {}
            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
        return cfg
    end
       
    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
            if v ~= '' then
                newArgs[k] = v
            end
        end
        for i, param in ipairs(cfg.allowBlankParams or {}) do
            newArgs[param] = args[param]
        end
        return newArgs
    end
    end


    function box:setBoxParameters(cfg, args)
    function MessageBox:setParameters()
        -- Get type data.
    local args = self.args
        self.type = args.type
    local cfg = self.cfg
        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.typeImage = typeData.image


        -- Find if the box has been wrongly substituted.
    -- Get type data.
        if cfg.substCheck and args.subst == 'SUBST' then
    self.type = args.type
            self.isSubstituted = true
    local typeData = cfg.types[self.type]
        end
    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 whether we are using a small message box.
    -- Find if the box has been wrongly substituted.
        if cfg.allowSmall and (
    self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'
                cfg.smallParam and args.small == cfg.smallParam
                or not cfg.smallParam and yesno(args.small)
        )
        then
            self.isSmall = true
        else
            self.isSmall = false
        end
               


        -- Add attributes, classes and styles.
    -- Find whether we are using a small message box.
        self.id = args.id
    self.isSmall = cfg.allowSmall and (
        self:addClass(cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks')
    cfg.smallParam and args.small == cfg.smallParam
        for _, class in ipairs(cfg.classes or {}) do
    or not cfg.smallParam and yesno(args.small)
            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


        -- Set text style.
    -- Add attributes, classes and styles.
        self.textstyle = args.textstyle
    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


        -- Process data for collapsible text fields. At the moment these are only used in {{ambox}}.
    -- Set text style.
        self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
    self.textstyle = args.textstyle
        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.
    -- Find if we are on the template page or not. This functionality is only
            if self.isSmall and args.smalltext then
    -- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
                self.issue = args.smalltext
    -- and cfg.templateCategoryRequireName are set.
            else
    self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
                local sect
    if self.useCollapsibleTextFields
                if args.sect == '' then
    or cfg.templateCategory
                    sect = 'This ' .. (cfg.sectionDefault or 'page')
    and cfg.templateCategoryRequireName
                elseif type(args.sect) == 'string' then
    then
                    sect = 'This ' .. sect
    if self.name then
                end
    local templateName = mw.ustring.match(
                local issue = args.issue
    self.name,
                issue = type(issue) == 'string' and issue or nil
    '^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
                local text = args.text
    ) or self.name
                text = type(text) == 'string' and text or nil
    templateName = 'Template:' .. templateName
                local issues = {}
    self.templateTitle = getTitleObject(templateName)
                tinsert(issues, sect)
    end
                tinsert(issues, issue)
    self.isTemplatePage = self.templateTitle
                tinsert(issues, text)
    and mw.title.equals(self.title, self.templateTitle)
                self.issue = tconcat(issues, ' ')
    end
            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.
    -- Get the self.talk value.
            local talk = args.talk
    local talk = args.talk
            if talk == '' and self.isTemplatePage then
    -- Show talk links on the template page or template subpages if the talk
                talk = '#'
    -- parameter is blank.
            end
    if talk == ''
            if talk then
    and self.templateTitle
                -- See if the talk link exists and is for a talk or a content namespace.
    and (
                local talkTitle = getTitleObject(talk)
    mw.title.equals(self.templateTitle, self.title)
                if not talkTitle or not talkTitle.isTalkPage then
    or self.title:isSubpageOf(self.templateTitle)
                    -- If we couldn't process the talk page link, get the talk page of the current page.
    )
                    local success
    then
                    success, talkTitle = pcall(self.title.talkPageTitle, self.title)
    talk = '#'
                    if not success then
    elseif talk == '' then
                        talkTitle = nil
    talk = nil
                    end
    end
                end
    if talk then
                if talkTitle and talkTitle.exists then
    -- If the talk value is a talk page, make a link to that page. Else
                     local talkText = 'Relevant discussion may be found on'
    -- assume that it's a section heading, and make a link to the talk
                     if talkTitle.isTalkPage then
    -- page of the current page with that section heading.
                         talkText = format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText)
    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
                     else
                         talkText = format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk)
                         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
    self.talk = talkText
                end
    end
            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(" <small class='date-container'>''(<span class='date'>%s</span>)''</small>", date)
    end
    self.info = args.info
    if yesno(args.removalnotice) then
    self.removalNotice = cfg.removalNotice
    end
    end


            -- Get other values.
    -- Set the non-collapsible text field. At the moment this is used by all box
            self.fix = args.fix
    -- types other than ambox, and also by ambox when small=yes.
            if args.date and args.date ~= '' then
    if self.isSmall then
                self.date = format(" <small>''(%s)''</small>", args.date)
    self.text = args.smalltext or args.text
            elseif args.date == '' and self.isTemplatePage then
    else
                self.date = lang:formatDate('F Y')
    self.text = args.text
            end
    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,
    -- Set the below row.
        -- and also by ambox when small=yes.
    self.below = cfg.below and args.below
        if self.isSmall then
            self.text = args.smalltext or args.text
        else
            self.text = args.text
        end


        -- Set the below row.
    -- General image settings.
        self.below = cfg.below and args.below
    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


        -- General image settings.
    -- Left image settings.
        self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
    local imageLeft = self.isSmall and args.smallimage or args.image
        self.imageEmptyCell = cfg.imageEmptyCell
    if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
        if cfg.imageEmptyCellStyle then
    or not cfg.imageCheckBlank and imageLeft ~= 'none'
            self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
    then
        end
    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


        -- Left image settings.
    -- Right image settings.
        local imageLeft = self.isSmall and args.smallimage or args.image
    local imageRight = self.isSmall and args.smallimageright or args.imageright
        if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
    if not (cfg.imageRightNone and imageRight == 'none') then
            or not cfg.imageCheckBlank and imageLeft ~= 'none'
    self.imageRight = imageRight
        then
    end
            self.imageLeft = imageLeft
    end
            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


        -- Right image settings.
    function MessageBox:setMainspaceCategories()
        local imageRight = self.isSmall and args.smallimageright or args.imageright
    local args = self.args
        if not (cfg.imageRightNone and imageRight == 'none') then
    local cfg = self.cfg
            self.imageRight = imageRight
        end


        -- Add mainspace categories. At the moment these are only used in {{ambox}}.
    if not cfg.allowMainspaceCategories then
        if cfg.allowMainspaceCategories then
    return nil
            if args.cat then
    end
                args.cat1 = args.cat
     
            end
    local nums = {}
            self.catNums = getArgNums(args, 'cat')
    for _, prefix in ipairs{'cat', 'category', 'all'} do
            if args.category then
    args[prefix .. '1'] = args[prefix]
                args.category1 = args.category
    nums = union(nums, getArgNums(args, prefix))
            end
    end
            self.categoryNums = getArgNums(args, 'category')
     
            self.categoryParamNums = union(self.catNums, self.categoryNums)
    -- The following is roughly equivalent to the old {{Ambox/category}}.
            -- The following is roughly equivalent to the old {{Ambox/category}}.
    local date = args.date
            local date = args.date
    date = type(date) == 'string' and date
            date = type(date) == 'string' and date
    local preposition = 'from'
            local preposition = 'from'
    for _, num in ipairs(nums) do
            for _, num in ipairs(self.categoryParamNums) do
    local mainCat = args['cat' .. tostring(num)]
                local mainCat = args['cat' .. tostring(num)] or args['category' .. tostring(num)]
    or args['category' .. tostring(num)]
                local allCat = args['all' .. tostring(num)]
    local allCat = args['all' .. tostring(num)]
                mainCat = type(mainCat) == 'string' and mainCat
    mainCat = type(mainCat) == 'string' and mainCat
                allCat = type(allCat) == 'string' and allCat
    allCat = type(allCat) == 'string' and allCat
                if mainCat and date then
    if mainCat and date and date ~= '' then
                    local catTitle = format('%s %s %s', mainCat, preposition, date)
    local catTitle = string.format('%s %s %s', mainCat, preposition, date)
                    self:addCat('main', catTitle)
    self:addCat(0, catTitle)
                    catTitle = getTitleObject('Category:' .. catTitle)
    catTitle = getTitleObject('Category:' .. catTitle)
                    if not catTitle or not catTitle.exists then
    if not catTitle or not catTitle.exists then
                        self:addCat('main', 'Articles with invalid date parameter in template')
    self:addCat(0, 'Articles with invalid date parameter in template')
                    end
    end
                elseif mainCat and not date then
    elseif mainCat and (not date or date == '') then
                    self:addCat('main', mainCat)
    self:addCat(0, mainCat)
                end
    end
                if allCat then
    if allCat then
                    self:addCat('main', allCat)
    self:addCat(0, allCat)
                end
    end
            end
    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-namespace categories.
    -- Add template error categories.
        self.isTemplatePage = type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name)
    if cfg.templateErrorCategory then
        if cfg.templateCategory then
    local templateErrorCategory = cfg.templateErrorCategory
            if self.name then
    local templateCat, templateSort
                if self.isTemplatePage then
    if not self.name and not self.title.isSubpage then
                    self:addCat('template', cfg.templateCategory)
    templateCat = templateErrorCategory
                end
    elseif self.isTemplatePage then
            elseif not self.title.isSubpage then
    local paramsToCheck = cfg.templateErrorParamsToCheck or {}
                self:addCat('template', cfg.templateCategory)
    local count = 0
            end
    for i, param in ipairs(paramsToCheck) do
        end
    if not args[param] then
       
    count = count + 1
        -- Add template error category.
    end
        if cfg.templateErrorCategory then
    end
            local templateErrorCategory = cfg.templateErrorCategory
    if count > 0 then
            local templateCat, templateSort
    templateCat = templateErrorCategory
            if not self.name and not self.title.isSubpage then
    templateSort = tostring(count)
                templateCat = templateErrorCategory
    end
            elseif type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name) then
    if self.categoryNums and #self.categoryNums > 0 then
                local paramsToCheck = cfg.templateErrorParamsToCheck or {}
    templateCat = templateErrorCategory
                local count = 0
    templateSort = 'C'
                for i, param in ipairs(paramsToCheck) do
    end
                    if not args[param] then
    end
                        count = count + 1
    self:addCat(10, templateCat, templateSort)
                    end
    end
                end
    end
                if count > 0 then
                    templateCat = templateErrorCategory
                    templateSort = tostring(count)
                end
                if self.categoryNums and #self.categoryNums > 0 then
                    templateCat = templateErrorCategory
                    templateSort = 'C'
                end
            end
            self:addCat('template', templateCat, templateSort)
        end


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


        -- Convert category tables to strings and pass them through [[Module:Category handler]].
    function MessageBox:setCategories()
        self.categories = categoryHandler{
    if self.title.namespace == 0 then
            main = tconcat(self.mainCats or {}),
    self:setMainspaceCategories()
            template = tconcat(self.templateCats or {}),
    elseif self.title.namespace == 10 then
            all = tconcat(self.allCats or {}),
    self:setTemplateCategories()
            nocat = args.nocat,
    end
            demospace = self.demospace,
    self:setAllNamespaceCategories()
            page = self.pageTitle and self.pageTitle.prefixedText or nil
        }
    end
    end


    function box:export()
    function MessageBox:renderCategories()
        local root = htmlBuilder.create()
    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


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


        -- Create the box table.
    -- Add the subst check error.
        local boxTable = root.tag('table')
    if self.isSubstituted and self.name then
        boxTable
    root:tag('b')
            .attr('id', self.id)
    :addClass('error')
        for i, class in ipairs(self.classes or {}) do
    :wikitext(string.format(
            boxTable
    'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
                .addClass(class)
    mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
        end
    ))
        boxTable
    end
            .cssText(self.style)
            .attr('role', 'presentation')


        -- Add the left-hand image.
    -- Create the box table.
        local row = boxTable.tag('tr')
    local boxTable = root:tag('table')
        if self.imageLeft then
    boxTable:attr('id', self.id or nil)
            local imageLeftCell = row.tag('td').addClass('mbox-image')
    for i, class in ipairs(self.classes or {}) do
            if self.imageCellDiv then
    boxTable:addClass(class or nil)
                -- If we are using a div, redefine imageLeftCell so that the image is inside it.
    end
                -- Divs use style="width: 52px;", which limits the image width to 52px. If any
    boxTable
                -- images in a div are wider than that, they may overlap with the text or cause
    :cssText(self.style or nil)
                -- other display problems.
    :attr('role', 'presentation')
                imageLeftCell = imageLeftCell.tag('div').css('width', '52px')  
            end
            imageLeftCell
                .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')  
                .cssText(self.imageEmptyCellStyle)
        end


        -- Add the text.
    if self.attrs then
        local textCell = row.tag('td').addClass('mbox-text')
    boxTable:attr(self.attrs)
        if self.useCollapsibleTextFields then
    end
            -- 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 textCellSpan = textCell.tag('span')
            textCellSpan
                .addClass('mbox-text-span')
                .wikitext(self.issue)
            if not self.isSmall then
                textCellSpan
                    .tag('span')
                        .addClass('hide-when-compact')
                        .wikitext(self.talk and ' ' .. self.talk)
                        .wikitext(self.fix and ' ' .. self.fix)
            end
            textCellSpan
                .wikitext(self.date and ' ' .. self.date)
            if not self.isSmall then
                textCellSpan
                    .tag('span')
                        .addClass('hide-when-compact')
                        .wikitext(self.info and ' ' .. self.info)
            end
        else
            -- Default text formatting - anything goes.
            textCell
                .cssText(self.textstyle)
                .wikitext(self.text)
        end


        -- Add the right-hand image.
    -- Add the left-hand image.
        if self.imageRight then
    local row = boxTable:tag('tr')
            local imageRightCell = row.tag('td').addClass('mbox-imageright')
    if self.imageLeft then
            if self.imageCellDiv then
    local imageLeftCell = row:tag('td'):addClass('mbox-image')
                imageRightCell = imageRightCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
    if self.imageCellDiv then
            end
    -- If we are using a div, redefine imageLeftCell so that the image
            imageRightCell
    -- is inside it. Divs use style="width: 52px;", which limits the
                .wikitext(self.imageRight)
    -- image width to 52px. If any images in a div are wider than that,
        end
    -- they may overlap with the text or cause other display problems.
    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 below row.
    -- Add the text.
        if self.below then
    local textCell = row:tag('td'):addClass('mbox-text')
            boxTable.tag('tr')
    if self.useCollapsibleTextFields then
                .tag('td')
    -- The message box uses advanced text parameters that allow things to be
                    .attr('colspan', self.imageRight and '3' or '2')
    -- collapsible. At the moment, only ambox uses this.
                    .addClass('mbox-text')
    textCell:cssText(self.textstyle or nil)
                    .cssText(self.textstyle)
    local textCellDiv = textCell:tag('div')
                    .wikitext(self.below)
    textCellDiv
        end
    :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('small')
    :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'):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


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


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


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


    local function makeBox(boxType, args)
    function p.main(boxType, args, cfgTables)
        box:setTitle(args)
    local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE))
        local cfg = box:getConfig(boxType)
    box:setParameters()
        args = box:removeBlankArgs(cfg, args)
    box:setCategories()
        box:setBoxParameters(cfg, args)
    return box:export()
        return box:export()
    end
    end


    local function makeWrapper(boxType)
    function mt.__index(t, k)
        return function (frame)
    return function (frame)
            -- If called via #invoke, use the args passed into the invoking
    if not getArgs then
            -- template, or the args passed to #invoke if any exist. Otherwise
    getArgs = require('Module:Arguments').getArgs
            -- assume args are being passed directly in from the debug console
    end
            -- or from another Lua module.
    return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
            local origArgs
    end
            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
            -- 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 makeBox(boxType, args)
        end
    end
    end


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

    Latest revision as of 11:42, 21 May 2021

    Documentation for this module may be created at Module:Message box/doc

    -- This is a meta-module for producing message box templates, including
    -- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
    
    -- Load necessary modules.
    require('Module:No globals')
    local getArgs
    local yesno = require('Module:Yesno')
    
    -- Get a language object for formatDate and ucfirst.
    local lang = mw.language.getContentLanguage()
    
    -- Define constants
    local CONFIG_MODULE = 'Module:Message box/configuration'
    local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}
    
    --------------------------------------------------------------------------------
    -- Helper functions
    --------------------------------------------------------------------------------
    
    local function getTitleObject(...)
    	-- Get the title object, passing the function through pcall
    	-- in case we are over the expensive function count limit.
    	local success, title = pcall(mw.title.new, ...)
    	if success then
    		return title
    	end
    end
    
    local function union(t1, t2)
    	-- Returns the union of two arrays.
    	local vals = {}
    	for i, v in ipairs(t1) do
    		vals[v] = true
    	end
    	for i, v in ipairs(t2) do
    		vals[v] = true
    	end
    	local ret = {}
    	for k in pairs(vals) do
    		table.insert(ret, k)
    	end
    	table.sort(ret)
    	return ret
    end
    
    local function getArgNums(args, prefix)
    	local nums = {}
    	for k, v in pairs(args) do
    		local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
    		if num then
    			table.insert(nums, tonumber(num))
    		end
    	end
    	table.sort(nums)
    	return nums
    end
    
    --------------------------------------------------------------------------------
    -- Box class definition
    --------------------------------------------------------------------------------
    
    local MessageBox = {}
    MessageBox.__index = MessageBox
    
    function MessageBox.new(boxType, args, cfg)
    	args = args or {}
    	local obj = {}
    
    	-- Set the title object and the namespace.
    	obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
    
    	-- Set the config for our box type.
    	obj.cfg = cfg[boxType]
    	if not obj.cfg then
    		local ns = obj.title.namespace
    		-- boxType is "mbox" or invalid input
    		if args.demospace and args.demospace ~= '' then
    			-- implement demospace parameter of mbox
    			local demospace = string.lower(args.demospace)
    			if DEMOSPACES[demospace] then
    				-- use template from DEMOSPACES
    				obj.cfg = cfg[DEMOSPACES[demospace]]
    			elseif string.find( demospace, 'talk' ) then
    				-- demo as a talk page
    				obj.cfg = cfg.tmbox
    			else
    				-- default to ombox
    				obj.cfg = cfg.ombox
    			end
    		elseif ns == 0 then
    			obj.cfg = cfg.ambox -- main namespace
    		elseif ns == 6 then
    			obj.cfg = cfg.imbox -- file namespace
    		elseif ns == 14 then
    			obj.cfg = cfg.cmbox -- category namespace
    		else
    			local nsTable = mw.site.namespaces[ns]
    			if nsTable and nsTable.isTalk then
    				obj.cfg = cfg.tmbox -- any talk namespace
    			else
    				obj.cfg = cfg.ombox -- other namespaces or invalid input
    			end
    		end
    	end
    
    	-- Set the arguments, and remove all blank arguments except for the ones
    	-- listed in cfg.allowBlankParams.
    	do
    		local newArgs = {}
    		for k, v in pairs(args) do
    			if v ~= '' then
    				newArgs[k] = v
    			end
    		end
    		for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
    			newArgs[param] = args[param]
    		end
    		obj.args = newArgs
    	end
    
    	-- Define internal data structure.
    	obj.categories = {}
    	obj.classes = {}
    	-- For lazy loading of [[Module:Category handler]].
    	obj.hasCategories = false
    
    	return setmetatable(obj, MessageBox)
    end
    
    function MessageBox:addCat(ns, cat, sort)
    	if not cat then
    		return nil
    	end
    	if sort then
    		cat = string.format('[[Category:%s|%s]]', cat, sort)
    	else
    		cat = string.format('[[Category:%s]]', cat)
    	end
    	self.hasCategories = true
    	self.categories[ns] = self.categories[ns] or {}
    	table.insert(self.categories[ns], cat)
    end
    
    function MessageBox:addClass(class)
    	if not class then
    		return nil
    	end
    	table.insert(self.classes, class)
    end
    
    function MessageBox:setParameters()
    	local args = self.args
    	local cfg = self.cfg
    
    	-- Get type data.
    	self.type = args.type
    	local typeData = cfg.types[self.type]
    	self.invalidTypeError = cfg.showInvalidTypeError
    		and self.type
    		and not typeData
    	typeData = typeData or cfg.types[cfg.default]
    	self.typeClass = typeData.class
    	self.typeImage = typeData.image
    
    	-- 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
    				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(" <small class='date-container'>''(<span class='date'>%s</span>)''</small>", 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
    	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('[[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
    end
    
    function MessageBox:setMainspaceCategories()
    	local args = self.args
    	local cfg = self.cfg
    
    	if not cfg.allowMainspaceCategories then
    		return nil
    	end
    
    	local nums = {}
    	for _, prefix in ipairs{'cat', 'category', 'all'} do
    		args[prefix .. '1'] = args[prefix]
    		nums = union(nums, getArgNums(args, prefix))
    	end
    
    	-- The following is roughly equivalent to the old {{Ambox/category}}.
    	local date = args.date
    	date = type(date) == 'string' and date
    	local preposition = 'from'
    	for _, num in ipairs(nums) do
    		local mainCat = args['cat' .. tostring(num)]
    			or args['category' .. tostring(num)]
    		local allCat = args['all' .. tostring(num)]
    		mainCat = type(mainCat) == 'string' and mainCat
    		allCat = type(allCat) == 'string' and allCat
    		if mainCat and date and date ~= '' then
    			local catTitle = string.format('%s %s %s', mainCat, preposition, date)
    			self:addCat(0, catTitle)
    			catTitle = getTitleObject('Category:' .. catTitle)
    			if not catTitle or not catTitle.exists then
    				self:addCat(0, 'Articles with invalid date parameter in template')
    			end
    		elseif mainCat and (not date or date == '') then
    			self:addCat(0, mainCat)
    		end
    		if allCat then
    			self:addCat(0, allCat)
    		end
    	end
    end
    
    function MessageBox:setTemplateCategories()
    	local args = self.args
    	local cfg = self.cfg
    
    	-- Add template categories.
    	if cfg.templateCategory then
    		if cfg.templateCategoryRequireName then
    			if self.isTemplatePage then
    				self:addCat(10, cfg.templateCategory)
    			end
    		elseif not self.title.isSubpage then
    			self:addCat(10, cfg.templateCategory)
    		end
    	end
    
    	-- Add template error categories.
    	if cfg.templateErrorCategory then
    		local templateErrorCategory = cfg.templateErrorCategory
    		local templateCat, templateSort
    		if not self.name and not self.title.isSubpage then
    			templateCat = templateErrorCategory
    		elseif self.isTemplatePage then
    			local paramsToCheck = cfg.templateErrorParamsToCheck or {}
    			local count = 0
    			for i, param in ipairs(paramsToCheck) do
    				if not args[param] then
    					count = count + 1
    				end
    			end
    			if count > 0 then
    				templateCat = templateErrorCategory
    				templateSort = tostring(count)
    			end
    			if self.categoryNums and #self.categoryNums > 0 then
    				templateCat = templateErrorCategory
    				templateSort = 'C'
    			end
    		end
    		self:addCat(10, templateCat, templateSort)
    	end
    end
    
    function MessageBox:setAllNamespaceCategories()
    	-- Set categories for all namespaces.
    	if self.invalidTypeError then
    		local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
    		self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
    	end
    	if self.isSubstituted then
    		self:addCat('all', 'Pages with incorrectly substituted templates')
    	end
    end
    
    function MessageBox:setCategories()
    	if self.title.namespace == 0 then
    		self:setMainspaceCategories()
    	elseif self.title.namespace == 10 then
    		self:setTemplateCategories()
    	end
    	self:setAllNamespaceCategories()
    end
    
    function MessageBox:renderCategories()
    	if not self.hasCategories then
    		-- No categories added, no need to pass them to Category handler so,
    		-- if it was invoked, it would return the empty string.
    		-- So we shortcut and return the empty string.
    		return ""
    	end
    	-- Convert category tables to strings and pass them through
    	-- [[Module:Category handler]].
    	return require('Module:Category handler')._main{
    		main = table.concat(self.categories[0] or {}),
    		template = table.concat(self.categories[10] or {}),
    		all = table.concat(self.categories.all or {}),
    		nocat = self.args.nocat,
    		page = self.args.page
    	}
    end
    
    function MessageBox:export()
    	local root = mw.html.create()
    
    	-- Add the subst check error.
    	if self.isSubstituted and self.name then
    		root:tag('b')
    			:addClass('error')
    			:wikitext(string.format(
    				'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
    				mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
    			))
    	end
    
    	-- 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 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('small')
    				: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'):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(CONFIG_MODULE))
    	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)