Editing Module:Message box

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

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

Latest revision Your text
Line 1: Line 1:
require('Module:No globals')
-- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
local getArgs
 
-- 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()


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


--------------------------------------------------------------------------------
local function getTitleObject(page)
-- Helper functions
    if type(page) == 'string' then
--------------------------------------------------------------------------------
        -- Get the title object, passing the function through pcall
        -- in case we are over the expensive function count limit.
        local success, title = pcall(mw.title.new, page)
        if success then
            return title
        end
    end
end


local function getTitleObject(...)
local function presentButBlank(s)
-- Get the title object, passing the function through pcall
    if type(s) ~= 'string' then return end
-- in case we are over the expensive function count limit.
    if s and not mw.ustring.find(s, '%S') then
local success, title = pcall(mw.title.new, ...)
        return true
if success then
    else
return title
        return false
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
table.insert(ret, k)
        tinsert(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
table.insert(nums, tonumber(num))
            tinsert(nums, tonumber(num))
end
        end
end
    end
table.sort(nums)
    table.sort(nums)
return nums
    return nums
end
end


--------------------------------------------------------------------------------
function box.getNamespaceId(ns)
-- Box class definition
    if not ns then return end
--------------------------------------------------------------------------------
    if type(ns) == 'string' then
        ns = lang:ucfirst(mw.ustring.lower(ns))
        if ns == 'Main' then
            ns = 0
        end
    end
    local nsTable = mw.site.namespaces[ns]
    if nsTable then
        return nsTable.id
    end
end


local MessageBox = {}
function box.getMboxType(nsid)
MessageBox.__index = MessageBox
    -- Gets the mbox type from a namespace number.
    if nsid == 0 then
        return 'ambox' -- main namespace
    elseif nsid == 6 then
        return 'imbox' -- file namespace
    elseif nsid == 14 then
        return 'cmbox' -- category namespace
    else
        local nsTable = mw.site.namespaces[nsid]
        if nsTable and nsTable.isTalk then
            return 'tmbox' -- any talk namespace
        else
            return 'ombox' -- other namespaces or invalid input
        end
    end
end


function MessageBox.new(boxType, args, cfg)
function box:addCat(ns, cat, sort)
args = args or {}
    if type(cat) ~= 'string' then return end
local obj = {}
    local nsVals = {'main', 'template', 'all'}
    local tname
    for i, val in ipairs(nsVals) do
        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


-- Set the title object and the namespace.
function box:addClass(class)
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
    if type(class) ~= 'string' then return end
 
    self.classes = self.classes or {}
-- Set the config for our box type.
    tinsert(self.classes, class)
obj.cfg = cfg[boxType]
end
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)
function box:setTitle(args)
    -- Get the title object and the namespace.
    self.pageTitle = getTitleObject(args.page ~= '' and args.page)
    self.title = self.pageTitle or mw.title.getCurrentTitle()
    self.demospace = args.demospace ~= '' and args.demospace or nil
    self.nsid = box.getNamespaceId(self.demospace) or self.title.namespace
end
end


function MessageBox:addCat(ns, cat, sort)
function box:getConfig(boxType)
if not cat then
    -- Get the box config data from the data page.
return nil
    if boxType == 'mbox' then
end
        boxType = box.getMboxType(self.nsid)
if sort then
    end
cat = string.format('[[Category:%s|%s]]', cat, sort)
    local cfgTables = mw.loadData('Module:Message box/configuration')
else
    local cfg = cfgTables[boxType]
cat = string.format('[[Category:%s]]', cat)
    if not cfg then
end
        local boxTypes = {}
self.hasCategories = true
        for k, v in pairs(dataTables) do
self.categories[ns] = self.categories[ns] or {}
            tinsert(boxTypes, format('"%s"', k))
table.insert(self.categories[ns], cat)
        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
end
 
   
function MessageBox:addClass(class)
function box:removeBlankArgs(cfg, args)
if not class then
    -- Only allow blank arguments for the parameter names listed in cfg.allowBlankParams.
return nil
    local newArgs = {}
end
    for k, v in pairs(args) do
table.insert(self.classes, class)
        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 MessageBox:setParameters()
function box:setBoxParameters(cfg, args)
local args = self.args
    -- Get type data.
local cfg = self.cfg
    self.type = args.type
    local typeData = cfg.types[self.type]
    self.invalidTypeError = cfg.showInvalidTypeError and self.type and not typeData and true or false
    typeData = typeData or cfg.types[cfg.default]
    self.typeClass = typeData.class
    self.typeImage = typeData.image


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


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


-- Add attributes, classes and styles.
    -- Set text style.
self.id = args.id
    self.textstyle = args.textstyle
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.
    -- Process data for collapsible text fields. At the moment these are only used in {{ambox}}.
self.textstyle = args.textstyle
    self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
    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


-- Find if we are on the template page or not. This functionality is only
        -- Get the self.issue value.
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
        local sect = args.sect
-- and cfg.templateCategoryRequireName are set.
        if presentButBlank(sect) then
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
            sect = 'This ' .. (cfg.sectionDefault or 'page')
if self.useCollapsibleTextFields
        elseif type(sect) == 'string' then
or cfg.templateCategory
            sect = 'This ' .. sect
and cfg.templateCategoryRequireName
        else
then
            sect = nil
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
-- 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
-- Show talk links on the template page or template subpages if the talk
        if presentButBlank(talk) and self.isTemplatePage then
-- parameter is blank.
            talk = '#'
if talk == ''
        end
and self.templateTitle
        if talk then
and (
            -- See if the talk link exists and is for a talk or a content namespace.
mw.title.equals(self.templateTitle, self.title)
            local talkTitle = getTitleObject(talk)
or self.title:isSubpageOf(self.templateTitle)
            if not talkTitle or not talkTitle.isTalkPage then
)
                -- If we couldn't process the talk page link, get the talk page of the current page.
then
                local success
talk = '#'
                success, talkTitle = pcall(self.title.talkPageTitle, self.title)
elseif talk == '' then
                if not success then
talk = nil
                    talkTitle = nil
end
                end
if talk then
            end
-- If the talk value is a talk page, make a link to that page. Else
            if talkTitle and talkTitle.exists then
-- assume that it's a section heading, and make a link to the talk
                 local talkText = 'Relevant discussion may be found on'
-- page of the current page with that section heading.
                 if talkTitle.isTalkPage then
local talkTitle = getTitleObject(talk)
                     talkText = format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText)
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 = 'Relevant discussion may be found on'
                     talkText = format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk)
                    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.
        -- Get other values.
self.fix = args.fix ~= '' and args.fix or nil
        self.fix = args.fix
local date
        local date = args.date
if args.date and args.date ~= '' then
        self.date = date and format(" <small>''(%s)''</small>", date)
date = args.date
        if presentButBlank(self.date) and self.isTemplatePage then
elseif args.date == '' and self.isTemplatePage then
            self.date = lang:formatDate('F Y')
date = lang:formatDate('F Y')
        end
end
        self.info = args.info
if date then
    end
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
    -- Set the non-collapsible text field. At the moment this is used by all box types other than ambox,
-- types other than ambox, and also by ambox when small=yes.
    -- and also by ambox when small=yes.
if self.isSmall then
    if self.isSmall then
self.text = args.smalltext or args.text
        if self.useCollapsibleTextFields then
else
            self.text = args.smalltext or self.issue
self.text = args.text
        else
end
            self.text = args.smalltext or args.text
        end
    else
        self.text = args.text
    end


-- Set the below row.
    -- Set the below row.
self.below = cfg.below and args.below
    self.below = cfg.below and args.below


-- General image settings.
    -- General image settings.
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
    self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
self.imageEmptyCell = cfg.imageEmptyCell
    self.imageEmptyCell = cfg.imageEmptyCell
    if cfg.imageEmptyCellStyle then
        self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
    end


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


-- Right image settings.
    -- Right image settings.
local imageRight = self.isSmall and args.smallimageright or args.imageright
    local imageRight = self.isSmall and args.smallimageright or args.imageright
if not (cfg.imageRightNone and imageRight == 'none') then
    if not (cfg.imageRightNone and imageRight == 'none') then
self.imageRight = imageRight
        self.imageRight = imageRight
end
    end
-- set templatestyles
self.base_templatestyles = cfg.templatestyles
self.templatestyles = args.templatestyles
end


function MessageBox:setMainspaceCategories()
    -- Add mainspace categories. At the moment these are only used in {{ambox}}.
local args = self.args
    if cfg.allowMainspaceCategories then
local cfg = self.cfg
        if args.cat then
            args.cat1 = args.cat
        end
        self.catNums = getArgNums(args, 'cat')
        if args.category then
            args.category1 = args.category
        end
        self.categoryNums = getArgNums(args, 'category')
        self.categoryParamNums = union(self.catNums, self.categoryNums)
        -- 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(self.categoryParamNums) do
            local mainCat = args['cat' .. tostring(num)] or args['category' .. tostring(num)]
            local allCat = args['all' .. tostring(num)]
            mainCat = type(mainCat) == 'string' and mainCat
            allCat = type(allCat) == 'string' and allCat
            if mainCat and date then
                local catTitle = format('%s %s %s', mainCat, preposition, date)
                self:addCat('main', catTitle)
                catTitle = getTitleObject('Category:' .. catTitle)
                if not catTitle or not catTitle.exists then
                    self:addCat('main', 'Articles with invalid date parameter in template')
                end
            elseif mainCat and not date then
                self:addCat('main', mainCat)
            end
            if allCat then
                self:addCat('main', allCat)
            end
        end
    end


if not cfg.allowMainspaceCategories then
    -- Add template-namespace categories.
return nil
    self.isTemplatePage = type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name)
end
    if cfg.templateCategory then
 
        if self.name then
local nums = {}
            if self.isTemplatePage then
for _, prefix in ipairs{'cat', 'category', 'all'} do
                self:addCat('template', cfg.templateCategory)
args[prefix .. '1'] = args[prefix]
            end
nums = union(nums, getArgNums(args, prefix))
        elseif not self.title.isSubpage then
end
            self:addCat('template', cfg.templateCategory)
 
        end
-- The following is roughly equivalent to the old {{Ambox/category}}.
    end
local date = args.date
   
date = type(date) == 'string' and date
    -- Add template error category.
local preposition = 'from'
    if cfg.templateErrorCategory then
for _, num in ipairs(nums) do
        local templateErrorCategory = cfg.templateErrorCategory
local mainCat = args['cat' .. tostring(num)]
        local templateCat, templateSort
or args['category' .. tostring(num)]
        if not self.name and not self.title.isSubpage then
local allCat = args['all' .. tostring(num)]
            templateCat = templateErrorCategory
mainCat = type(mainCat) == 'string' and mainCat
        elseif type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name) then
allCat = type(allCat) == 'string' and allCat
            local paramsToCheck = cfg.templateErrorParamsToCheck or {}
if mainCat and date and date ~= '' then
            local count = 0
local catTitle = string.format('%s %s %s', mainCat, preposition, date)
            for i, param in ipairs(paramsToCheck) do
self:addCat(0, catTitle)
                if not args[param] then
catTitle = getTitleObject('Category:' .. catTitle)
                    count = count + 1
if not catTitle or not catTitle.exists then
                end
self:addCat(0, 'Articles with invalid date parameter in template')
            end
end
            if count > 0 then
elseif mainCat and (not date or date == '') then
                templateCat = templateErrorCategory
self:addCat(0, mainCat)
                templateSort = tostring(count)
end
            end
if allCat then
            if self.categoryNums and #self.categoryNums > 0 then
self:addCat(0, allCat)
                templateCat = templateErrorCategory
end
                templateSort = 'C'
end
            end
end
        end
 
        self:addCat('template', templateCat, templateSort)
function MessageBox:setTemplateCategories()
    end
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()
    -- Categories for all namespaces.
if self.title.namespace == 0 then
    if self.invalidTypeError then
self:setMainspaceCategories()
        local allSort = (nsid == 0 and 'Main:' or '') .. self.title.prefixedText
elseif self.title.namespace == 10 then
        self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
self:setTemplateCategories()
    end
end
    if self.isSubstituted then
self:setAllNamespaceCategories()
        self:addCat('all', 'Pages with incorrectly substituted templates')
end
    end


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


function MessageBox:export()
function box:export()
local root = mw.html.create()
    local root = htmlBuilder.create()
 
-- Add the subst check error.
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 text.
    -- Add the subst check error.
local textCell = row:tag('td'):addClass('mbox-text')
    if self.isSubstituted and self.name then
if self.useCollapsibleTextFields then
        root
-- The message box uses advanced text parameters that allow things to be
            .tag('b')
-- collapsible. At the moment, only ambox uses this.
                .addClass('error')
textCell:cssText(self.textstyle or nil)
                .wikitext(format(
local textCellDiv = textCell:tag('div')
                    'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
textCellDiv
                    mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
:addClass('mbox-text-span')
                ))
:wikitext(self.issue or nil)
    end
if (self.talk or self.fix) then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:wikitext(self.talk and (' ' .. self.talk) or nil)
:wikitext(self.fix and (' ' .. self.fix) or nil)
end
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
if self.info and not self.isSmall then
textCellDiv
:tag('span')
:addClass('hide-when-compact')
:wikitext(self.info and (' ' .. self.info) or nil)
end
if self.removalNotice then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:tag('i')
:wikitext(string.format(" (%s)", self.removalNotice))
end
else
-- Default text formatting - anything goes.
textCell
:cssText(self.textstyle or nil)
:wikitext(self.text or nil)
end


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


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


return tostring(root)
    -- Add the below row.
end
    if self.below then
        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.
-- Exports
    if self.invalidTypeError then
--------------------------------------------------------------------------------
        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


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


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


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


function mt.__index(t, k)
local function makeWrapper(boxType)
return function (frame)
    return function (frame)
if not getArgs then
        -- If called via #invoke, use the args passed into the invoking
getArgs = require('Module:Arguments').getArgs
        -- template, or the args passed to #invoke if any exist. Otherwise
end
        -- assume args are being passed directly in from the debug console
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
        -- or from another Lua module.
end
        local args
        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 setmetatable(p, mt)
return {
    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')
}
Please note that all contributions to Meta Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Meta Wiki:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Template used on this page:

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