Module:Message box: Difference between revisions

Jump to navigation Jump to search
← Older edit
m>Mr. Stradivarius
replace remaining "title" variables with "self.title"
MeowyCats2 (talk | contribs)
Bureaucrats, Interface administrators, Stewards, Administrators
38 edits
m 125 revisions imported
 
(108 intermediate revisions by 45 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}}.
require('Module:No globals')
 
local getArgs
-- Require necessary modules.
local htmlBuilder = require('Module:HtmlBuilder')
local categoryHandler = require('Module:Category handler').main
local yesno = require('Module:Yesno')
local yesno = require('Module:Yesno')
-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()
local lang = mw.language.getContentLanguage()


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


local function getTitleObject(page)
--------------------------------------------------------------------------------
    if type(page) == 'string' then
-- Helper functions
        -- 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, page)
        if success then
            return title
        end
    end
end


local function presentButBlank(s)
local function getTitleObject(...)
    if type(s) ~= 'string' then return end
-- Get the title object, passing the function through pcall
    if s and not mw.ustring.find(s, '%S') then
-- in case we are over the expensive function count limit.
        return true
local success, title = pcall(mw.title.new, ...)
    else
if success then
        return false
return title
    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.invalidType = 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.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(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
        local sect = args.sect
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
        if presentButBlank(sect) then
-- and cfg.templateCategoryRequireName are set.
            sect = 'This ' .. (cfg.sectionDefault or 'page')
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
        elseif type(sect) == 'string' then
if self.useCollapsibleTextFields
            sect = 'This ' .. sect
or cfg.templateCategory
        else
and cfg.templateCategoryRequireName
            sect = nil
then
        end
if self.name then
        local issue = args.issue
local templateName = mw.ustring.match(
        issue = type(issue) == 'string' and issue or nil
self.name,
        local text = args.text
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
        text = type(text) == 'string' and text or nil
) or self.name
        local issues = {}
templateName = 'Template:' .. templateName
        tinsert(issues, sect)
self.templateTitle = getTitleObject(templateName)
        tinsert(issues, issue)
end
        tinsert(issues, text)
self.isTemplatePage = self.templateTitle
        self.issue = tconcat(issues, ' ')
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.
-- Get the self.talk value.
        local talk = args.talk
local talk = args.talk
        if presentButBlank(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(" <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


        -- Get other values.
function MessageBox:setMainspaceCategories()
        self.fix = args.fix
local args = self.args
        local date = args.date
local cfg = self.cfg
        self.date = date and format(" <small>''(%s)''</small>", date)
        if presentButBlank(self.date) and self.isTemplatePage then
            self.date = lang:formatDate('F Y')
        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,
if not cfg.allowMainspaceCategories then
    -- and also by ambox when small=yes.
return nil
    if self.isSmall then
end
        if self.useCollapsibleTextFields then
            self.text = args.smalltext or self.issue
        else
            self.text = args.smalltext or args.text
        end
    else
        self.text = args.text
    end


    -- Set the below row.
local nums = {}
    self.below = cfg.below and args.below
for _, prefix in ipairs{'cat', 'category', 'all'} do
args[prefix .. '1'] = args[prefix]
nums = union(nums, getArgNums(args, prefix))
end


    -- General image settings.
-- The following is roughly equivalent to the old {{Ambox/category}}.
    self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
local date = args.date
    self.imageEmptyCell = cfg.imageEmptyCell
date = type(date) == 'string' and date
    if cfg.imageEmptyCellStyle then
local preposition = 'from'
        self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
for _, num in ipairs(nums) do
    end
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


    -- Left image settings.
function MessageBox:setTemplateCategories()
    local imageCheckBlank = cfg.imageCheckBlank
local args = self.args
    local imageLeft = self.isSmall and args.smallimage or args.image
local cfg = self.cfg
    if imageLeft ~= 'none' and not imageCheckBlank or imageLeft ~= 'none' and imageCheckBlank and image ~= 'blank' then
        self.imageLeft = imageLeft
        if not imageLeft then
            local imageSize = self.isSmall and (cfg.imageSmallSize or '30x30px') or '40x40px'
            self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage or 'Imbox notice.png', imageSize)
        end
    end


    -- Right image settings.
-- Add template categories.
    local imageRight = self.isSmall and args.smallimageright or args.imageright
if cfg.templateCategory then
    if not (cfg.imageRightNone and imageRight == 'none') then
if cfg.templateCategoryRequireName then
        self.imageRight = imageRight
if self.isTemplatePage then
    end
self:addCat(10, cfg.templateCategory)
end
elseif not self.title.isSubpage then
self:addCat(10, cfg.templateCategory)
end
end


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


    -- Add template-namespace categories.
function MessageBox:setAllNamespaceCategories()
    self.isTemplatePage = type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name)
-- Set categories for all namespaces.
    if cfg.templateCategory then
if self.invalidTypeError then
        if self.name then
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
            if self.isTemplatePage then
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
                self:addCat('template', cfg.templateCategory)
end
            end
if self.isSubstituted then
        elseif not self.title.isSubpage then
self:addCat('all', 'Pages with incorrectly substituted templates')
            self:addCat('template', cfg.templateCategory)
end
        end
end
    end
   
    -- Add template error category.
    if cfg.templateErrorCategory then
        local templateErrorCategory = cfg.templateErrorCategory
        local templateCat, templateSort
        if not self.name and not self.title.isSubpage then
            templateCat = templateErrorCategory
        elseif type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. name) 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('template', templateCat, templateSort)
    end


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


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


function box:export()
function MessageBox:export()
    local root = htmlBuilder.create()
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
 
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 subst check error.
-- Add the text.
    if self.isSubstituted and self.name then
local textCell = row:tag('td'):addClass('mbox-text')
        root
if self.useCollapsibleTextFields then
            .tag('b')
-- The message box uses advanced text parameters that allow things to be
                .addClass('error')
-- collapsible. At the moment, only ambox uses this.
                .wikitext(format(
textCell:cssText(self.textstyle or nil)
                    'Template <code>%s%s%s</code> has been incorrectly substituted.',
local textCellDiv = textCell:tag('div')
                    mw.text.nowiki('{{'), self.name, mw.text.nowiki('}}')
textCellDiv
                ))
:addClass('mbox-text-span')
    end
: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


    -- Create the box table.
-- Add the right-hand image.
    local boxTable = root.tag('table')
if self.imageRight then
    boxTable
local imageRightCell = row:tag('td'):addClass('mbox-imageright')
        .attr('id', self.id)
if self.imageCellDiv then
    for i, class in ipairs(self.classes or {}) do
-- If we are using a div, redefine imageRightCell so that the image
        boxTable
-- is inside it.
            .addClass(class)
imageRightCell = imageRightCell:tag('div'):addClass('mbox-image-div')
    end
end
    boxTable
imageRightCell
        .cssText(self.style)
:wikitext(self.imageRight or nil)
        .attr('role', 'presentation')
end


    -- Add the left-hand image.
-- Add the below row.
    local row = boxTable.tag('tr')
if self.below then
    if self.imageLeft then
boxTable:tag('tr')
        local imageLeftCell = row.tag('td').addClass('mbox-image')
:tag('td')
        if self.imageCellDiv then
:attr('colspan', self.imageRight and '3' or '2')
            -- If we are using a div, redefine imageLeftCell so that the image is inside it.
:addClass('mbox-text')
            -- Not sure why only some box types use divs, but it probably has something to do
:cssText(self.textstyle or nil)
            -- with that style="width: 52px;". @TODO: find out exactly what this does and fix this comment.
:wikitext(self.below or nil)
            imageLeftCell = imageLeftCell.tag('div').css('width', '52px')
end
        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.
-- Add error message for invalid type parameters.
    local textCell = row.tag('td').addClass('mbox-text')
if self.invalidTypeError then
    if self.useCollapsibleTextFields then
root:tag('div')
        -- The message box uses advanced text parameters that allow things to be collapsible. At the
:addClass('mbox-invalid-type')
        -- moment, only ambox uses this.
:wikitext(string.format(
        textCell
'This message box is using an invalid "type=%s" parameter and needs fixing.',
            .cssText(self.textstyle)
self.type or ''
        local textCellSpan = textCell.tag('span')
))
        textCellSpan
end
            .addClass('mbox-text-span')
            .wikitext(self.issue)
        if not 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 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 categories.
    if self.imageRight then
root:wikitext(self:renderCategories() or nil)
        local imageRightCell = row.tag('td').addClass('mbox-imageright')
        if self.imageCellDiv then
            imageRightCell = imageRightCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
        end
        imageRightCell
            .wikitext(self.imageRight)
    end


    -- Add the below row.
return tostring(root)
    if self.below then
end
        boxTable.tag('tr')
            .tag('td')
                .attr('colspan', self.imageRight and '3' or '2')
                .addClass('mbox-text')
                .cssText(self.textstyle)
                .wikitext(self.below)
    end


    -- Add error message for invalid type parameters.
--------------------------------------------------------------------------------
    if self.invalidType 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 args
end
        if frame == mw.getCurrentFrame() then
            args = frame:getParent().args
            for k, v in pairs(frame.args) do
                args = frame.args
                break
            end
        else
            args = frame
        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')
}
Retrieved from "https://meta.skywiki.org/wiki/Module:Message_box"