Editing Module:Message box

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

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

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

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


-- Load necessary modules.
local htmlBuilder = require('Module:HtmlBuilder')
require('Module:No globals')
local nsDetect = require('Module:Namespace detect')
local getArgs
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 p = {}
local lang = mw.language.getContentLanguage()


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


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


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


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


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


--------------------------------------------------------------------------------
function p.build(boxType, args)
-- Box class definition
    -- Get the box config data from the data page.
--------------------------------------------------------------------------------
    local dataTables = mw.loadData('Module:Message box/data')
 
    local data = dataTables[boxType]
local MessageBox = {}
    if not data then
MessageBox.__index = MessageBox
        local boxTypes = {}
 
        for k, v in pairs(dataTables) do
function MessageBox.new(boxType, args, cfg)
            table.insert(boxTypes, mw.ustring.format('"%s"', k))
args = args or {}
        end
local obj = {}
        error(mw.ustring.format('invalid message box type "%s"; valid types are %s', tostring(boxType), mw.text.listToText(boxTypes)), 2)
 
    end
-- 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)
    -- Get the title object and the namespace.
if not cat then
    local title = mw.title.getCurrentTitle()
return nil
    local nsid = title.namespace
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)
    -- Get a language object for formatDate.
if not class then
    local lang = mw.language.getContentLanguage()
return nil
   
end
-- Commenting this out for now - this will require tinkering with Namespace detect to differentiate between
table.insert(self.classes, class)
-- invalid titles and pages where the expensive parser function count has been exceeded.
end
--[[
    local title = nsDetect.getPageObject(args.page)
    local namespace = nsDetect.main{
        page = args.page,
        demospace = args.demospace,
        main = 'main',
        talk = 'talk',
        file = 'file',
        category = 'category',
        other = 'other'
    }
]]


function MessageBox:setParameters()
    ------------------------ Process config data ----------------------------
local args = self.args
local cfg = self.cfg


-- Get type data.
    -- Type data.
self.type = args.type
    local typeData = data.types[args.type]
local typeData = cfg.types[self.type]
    local invalidType = args.type and not typeData and true or false
self.invalidTypeError = cfg.showInvalidTypeError
    typeData = typeData or data.types[data.default]
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.
    -- Process data for collapsible text fields
self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'
    local name, issue, talk, fix, date, info
    if data.useCollapsibleTextFields then
        name = args.name
        local nameTitle = getTitleObject(name)
        local isTemplatePage = nameTitle and title.prefixedText == ('Template:' .. nameTitle.text) and true or false
        local sect = args.sect
        if presentButBlank(sect) then
            sect = mw.ustring.format('This %s ', data.sectionDefault or 'page')
        elseif type(sect) == 'string' then
            sect = 'This ' .. sect .. ' '
        end
        issue = (sect or '') .. (args.issue or '') .. ' ' .. (args.text or '')
        talk = args.talk
        if presentButBlank(talk) and isTemplatePage then
            talk = '#'
        end
        fix = args.fix
        date = args.date
        if presentButBlank(date) and isTemplatePage then
            date = lang:formatDate('F Y')
        end
        info = args.info
    end


-- Find whether we are using a small message box.
    -- Process the talk link, if present.
self.isSmall = cfg.allowSmall and (
    if talk then
cfg.smallParam and args.small == cfg.smallParam
        -- See if the talk link exists and is for a talk or a content namespace.
or not cfg.smallParam and yesno(args.small)
        local talkTitle = type(talk) == 'string' and getTitleObject(talk)
)
        if not talkTitle or not talkTitle.isTalkPage then
            -- If we couldn't process the talk page link, get the talk page of the current page.
            local success
            success, talkTitle = pcall(title.talkPageTitle, title)
            if not success then
                talkTitle = nil
            end
        end
        if talkTitle and talkTitle.exists then
            local talkText = ' Relevant discussion may be found on'
            if talkTitle.isTalkPage then
                talkText = mw.ustring.format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText)
            else
                talkText = mw.ustring.format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk)
            end
            talk = talkText
        end
    end


-- Add attributes, classes and styles.
    -- Find whether we are using a small message box and process our data accordingly.
self.id = args.id
    local isSmall = data.allowSmall and (args.small == 'yes' or args.small == true) and true or false
self.name = args.name
    local smallClass, image, imageRight, text, imageSize
if self.name then
    if isSmall then
self:addClass('box-' .. string.gsub(self.name,' ','_'))
        smallClass = data.smallClass or 'mbox-small'
end
        image = args.smallimage or args.image
if yesno(args.plainlinks) ~= false then
        imageRight = args.smallimageright or args.imageright
self:addClass('plainlinks')
        if data.useCollapsibleTextFields then
end
            text = args.smalltext or issue
for _, class in ipairs(cfg.classes or {}) do
        else
self:addClass(class)
            text = args.smalltext or args.text
end
        end
if self.isSmall then
        imageSize = data.imageSmallSize or '30x30px'
self:addClass(cfg.smallClass or 'mbox-small')
    else
end
        image = args.image
self:addClass(self.typeClass)
        imageRight = args.imageright
self:addClass(args.class)
        imageSize = '40x40px'
self.style = args.style
        text = args.text
self.attrs = args.attrs
    end


-- Set text style.
    -- Process mainspace categories.
self.textstyle = args.textstyle
    local mainCats = {}
    local origCategoryNums -- origCategoryNums might be used in computing the template error category.
    if data.allowMainspaceCategories then
        -- Categories for the main namespace.
        local origCatNums = getArgNums(args, 'cat')
        local origCategoryNums = getArgNums(args, 'category')
        local catNums = union(origCatNums, origCategoryNums)
        for _, num in ipairs(catNums) do
            local cat = args['cat' .. tostring(num)] or args['category' .. tostring(num)]
            local all = args['all' .. tostring(num)]
            table.insert(mainCats, formatCategory(cat, args.date, all))
        end
    end


-- Find if we are on the template page or not. This functionality is only
    -- Process template namespace categories
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
    local templateCats = {}
-- and cfg.templateCategoryRequireName are set.
    if data.templateCategory and not title.isSubpage and not yesno(args.nocat) then
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
        table.insert(templateCats, mw.ustring.format('[[Category:%s]]', data.templateCategory))
if self.useCollapsibleTextFields
    end
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.
    -- Add an error category for the template namespace if appropriate.
local talk = args.talk
    if data.templateErrorCategory then
-- Show talk links on the template page or template subpages if the talk
        local catName = data.templateErrorCategory
-- parameter is blank.
        local templateCat
if talk == ''
        if not name and not title.isSubpage then
and self.templateTitle
            templateCat = mw.ustring.format('[[Category:%s]]', catName)
and (
        elseif type(name) == 'string' and title.prefixedText == ('Template:' .. name) then
mw.title.equals(self.templateTitle, self.title)
            local paramsToCheck = data.templateErrorParamsToCheck or {}
or self.title:isSubpageOf(self.templateTitle)
            local count = 0
)
            for i, param in ipairs(paramsToCheck) do
then
                if not args[param] then
talk = '#'
                     count = count + 1
elseif talk == '' then
talk = nil
end
if talk then
-- If the talk value is a talk page, make a link to that page. Else
-- assume that it's a section heading, and make a link to the talk
-- page of the current page with that section heading.
local talkTitle = getTitleObject(talk)
local talkArgIsTalkPage = true
if not talkTitle or not talkTitle.isTalkPage then
talkArgIsTalkPage = false
talkTitle = getTitleObject(
self.title.text,
mw.site.namespaces[self.title.namespace].talk.id
)
end
if talkTitle and talkTitle.exists then
                local talkText
                if self.isSmall then
                    local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. '#' .. talk)
                    talkText = string.format('([[%s|talk]])', talkLink)
                else
                    talkText = 'Relevant discussion may be found on'
                    if talkArgIsTalkPage then
                        talkText = string.format(
                            '%s [[%s|%s]].',
                            talkText,
                            talk,
                            talkTitle.prefixedText
                        )
                    else
                        talkText = string.format(
                            '%s the [[%s#%s|talk page]].',
                            talkText,
                            talkTitle.prefixedText,
                            talk
                        )
                     end
                 end
                 end
self.talk = talkText
            end
end
            if count > 0 then
end
                templateCat = mw.ustring.format('[[Category:%s|%d]]', catName, count)
 
            end
-- Get other values.
            if origCategoryNums and #origCategoryNums > 0 then
self.fix = args.fix ~= '' and args.fix or nil
                templateCat = mw.ustring.format('[[Category:%s|C]]', catName)
local date
            end
if args.date and args.date ~= '' then
        end
date = args.date
        table.insert(templateCats, templatecat)
elseif args.date == '' and self.isTemplatePage then
    end
date = lang:formatDate('F Y')
end
if date then
self.date = string.format(" <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.
    -- Categories for all namespaces.
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
    local allCats = {}
self.imageEmptyCell = cfg.imageEmptyCell
    if invalidType then
if cfg.imageEmptyCellStyle then
        local catsort = (nsid == 0 and 'Main:' or '') .. title.prefixedText
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
        table.insert(allCats, mw.ustring.format('[[Category:Wikipedia message box parameter needs fixing|%s]]', catsort))
end
    end


-- Left image settings.
    ------------------------ Build the box ----------------------------
local imageLeft = self.isSmall and args.smallimage or args.image
   
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
    local root = htmlBuilder.create()
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.
    -- Do the subst check.
local imageRight = self.isSmall and args.smallimageright or args.imageright
    if data.substCheck and args.subst == 'SUBST' then
if not (cfg.imageRightNone and imageRight == 'none') then
        if type(name) == 'string' then
self.imageRight = imageRight
            root
end
                .tag('b')
end
                    .addClass('error')
                    .wikitext(mw.ustring.format(
                        'Template <code>%s%s%s</code> has been incorrectly substituted.',
                        mw.text.nowiki('{{'), name, mw.text.nowiki('}}')
                    ))
        end
        table.insert(allCats, '[[Category:Pages with incorrectly substituted templates]]')
    end


function MessageBox:setMainspaceCategories()
    -- Create the box table.
local args = self.args
    local box = root.tag('table')
local cfg = self.cfg
    box
        .attr('id', args.id)
    for i, class in ipairs(data.classes) do
        box
            .addClass(class)
    end
    box
        .addClass(isSmall and smallClass)
        .addClass(data.classPlainlinksYesno and yesno(args.plainlinks or true) and 'plainlinks')
        .addClass(typeData.class)
        .addClass(args.class)
        .cssText(args.style)
        .attr('role', 'presentation')


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


local nums = {}
    -- Add the text.
for _, prefix in ipairs{'cat', 'category', 'all'} do
    local textCell = row.tag('td').addClass('mbox-text')
args[prefix .. '1'] = args[prefix]
    if data.useCollapsibleTextFields then
nums = union(nums, getArgNums(args, prefix))
        textCell
end
            .cssText(args.textstyle)
        local textCellSpan = textCell.tag('span')
        textCellSpan
            .addClass('mbox-text-span')
            .wikitext(issue)
        if not isSmall then
            textCellSpan
                .tag('span')
                    .addClass('hide-when-compact')
                    .wikitext(talk)
                    .wikitext(' ')
                    .wikitext(fix)
                    .done()
        end
        textCellSpan
            .wikitext(date and mw.ustring.format(" <small>''(%s)''</small>", date))
        if not isSmall then
            textCellSpan
                .tag('span')
                    .addClass('hide-when-compact')
                    .wikitext(info and ' ' .. info)
        end
    else
        textCell
            .cssText(args.textstyle)
            .wikitext(text)
    end


-- The following is roughly equivalent to the old {{Ambox/category}}.
    -- Add the right-hand image.
local date = args.date
    if imageRight and not (data.imageRightNone and imageRight == 'none') then
date = type(date) == 'string' and date
        local imageRightCell = row.tag('td').addClass('mbox-imageright')
local preposition = 'from'
        if not isSmall and data.imageCellDiv then
for _, num in ipairs(nums) do
            imageRightCell = imageRightCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
local mainCat = args['cat' .. tostring(num)]
        end
or args['category' .. tostring(num)]
        imageRightCell
local allCat = args['all' .. tostring(num)]
            .wikitext(imageRight)
mainCat = type(mainCat) == 'string' and mainCat
    end
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()
    -- Add the below row.
local args = self.args
    if data.below and args.below then
local cfg = self.cfg
        box.tag('tr')
            .tag('td')
                .attr('colspan', args.imageright and '3' or '2')
                .addClass('mbox-text')
                .cssText(args.textstyle)
                .wikitext(args.below)
    end


-- Add template categories.
    ------------------------ Error messages and 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.
    -- Add error message for invalid type parameters.
if cfg.templateErrorCategory then
    if invalidType then
local templateErrorCategory = cfg.templateErrorCategory
        root
local templateCat, templateSort
            .tag('div')
if not self.name and not self.title.isSubpage then
                .addClass('error')
templateCat = templateErrorCategory
                .css('text-align', 'center')
elseif self.isTemplatePage then
                .wikitext(mw.ustring.format('This message box is using an invalid type parameter (<code>type=%s</code>) and needs fixing.', args.type or ''))
local paramsToCheck = cfg.templateErrorParamsToCheck or {}
    end
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()
    -- Add categories using categoryHandler.
-- Set categories for all namespaces.
    root
if self.invalidTypeError then
        .wikitext(categoryHandler{
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
            main = table.concat(mainCats),
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
            template = table.concat(templateCats),
end
            all = table.concat(allCats)
if self.isSubstituted then
        })
self:addCat('all', 'Pages with incorrectly substituted templates')
   
end
    return tostring(root)
end
end


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


function MessageBox:renderCategories()
p.ambox = makeWrapper('ambox')
if not self.hasCategories then
p.fmbox = makeWrapper('fmbox')
-- No categories added, no need to pass them to Category handler so,
p.imbox = makeWrapper('imbox')
-- if it was invoked, it would return the empty string.
p.ombox = makeWrapper('ombox')
-- So we shortcut and return the empty string.
p.cmbox = makeWrapper('cmbox')
return ""
p.tmbox = makeWrapper('tmbox')
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)
return p
Please note that all contributions to Nonbinary Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see Nonbinary Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Template used on this page:

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