Editing Module:Message box

From MINR.ORG WIKI

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 save 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
 
+
        -- Get the title object, passing the function through pcall  
--------------------------------------------------------------------------------
+
        -- in case we are over the expensive function count limit.
-- Helper functions
+
        local success
--------------------------------------------------------------------------------
+
        success, page = pcall(mw.title.new, page)
 
+
        if not success then
local function getTitleObject(...)
+
            page = nil
-- Get the title object, passing the function through pcall
+
        end
-- in case we are over the expensive function count limit.
+
    end
local success, title = pcall(mw.title.new, ...)
+
    return page
if success then
 
return title
 
end
 
 
end
 
end
  
local function union(t1, t2)
+
local function presentButBlank(s)
-- Returns the union of two arrays.
+
    if type(s) ~= 'string' then return end
local vals = {}
+
    if s and not mw.ustring.find(s, '%S') then
for i, v in ipairs(t1) do
+
        return true
vals[v] = true
+
    else
end
+
        return false
for i, v in ipairs(t2) do
+
    end
vals[v] = true
 
end
 
local ret = {}
 
for k in pairs(vals) do
 
table.insert(ret, k)
 
end
 
table.sort(ret)
 
return ret
 
end
 
 
 
local function getArgNums(args, prefix)
 
local nums = {}
 
for k, v in pairs(args) do
 
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
 
if num then
 
table.insert(nums, tonumber(num))
 
end
 
end
 
table.sort(nums)
 
return nums
 
end
 
 
 
--------------------------------------------------------------------------------
 
-- Box class definition
 
--------------------------------------------------------------------------------
 
 
 
local MessageBox = {}
 
MessageBox.__index = MessageBox
 
 
 
function MessageBox.new(boxType, args, cfg)
 
args = args or {}
 
local obj = {}
 
 
 
-- Set the title object and the namespace.
 
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
 
 
 
-- Set the config for our box type.
 
obj.cfg = cfg[boxType]
 
if not obj.cfg then
 
local ns = obj.title.namespace
 
-- boxType is "mbox" or invalid input
 
if 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 = {}
 
 
 
return setmetatable(obj, MessageBox)
 
 
end
 
end
  
function MessageBox:addCat(ns, cat, sort)
+
function p.build(data, args)
if not cat then
+
    -- Get the title object and the namespace.
return nil
+
    local title = mw.title.getCurrentTitle()
end
+
    local nsid = title.namespace
if sort then
 
cat = string.format('[[Category:%s|%s]]', cat, sort)
 
else
 
cat = string.format('[[Category:%s]]', cat)
 
end
 
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 = 'This article '
 +
        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
if yesno(args.plainlinks) ~= false then
+
    local smallClass, image, imageRight, text, imageSize
self:addClass('plainlinks')
+
    if isSmall then
end
+
        smallClass = data.smallClass or 'mbox-small'
for _, class in ipairs(cfg.classes or {}) do
+
        image = args.smallimage or args.image
self:addClass(class)
+
        imageRight = args.smallimageright or args.imageright
end
+
        if data.useCollapsibleTextFields then
if self.isSmall then
+
            text = args.smalltext or issue
self:addClass(cfg.smallClass or 'mbox-small')
+
        else
end
+
            text = args.smalltext or args.text
self:addClass(self.typeClass)
+
        end
self:addClass(args.class)
+
        imageSize = data.imageSmallSize or '30x30px'
self.style = args.style
+
    else
self.attrs = args.attrs
+
        image = args.image
 +
        imageRight = args.imageright
 +
        imageSize = '40x40px'
 +
        text = args.text
 +
    end
  
-- Set text style.
+
    ------------------------ Build the box ----------------------------
self.textstyle = args.textstyle
+
   
 +
    local root = htmlBuilder.create()
  
-- Find if we are on the template page or not. This functionality is only
+
    -- Do the subst check.
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
+
    if data.substCheck and args.subst == 'SUBST' then
-- and cfg.templateCategoryRequireName are set.
+
        if type(args.name) == 'string' then
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
+
            root
if self.useCollapsibleTextFields
+
                .tag('b')
or cfg.templateCategory
+
                    .addClass('error')
and cfg.templateCategoryRequireName
+
                    .wikitext(mw.ustring.format(
then
+
                        'Template <code>%s%s%s</code> has been incorrectly substituted.',
self.name = args.name
+
                        mw.text.nowiki('{{'),
if self.name then
+
                        args.name,
local templateName = mw.ustring.match(
+
                        mw.text.nowiki('}}')
self.name,
+
                    ))
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
+
        end
) or self.name
+
        root.wikitext('[[Category:Pages with incorrectly substituted templates]]')
templateName = 'Template:' .. templateName
+
    end
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
+
    -- Build the box.
-- used in {{ambox}}.
+
    local box = root.tag('table')
if self.useCollapsibleTextFields then
+
    box
-- Get the self.issue value.
+
        .attr('id', args.id)
if self.isSmall and args.smalltext then
+
    for i, class in ipairs(data.classes) do
self.issue = args.smalltext
+
        box
else
+
            .addClass(class)
local sect
+
    end
if args.sect == '' then
+
    box
sect = 'This ' .. (cfg.sectionDefault or 'page')
+
        .addClass(isSmall and smallClass)
elseif type(args.sect) == 'string' then
+
        .addClass(data.classPlainlinksYesno and yesno(args.plainlinks or true) and 'plainlinks')
sect = 'This ' .. args.sect
+
        .addClass(typeData.class)
end
+
        .addClass(args.class)
local issue = args.issue
+
        .cssText(args.style)
issue = type(issue) == 'string' and issue ~= '' and issue or nil
+
        .attr('role', 'presentation')
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 the left-hand image.
local talk = args.talk
+
    local row = box.tag('tr')
-- Show talk links on the template page or template subpages if the talk
+
    local imageLeftCell = row.tag('td').addClass('mbox-image')
-- parameter is blank.
+
    local imageCheckBlank = data.imageCheckBlank
if talk == ''
+
    if image ~= 'none' and not imageCheckBlank or image ~= 'none' and imageCheckBlank and image ~= 'blank' then
and self.templateTitle
+
        if not isSmall and data.imageCellDiv then
and (
+
            imageLeftCell = imageLeftCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageLeftCell so that the image is inside it.
mw.title.equals(self.templateTitle, self.title)
+
        end
or self.title:isSubpageOf(self.templateTitle)
+
        imageLeftCell
)
+
            .wikitext(image or mw.ustring.format('[[File:%s|%s|link=|alt=]]', typeData.image, imageSize))
then
+
    elseif data.imageEmptyCell then
talk = '#'
+
        row.tag('td')
elseif talk == '' then
+
            .addClass('mbox-empty-cell') -- No image. Cell with some width or padding necessary for text cell to have 100% width.
talk = nil
+
            .cssText(data.imageEmptyCellStyle and 'border:none;padding:0px;width:1px')
end
+
    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 = '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
 
self.talk = talkText
 
end
 
end
 
  
-- Get other values.
+
    -- Add the text.
self.fix = args.fix ~= '' and args.fix or nil
+
    local textCell = row.tag('td').addClass('mbox-text')
local date
+
    if data.useCollapsibleTextFields then
if args.date and args.date ~= '' then
+
        textCell
date = args.date
+
            .cssText(args.textstyle)
elseif args.date == '' and self.isTemplatePage then
+
        local textCellSpan = textCell.tag('span')
date = lang:formatDate('F Y')
+
        textCellSpan
end
+
            .addClass('mbox-text-span')
if date then
+
            .wikitext(issue)
self.date = string.format(" <small>''(%s)''</small>", date)
+
        if not isSmall then
end
+
            textCellSpan
self.info = args.info
+
                .tag('span')
if yesno(args.removalnotice) then
+
                    .addClass('hide-when-compact')
self.removalNotice = cfg.removalNotice
+
                    .wikitext(talk)
end
+
                    .wikitext(' ')
end
+
                    .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
  
-- Set the non-collapsible text field. At the moment this is used by all box
+
    -- Add the right-hand image.
-- types other than ambox, and also by ambox when small=yes.
+
    local imageRightCell = row.tag('td').addClass('mbox-imageright')
if self.isSmall then
+
    if imageRight and not (data.imageRightNone and imageRight == 'none') then
self.text = args.smalltext or args.text
+
        if not isSmall and data.imageCellDiv then
else
+
            imageRightCell = imageRightCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
self.text = args.text
+
        end
end
+
        imageRightCell
 +
            .wikitext(imageRight)
 +
    end
  
-- Set the below row.
+
    -- Add the below row.
self.below = cfg.below and args.below
+
    if data.below and args.below then
 +
        box.tag('tr')
 +
            .tag('td')
 +
                .attr('colspan', args.imageright and '3' or '2')
 +
                .addClass('mbox-text')
 +
                .cssText(args.textstyle)
 +
                .wikitext(args.below)
 +
    end
  
-- General image settings.
+
    ------------------------ Add error messages and categories ----------------------------
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
 
self.imageEmptyCell = cfg.imageEmptyCell
 
if cfg.imageEmptyCellStyle then
 
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
 
end
 
  
-- Left image settings.
+
    -- Add error message and tracking category for invalid type parameters.
local imageLeft = self.isSmall and args.smallimage or args.image
+
    if invalidType then
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
+
        local catsort = (nsid == 0 and 'Main:' or '') .. title.prefixedText
or not cfg.imageCheckBlank and imageLeft ~= 'none'
+
        root
then
+
            .tag('div')
self.imageLeft = imageLeft
+
                .css('text-align', 'center')
if not imageLeft then
+
                .wikitext(mw.ustring.format('This message box is using an invalid "type=%s" parameter and needs fixing.', args.type or ''))
local imageSize = self.isSmall
+
                .done()
and (cfg.imageSmallSize or '30x30px')
+
            .wikitext(mw.ustring.format('[[Category:Wikipedia message box parameter needs fixing|%s]]', catsort))
or '40x40px'
+
    end
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
 
or 'Imbox notice.png', imageSize)
 
end
 
end
 
  
-- Right image settings.
+
    -- Categorise template pages.
local imageRight = self.isSmall and args.smallimageright or args.imageright
+
    if data.category and nsid == 10 and not title.isSubpage and not yesno(args.nocat) then
if not (cfg.imageRightNone and imageRight == 'none') then
+
            root.wikitext(mw.ustring.format('[[Category:%s]]', data.category))
self.imageRight = imageRight
+
    end
end
+
    return tostring(root)
 
end
 
end
  
function MessageBox:setMainspaceCategories()
+
function p._ambox(args)
local args = self.args
+
    local data = {}
local cfg = self.cfg
+
    data.types = {
 
+
        speedy = {
if not cfg.allowMainspaceCategories then
+
            class = 'ambox-speedy',
return nil
+
            image = 'Ambox speedy deletion.png'
end
+
        },
 
+
        delete = {
local nums = {}
+
            class = 'ambox-delete',
for _, prefix in ipairs{'cat', 'category', 'all'} do
+
            image = 'Ambox deletion.png'
args[prefix .. '1'] = args[prefix]
+
        },
nums = union(nums, getArgNums(args, prefix))
+
        content = {
end
+
            class = 'ambox-content',
 
+
            image = 'Ambox content.png'
-- The following is roughly equivalent to the old {{Ambox/category}}.
+
        },
local date = args.date
+
        style = {
date = type(date) == 'string' and date
+
            class = 'ambox-style',
local preposition = 'from'
+
            image = 'Edit-clear.svg'
for _, num in ipairs(nums) do
+
        },
local mainCat = args['cat' .. tostring(num)]
+
        move = {
or args['category' .. tostring(num)]
+
            class = 'ambox-move',
local allCat = args['all' .. tostring(num)]
+
            image = 'Ambox move.png'
mainCat = type(mainCat) == 'string' and mainCat
+
        },
allCat = type(allCat) == 'string' and allCat
+
        protection = {
if mainCat and date and date ~= '' then
+
            class = 'ambox-protection',
local catTitle = string.format('%s %s %s', mainCat, preposition, date)
+
            image = 'Ambox protection.png'
self:addCat(0, catTitle)
+
        },
catTitle = getTitleObject('Category:' .. catTitle)
+
        notice = {
if not catTitle or not catTitle.exists then
+
            class = 'ambox-notice',
self:addCat(0, 'Articles with invalid date parameter in template')
+
            image = 'Ambox notice.png'
end
+
        }
elseif mainCat and (not date or date == '') then
+
    }
self:addCat(0, mainCat)
+
    data.default = 'notice'
end
+
    data.allowSmall = true
if allCat then
+
    data.substCheck = true
self:addCat(0, allCat)
+
    data.classes = {'metadata', 'plainlinks', 'ambox'}
end
+
    data.smallClass = 'mbox-small-left'
end
+
    data.imageEmptyCell = true
 +
    data.imageCheckBlank = true
 +
    data.imageSmallSize = '20x20px'
 +
    data.imageCellDiv = true
 +
    data.useCollapsibleTextFields = true
 +
    data.imageRightNone = true
 +
    return p.build(data, args)
 
end
 
end
  
function MessageBox:setTemplateCategories()
+
function p._fmbox(args)
local args = self.args
+
    local data = {}
local cfg = self.cfg
+
    data.types = {
 
+
        warning = {
-- Add template categories.
+
            class = 'fmbox-warning',
if cfg.templateCategory then
+
            image = 'Cmbox deletion.png'
if cfg.templateCategoryRequireName then
+
        },
if self.isTemplatePage then
+
        editnotice = {
self:addCat(10, cfg.templateCategory)
+
            class = 'fmbox-editnotice',
end
+
            image = 'Imbox notice.png'
elseif not self.title.isSubpage then
+
        },
self:addCat(10, cfg.templateCategory)
+
        system = {
end
+
            class = 'fmbox-system',
end
+
            image = 'Imbox notice.png'
 
+
        }
-- Add template error categories.
+
    }
if cfg.templateErrorCategory then
+
    data.default = 'system'
local templateErrorCategory = cfg.templateErrorCategory
+
    data.classes = { 'plainlinks', 'fmbox' }
local templateCat, templateSort
+
    data.imageEmptyCell = false
if not self.name and not self.title.isSubpage then
+
    data.imageRightNone = false
templateCat = templateErrorCategory
+
    return p.build(data, args)
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
 
end
  
function MessageBox:setAllNamespaceCategories()
+
function p._ombox(args)
-- Set categories for all namespaces.
+
    local data = {}
if self.invalidTypeError then
+
    data.types = {
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
+
        speedy = {
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
+
            class = 'ombox-speedy',
end
+
            image = 'Imbox speedy deletion.png'
if self.isSubstituted then
+
        },
self:addCat('all', 'Pages with incorrectly substituted templates')
+
        delete = {
end
+
            class = 'ombox-delete',
 +
            image = 'Imbox deletion.png'
 +
        },
 +
        content = {
 +
            class = 'ombox-content',
 +
            image = 'Imbox content.png'
 +
        },
 +
        style = {
 +
            class = 'ombox-style',
 +
            image = 'Edit-clear.svg'
 +
        },
 +
        move = {
 +
            class = 'ombox-move',
 +
            image = 'Imbox move.png'
 +
        },
 +
        protection = {
 +
            class = 'ombox-protection',
 +
            image = 'Imbox protection.png'
 +
        },
 +
        notice = {
 +
            class = 'ombox-notice',
 +
            image = 'Imbox notice.png'
 +
        }
 +
    }
 +
    data.default = 'notice'
 +
    data.classes = {'plainlinks', 'ombox'}
 +
    data.allowSmall = true
 +
    data.imageEmptyCell = true
 +
    data.imageRightNone = true
 +
    return p.build(data, args)
 
end
 
end
  
function MessageBox:setCategories()
+
function p._imbox(args)
if self.title.namespace == 0 then
+
    local data = {}
self:setMainspaceCategories()
+
    data.types = {
elseif self.title.namespace == 10 then
+
        speedy = {
self:setTemplateCategories()
+
            class = 'imbox-speedy',
end
+
            image = 'Imbox speedy deletion.png'
self:setAllNamespaceCategories()
+
        },
 +
        delete = {
 +
            class = 'imbox-delete',
 +
            image = 'Imbox deletion.png'
 +
        },
 +
        content = {
 +
            class = 'imbox-content',
 +
            image = 'Imbox content.png'
 +
        },
 +
        style = {
 +
            class = 'imbox-style',
 +
            image = 'Edit-clear.svg'
 +
        },
 +
        move = {
 +
            class = 'imbox-move',
 +
            image = 'Imbox move.png'
 +
        },
 +
        protection = {
 +
            class = 'imbox-protection',
 +
            image = 'Imbox protection.png'
 +
        },
 +
        license = {
 +
            class = 'imbox-license',
 +
            image = 'Imbox license.png'
 +
        },
 +
        featured = {
 +
            class = 'imbox-featured',
 +
            image = 'Imbox featured.png'
 +
        },
 +
        notice = {
 +
            class = 'imbox-notice',
 +
            image = 'Imbox notice.png'
 +
        }
 +
    }
 +
    data.default = 'notice'
 +
    data.classes = {'imbox'}
 +
    data.classPlainlinksYesno = true
 +
    data.imageEmptyCell = true
 +
    data.below = true
 +
    return p.build(data, args)
 
end
 
end
  
function MessageBox:renderCategories()
+
function p._cmbox(args)
-- Convert category tables to strings and pass them through
+
    local data = {}
-- [[Module:Category handler]].
+
    data.types = {
return categoryHandler{
+
        speedy = {
main = table.concat(self.categories[0] or {}),
+
            class = 'cmbox-speedy',
template = table.concat(self.categories[10] or {}),
+
            image = 'Cmbox deletion.png'
all = table.concat(self.categories.all or {}),
+
        },
nocat = self.args.nocat,
+
        delete = {
page = self.args.page
+
            class = 'cmbox-delete',
}
+
            image = 'Cmbox deletion.png'
 +
        },
 +
        content = {
 +
            class = 'cmbox-content',
 +
            image = 'Cmbox content.png'
 +
        },
 +
        style = {
 +
            class = 'cmbox-style',
 +
            image = 'Edit-clear.svg'
 +
        },
 +
        move = {
 +
            class = 'cmbox-move',
 +
            image = 'Cmbox move.png'
 +
        },
 +
        protection = {
 +
            class = 'cmbox-protection',
 +
            image = 'Cmbox protection.png'
 +
        },
 +
        notice = {
 +
            class = 'cmbox-notice',
 +
            image = 'Cmbox notice.png'
 +
        }
 +
    }
 +
    data.default = 'notice'
 +
    data.classes = {'plainlinks', 'cmbox'}
 +
    return p.build(data, args)
 
end
 
end
  
function MessageBox:export()
+
function p._tmbox(args)
local root = mw.html.create()
+
    local data = {}
 
+
    data.types = {
-- Add the subst check error.
+
        speedy = {
if self.isSubstituted and self.name then
+
            class = 'tmbox-speedy',
root:tag('b')
+
            image = 'Imbox speedy deletion.png'
:addClass('error')
+
        },
:wikitext(string.format(
+
        delete = {
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
+
            class = 'tmbox-delete',
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
+
            image = 'Imbox deletion.png'
))
+
        },
end
+
        content = {
 
+
            class = 'tmbox-content',
-- Create the box table.
+
            image = 'Imbox content.png'
local boxTable = root:tag('table')
+
        },
boxTable:attr('id', self.id or nil)
+
        style = {
for i, class in ipairs(self.classes or {}) do
+
            class = 'tmbox-style',
boxTable:addClass(class or nil)
+
            image = 'Edit-clear.svg '
end
+
        },
boxTable
+
        move = {
:cssText(self.style or nil)
+
            class = 'tmbox-move',
:attr('role', 'presentation')
+
            image = 'Imbox move.png'
 
+
        },
if self.attrs then
+
        protection = {
boxTable:attr(self.attrs)
+
            class = 'tmbox-protection',
end
+
            image = 'Imbox protection.png'
 
+
        },
-- Add the left-hand image.
+
        notice = {
local row = boxTable:tag('tr')
+
            class = 'tmbox-notice',
if self.imageLeft then
+
            image = 'Imbox notice.png'
local imageLeftCell = row:tag('td'):addClass('mbox-image')
+
        }
if self.imageCellDiv then
+
    }
-- If we are using a div, redefine imageLeftCell so that the image
+
    data.default = 'notice'
-- is inside it. Divs use style="width: 52px;", which limits the
+
    data.classes = {'plainlinks', 'tmbox'}
-- image width to 52px. If any images in a div are wider than that,
+
    data.allowSmall = true
-- they may overlap with the text or cause other display problems.
+
    data.imageRightNone = true
imageLeftCell = imageLeftCell:tag('div'):css('width', '52px')
+
    data.imageEmptyCellStyle = true
end
+
    data.category = 'Talk message boxes'
imageLeftCell:wikitext(self.imageLeft or nil)
+
    return p.build(data, args)
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 textCellSpan = textCell:tag('span')
 
textCellSpan
 
:addClass('mbox-text-span')
 
:wikitext(self.issue or nil)
 
if (self.talk or self.fix) and not self.isSmall then
 
textCellSpan:tag('span')
 
:addClass('hide-when-compact')
 
:wikitext(self.talk and (' ' .. self.talk) or nil)
 
:wikitext(self.fix and (' ' .. self.fix) or nil)
 
end
 
textCellSpan:wikitext(self.date and (' ' .. self.date) or nil)
 
if self.info and not self.isSmall then
 
textCellSpan
 
:tag('span')
 
:addClass('hide-when-compact')
 
:wikitext(self.info and (' ' .. self.info) or nil)
 
end
 
if self.removalNotice then
 
textCellSpan: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
 
end
  
function p.main(boxType, args, cfgTables)
+
local function makeWrapper(func)
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE))
+
    return function (frame)
box:setParameters()
+
        -- If called via #invoke, use the args passed into the invoking
box:setCategories()
+
        -- template, or the args passed to #invoke if any exist. Otherwise
return box:export()
+
        -- assume args are being passed directly in from the debug console
 +
        -- or from another Lua module.
 +
        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 func(args)
 +
    end
 
end
 
end
  
function mt.__index(t, k)
+
p.ambox = makeWrapper(p._ambox)
return function (frame)
+
p.fmbox = makeWrapper(p._fmbox)
if not getArgs then
+
p.imbox = makeWrapper(p._imbox)
getArgs = require('Module:Arguments').getArgs
+
p.ombox = makeWrapper(p._ombox)
end
+
p.cmbox = makeWrapper(p._cmbox)
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
+
p.tmbox = makeWrapper(p._tmbox)
end
 
end
 
  
return setmetatable(p, mt)
+
return p

Please note that all contributions to MINR.ORG 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 MINR.ORG WIKI:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)