The wiki has moved!

Visit the new wiki at stationeers-wiki.com The old wiki here at legacy.stationeers-wiki.com will sunset eventually.

Edits made after the 7th of March 6PM EST were NOT carried over to the new server as previously announced right here in this box.

 Actions

Module

Difference between revisions of "Message box"

From Unofficial Stationeers Wiki

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

Latest revision as of 15:00, 14 July 2018

Documentation for this module may be created at Module:Message box/doc 

-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.

-- Load necessary modules.
require('Module:No globals')
local getArgs
local yesno = require('Module:Yesno')

-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()

-- Define constants
local CONFIG_MODULE = 'Module:Message box/configuration'

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function getTitleObject(...)
	-- Get the title object, passing the function through pcall
	-- in case we are over the expensive function count limit.
	local success, title = pcall(mw.title.new, ...)
	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

--------------------------------------------------------------------------------
-- 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 = {}
	-- For lazy loading of [[Module:Category handler]].
	obj.hasCategories = false

	return setmetatable(obj, MessageBox)
end

function MessageBox:addCat(ns, cat, sort)
	if not cat then
		return nil
	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)
	if not class then
		return nil
	end
	table.insert(self.classes, class)
end

function MessageBox:setParameters()
	local args = self.args
	local cfg = self.cfg

	-- Get type data.
	self.type = args.type
	local typeData = cfg.types[self.type]
	self.invalidTypeError = cfg.showInvalidTypeError
		and self.type
		and not typeData
	typeData = typeData or cfg.types[cfg.default]
	self.typeClass = typeData.class
	self.typeImage = typeData.image

	-- Find if the box has been wrongly substituted.
	self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'

	-- Find whether we are using a small message box.
	self.isSmall = cfg.allowSmall and (
		cfg.smallParam and args.small == cfg.smallParam
		or not cfg.smallParam and yesno(args.small)
	)

	-- Add attributes, classes and styles.
	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.
	self.textstyle = args.textstyle

	-- Find if we are on the template page or not. This functionality is only
	-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
	-- and cfg.templateCategoryRequireName are set.
	self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
	if self.useCollapsibleTextFields
		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

function MessageBox:setMainspaceCategories()
	local args = self.args
	local cfg = self.cfg

	if not cfg.allowMainspaceCategories then
		return nil
	end

	local nums = {}
	for _, prefix in ipairs{'cat', 'category', 'all'} do
		args[prefix .. '1'] = args[prefix]
		nums = union(nums, getArgNums(args, prefix))
	end

	-- The following is roughly equivalent to the old {{Ambox/category}}.
	local date = args.date
	date = type(date) == 'string' and date
	local preposition = 'from'
	for _, num in ipairs(nums) do
		local mainCat = args['cat' .. tostring(num)]
			or args['category' .. tostring(num)]
		local allCat = args['all' .. tostring(num)]
		mainCat = type(mainCat) == 'string' and mainCat
		allCat = type(allCat) == 'string' and allCat
		if mainCat and date 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()
	local args = self.args
	local cfg = self.cfg

	-- Add template categories.
	if cfg.templateCategory then
		if cfg.templateCategoryRequireName then
			if self.isTemplatePage then
				self:addCat(10, cfg.templateCategory)
			end
		elseif not self.title.isSubpage then
			self:addCat(10, cfg.templateCategory)
		end
	end

	-- Add template error categories.
	if cfg.templateErrorCategory then
		local templateErrorCategory = cfg.templateErrorCategory
		local templateCat, templateSort
		if not self.name and not self.title.isSubpage then
			templateCat = templateErrorCategory
		elseif self.isTemplatePage then
			local paramsToCheck = cfg.templateErrorParamsToCheck or {}
			local count = 0
			for i, param in ipairs(paramsToCheck) do
				if not args[param] then
					count = count + 1
				end
			end
			if count > 0 then
				templateCat = templateErrorCategory
				templateSort = tostring(count)
			end
			if self.categoryNums and #self.categoryNums > 0 then
				templateCat = templateErrorCategory
				templateSort = 'C'
			end
		end
		self:addCat(10, templateCat, templateSort)
	end
end

function MessageBox:setAllNamespaceCategories()
	-- Set categories for all namespaces.
	if self.invalidTypeError then
		local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
		self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
	end
	if self.isSubstituted then
		self:addCat('all', 'Pages with incorrectly substituted templates')
	end
end

function MessageBox:setCategories()
	if self.title.namespace == 0 then
		self:setMainspaceCategories()
	elseif self.title.namespace == 10 then
		self:setTemplateCategories()
	end
	self:setAllNamespaceCategories()
end

function MessageBox:renderCategories()
	if not self.hasCategories then
		-- No categories added, no need to pass them to Category handler so,
		-- if it was invoked, it would return the empty string.
		-- So we shortcut and return the empty string.
		return ""
	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) and not self.isSmall 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)
Retrieved from "https://legacy.stationeers-wiki.com/index.php?title=Module:Message_box&oldid=4990"