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 or mw.title.getCurrentTitle()
if success then
 
return title
 
end
 
end
 
 
 
local function union(t1, t2)
 
-- Returns the union of two arrays.
 
local vals = {}
 
for i, v in ipairs(t1) do
 
vals[v] = true
 
end
 
for i, v in ipairs(t2) do
 
vals[v] = true
 
end
 
local ret = {}
 
for k in pairs(vals) do
 
table.insert(ret, k)
 
end
 
table.sort(ret)
 
return ret
 
end
 
 
 
local function getArgNums(args, prefix)
 
local nums = {}
 
for k, v in pairs(args) do
 
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
 
if num then
 
table.insert(nums, tonumber(num))
 
end
 
end
 
table.sort(nums)
 
return nums
 
 
end
 
end
  
--------------------------------------------------------------------------------
+
function p.build(data, args)
-- Box class definition
+
    -- Get the title object and the namespace.
--------------------------------------------------------------------------------
+
    local title = mw.title.getCurrentTitle()
 +
    local nsid = title.namespace
 +
   
 +
-- Commenting this out for now - this will require tinkering with Namespace detect to differentiate between
 +
-- invalid titles and pages where the expensive parser function count has been exceeded.
 +
--[[
 +
    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'
 +
    }
 +
]]
  
local MessageBox = {}
+
    ------------------------ Process config data ----------------------------
MessageBox.__index = MessageBox
 
  
function MessageBox.new(boxType, args, cfg)
+
    -- Type data.
args = args or {}
+
    local typeData = data.types[args.type]
local obj = {}
+
    local invalidType = args.type and not typeData and true or false
 +
    typeData = typeData or data.types[data.default]
  
-- Set the title object and the namespace.
+
    -- Process data for collapsible text fields
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
+
    local text, talk, fix, date, info
 +
    if data.useCollapsibleTextFields then
 +
        text = args.issue
 +
        talk = args.talk
 +
        fix = args.fix
 +
        date = args.date
 +
        info = args.info
 +
    else
 +
        text = args.text
 +
    end
  
-- Set the config for our box type.
+
    -- Find whether we are using a small message box and process our data accordingly.
obj.cfg = cfg[boxType]
+
    local isSmall = data.allowSmall and (args.small == 'yes' or args.small == true) and true or false
if not obj.cfg then
+
    local smallClass, image, imageRight, imageSize
local ns = obj.title.namespace
+
    if isSmall then
-- boxType is "mbox" or invalid input
+
        smallClass = data.smallClass or 'mbox-small'
if ns == 0 then
+
        image = args.smallimage or args.image
obj.cfg = cfg.ambox -- main namespace
+
        imageRight = args.smallimageright or args.imageright
elseif ns == 6 then
+
        text = args.smalltext or text
obj.cfg = cfg.imbox -- file namespace
+
        imageSize = data.imageSmallSize or '30x30px'
elseif ns == 14 then
+
    else
obj.cfg = cfg.cmbox -- category namespace
+
        image = args.image
else
+
        imageRight = args.imageright
local nsTable = mw.site.namespaces[ns]
+
        imageSize = '40x40px'
if nsTable and nsTable.isTalk then
+
    end
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
+
    ------------------------ Get the box structure ----------------------------
-- 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.
+
    local root = htmlBuilder.create() -- Includes error messages and categories added after the box.
obj.categories = {}
+
    local substCheck = root.tag('b').addClass('error')
obj.classes = {}
+
    local box = root.tag('table')
 +
    local row = box.tag('tr')
 +
    local imageLeftCell = row.tag('td').addClass('mbox-image')
 +
    local textCell = row.tag('td').addClass('mbox-text')
 +
    local imageRightCell = row.tag('td').addClass('mbox-imageright')
  
return setmetatable(obj, MessageBox)
+
    ------------------------ Build the box ----------------------------
end
 
  
function MessageBox:addCat(ns, cat, sort)
+
    -- Do the subst check.
if not cat then
+
    if data.substCheck and args.subst == 'SUBST' then
return nil
+
        if type(args.name) == 'string' then
end
+
            substCheck
if sort then
+
                .wikitext(mw.ustring.format(
cat = string.format('[[Category:%s|%s]]', cat, sort)
+
                    'Template <code>%s%s%s</code> has been incorrectly substituted.',
else
+
                    mw.text.nowiki('{{'),
cat = string.format('[[Category:%s]]', cat)
+
                    args.name,
end
+
                    mw.text.nowiki('}}')
self.categories[ns] = self.categories[ns] or {}
+
                ))
table.insert(self.categories[ns], cat)
+
        end
end
+
        root.wikitext('[[Category:Pages with incorrectly substituted templates]]') -- This puts the category at the *end* of the output, rather than after the subst error message.
 +
    end
  
function MessageBox:addClass(class)
+
    -- Build the box.
if not class then
+
    box
return nil
+
        .attr('id', args.id)
end
+
    for i, class in ipairs(data.classes) do
table.insert(self.classes, class)
+
        box
end
+
            .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')
  
function MessageBox:setParameters()
+
    -- Add the left-hand image.
local args = self.args
+
    local imageCheckBlank = data.imageCheckBlank
local cfg = self.cfg
+
    if image ~= 'none' and not imageCheckBlank or image ~= 'none' and imageCheckBlank and image ~= 'blank' then
 +
        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
  
-- Get type data.
+
    -- Add the text.
self.type = args.type
+
    if data.useCollapsibleTextFields then
local typeData = cfg.types[self.type]
+
        textCell
self.invalidTypeError = cfg.showInvalidTypeError
+
            .cssText(args.textstyle)
and self.type
+
        local textCellSpan = textCell.tag('span')
and not typeData
+
        textCellSpan
typeData = typeData or cfg.types[cfg.default]
+
            .addClass('mbox-text-span')
self.typeClass = typeData.class
+
            .wikitext(text)
self.typeImage = typeData.image
+
        if not isSmall then
 +
            textCellSpan
 +
                .tag('span')
 +
                    .addClass('hide-when-compact')
 +
                    .wikitext(talk)
 +
                    .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
  
-- Find if the box has been wrongly substituted.
+
    -- Add the right-hand image.
self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'
+
    if imageRight and not (data.imageRightNone and imageRight == 'none') then
 +
        if not isSmall and data.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(imageRight)
 +
    end
  
-- Find whether we are using a small message box.
+
    -- Add the below row.
self.isSmall = cfg.allowSmall and (
+
    if data.below and args.below then
cfg.smallParam and args.small == cfg.smallParam
+
        box.tag('tr')
or not cfg.smallParam and yesno(args.small)
+
            .tag('td')
)
+
                .attr('colspan', args.imageright and '3' or '2')
 +
                .addClass('mbox-text')
 +
                .cssText(args.textstyle)
 +
                .wikitext(args.below)
 +
    end
  
-- Add attributes, classes and styles.
+
    ------------------------ Add error messages and categories ----------------------------
self.id = args.id
 
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.
+
    -- Add error message and tracking category for invalid type parameters.
self.textstyle = args.textstyle
+
    if invalidType then
 +
        local catsort = (nsid == 0 and 'Main:' or '') .. title.prefixedText
 +
        root
 +
            .tag('div')
 +
                .css('text-align', 'center')
 +
                .wikitext(mw.ustring.format('This message box is using an invalid "type=%s" parameter and needs fixing.', args.type or ''))
 +
                .done()
 +
            .wikitext(mw.ustring.format('[[Category:Wikipedia message box parameter needs fixing|%s]]', catsort))
 +
    end
  
-- Find if we are on the template page or not. This functionality is only
+
    -- Categorise template pages.
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
+
    if data.category and nsid == 10 and not title.isSubpage and not yesno(args.nocat) then
-- and cfg.templateCategoryRequireName are set.
+
            root.wikitext(mw.ustring.format('[[Category:%s]]', data.category))
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
+
    end
if self.useCollapsibleTextFields
+
    return tostring(root)
or cfg.templateCategory
 
and cfg.templateCategoryRequireName
 
then
 
self.name = args.name
 
if self.name then
 
local templateName = mw.ustring.match(
 
self.name,
 
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
 
) or self.name
 
templateName = 'Template:' .. templateName
 
self.templateTitle = getTitleObject(templateName)
 
end
 
self.isTemplatePage = self.templateTitle
 
and mw.title.equals(self.title, self.templateTitle)
 
end
 
 
 
-- Process data for collapsible text fields. At the moment these are only
 
-- used in {{ambox}}.
 
if self.useCollapsibleTextFields then
 
-- Get the self.issue value.
 
if self.isSmall and args.smalltext then
 
self.issue = args.smalltext
 
else
 
local sect
 
if args.sect == '' then
 
sect = 'This ' .. (cfg.sectionDefault or 'page')
 
elseif type(args.sect) == 'string' then
 
sect = 'This ' .. args.sect
 
end
 
local issue = args.issue
 
issue = type(issue) == 'string' and issue ~= '' and issue or nil
 
local text = args.text
 
text = type(text) == 'string' and text or nil
 
local issues = {}
 
table.insert(issues, sect)
 
table.insert(issues, issue)
 
table.insert(issues, text)
 
self.issue = table.concat(issues, ' ')
 
end
 
 
 
-- Get the self.talk value.
 
local talk = args.talk
 
-- Show talk links on the template page or template subpages if the talk
 
-- parameter is blank.
 
if talk == ''
 
and self.templateTitle
 
and (
 
mw.title.equals(self.templateTitle, self.title)
 
or self.title:isSubpageOf(self.templateTitle)
 
)
 
then
 
talk = '#'
 
elseif talk == '' then
 
talk = nil
 
end
 
if talk then
 
-- If the talk value is a talk page, make a link to that page. Else
 
-- assume that it's a section heading, and make a link to the talk
 
-- page of the current page with that section heading.
 
local talkTitle = getTitleObject(talk)
 
local talkArgIsTalkPage = true
 
if not talkTitle or not talkTitle.isTalkPage then
 
talkArgIsTalkPage = false
 
talkTitle = getTitleObject(
 
self.title.text,
 
mw.site.namespaces[self.title.namespace].talk.id
 
)
 
end
 
if talkTitle and talkTitle.exists then
 
local talkText = '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.
 
self.fix = args.fix ~= '' and args.fix or nil
 
local date
 
if args.date and args.date ~= '' then
 
date = args.date
 
elseif args.date == '' and self.isTemplatePage then
 
date = lang:formatDate('F Y')
 
end
 
if date then
 
self.date = string.format(" <small>''(%s)''</small>", date)
 
end
 
self.info = args.info
 
if yesno(args.removalnotice) then
 
self.removalNotice = cfg.removalNotice
 
end
 
end
 
 
 
-- Set the non-collapsible text field. At the moment this is used by all box
 
-- types other than ambox, and also by ambox when small=yes.
 
if self.isSmall then
 
self.text = args.smalltext or args.text
 
else
 
self.text = args.text
 
end
 
 
 
-- Set the below row.
 
self.below = cfg.below and args.below
 
 
 
-- General image settings.
 
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
 
self.imageEmptyCell = cfg.imageEmptyCell
 
if cfg.imageEmptyCellStyle then
 
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
 
end
 
 
 
-- Left image settings.
 
local imageLeft = self.isSmall and args.smallimage or args.image
 
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none'
 
or not cfg.imageCheckBlank and imageLeft ~= 'none'
 
then
 
self.imageLeft = imageLeft
 
if not imageLeft then
 
local imageSize = self.isSmall
 
and (cfg.imageSmallSize or '30x30px')
 
or '40x40px'
 
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
 
or 'Imbox notice.png', imageSize)
 
end
 
end
 
 
 
-- Right image settings.
 
local imageRight = self.isSmall and args.smallimageright or args.imageright
 
if not (cfg.imageRightNone and imageRight == 'none') then
 
self.imageRight = imageRight
 
end
 
 
end
 
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'
end
+
        },
 
+
        content = {
function MessageBox:export()
+
            class = 'cmbox-content',
local root = mw.html.create()
+
            image = 'Cmbox content.png'
 
+
        },
-- Add the subst check error.
+
        style = {
if self.isSubstituted and self.name then
+
            class = 'cmbox-style',
root:tag('b')
+
            image = 'Edit-clear.svg'
:addClass('error')
+
        },
:wikitext(string.format(
+
        move = {
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
+
            class = 'cmbox-move',
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
+
            image = 'Cmbox move.png'
))
+
        },
end
+
        protection = {
 
+
            class = 'cmbox-protection',
-- Create the box table.
+
            image = 'Cmbox protection.png'
local boxTable = root:tag('table')
+
        },
boxTable:attr('id', self.id or nil)
+
        notice = {
for i, class in ipairs(self.classes or {}) do
+
            class = 'cmbox-notice',
boxTable:addClass(class or nil)
+
            image = 'Cmbox notice.png'
end
+
        }
boxTable
+
    }
:cssText(self.style or nil)
+
    data.default = 'notice'
:attr('role', 'presentation')
+
    data.classes = {'plainlinks', 'cmbox'}
 
+
    return p.build(data, args)
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 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
 
end
  
--------------------------------------------------------------------------------
+
function p._tmbox(args)
-- Exports
+
    local data = {}
--------------------------------------------------------------------------------
+
    data.types = {
 
+
        speedy = {
local p, mt = {}, {}
+
            class = 'tmbox-speedy',
 
+
            image = 'Imbox speedy deletion.png'
function p._exportClasses()
+
        },
-- For testing.
+
        delete = {
return {
+
            class = 'tmbox-delete',
MessageBox = MessageBox
+
            image = 'Imbox deletion.png'
}
+
        },
 +
        content = {
 +
            class = 'tmbox-content',
 +
            image = 'Imbox content.png'
 +
        },
 +
        style = {
 +
            class = 'tmbox-style',
 +
            image = 'Edit-clear.svg '
 +
        },
 +
        move = {
 +
            class = 'tmbox-move',
 +
            image = 'Imbox move.png'
 +
        },
 +
        protection = {
 +
            class = 'tmbox-protection',
 +
            image = 'Imbox protection.png'
 +
        },
 +
        notice = {
 +
            class = 'tmbox-notice',
 +
            image = 'Imbox notice.png'
 +
        }
 +
    }
 +
    data.default = 'notice'
 +
    data.classes = {'plainlinks', 'tmbox'}
 +
    data.allowSmall = true
 +
    data.imageRightNone = true
 +
    data.imageEmptyCellStyle = true
 +
    data.category = 'Talk message boxes'
 +
    return p.build(data, args)
 
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)