Module:Message box and Module:Message box/configuration: Difference between pages

From MAP Wiki
(Difference between pages)
button>Pppery
Use SVG per edit request
 
button>Pppery
Use SVG per edit request
 
Line 1: Line 1:
-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
-- Load necessary modules.
require('strict')
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'
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}
local TEMPLATE_STYLES = 'Module:Message box/%s.css'
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Helper functions
--                         Message box configuration                        --
--                                                                            --
-- This module contains configuration data for [[Module:Message box]].        --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


local function getTitleObject(...)
return {
-- Get the title object, passing the function through pcall
ambox = {
-- in case we are over the expensive function count limit.
types = {
local success, title = pcall(mw.title.new, ...)
speedy = {
if success then
class = 'ambox-speedy',
return title
image = 'OOjs UI icon clock-destructive.svg'
end
},
end
delete = {
 
class = 'ambox-delete',
local function union(t1, t2)
image = 'OOjs UI icon alert-destructive.svg'
-- Returns the union of two arrays.
},
local vals = {}
warning = { -- alias for content
for i, v in ipairs(t1) do
class = 'ambox-content',
vals[v] = true
image = 'OOjs UI icon notice-warning.svg'
end
},
for i, v in ipairs(t2) do
content = {
vals[v] = true
class = 'ambox-content',
end
image = 'OOjs UI icon notice-warning.svg'
local ret = {}
},
for k in pairs(vals) do
style = {
table.insert(ret, k)
class = 'ambox-style',
end
image = 'Edit-clear.svg'
table.sort(ret)
},
return ret
move = {
end
class = 'ambox-move',
 
image = 'Merge-split-transwiki default.svg'
local function getArgNums(args, prefix)
},
local nums = {}
protection = {
for k, v in pairs(args) do
class = 'ambox-protection',
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
image = 'Semi-protection-shackle-keyhole.svg'
if num then
},
table.insert(nums, tonumber(num))
notice = {
end
class = 'ambox-notice',
end
image = 'OOjs UI icon information-progressive.svg'
table.sort(nums)
}
return nums
},
end
default                    = 'notice',
 
allowBlankParams            = {'talk', 'sect', 'date', 'issue', 'fix', 'subst', 'hidden'},
--------------------------------------------------------------------------------
allowSmall                  = true,
-- Box class definition
smallParam                  = 'left',
--------------------------------------------------------------------------------
smallClass                  = 'mbox-small-left',
 
substCheck                  = true,
local MessageBox = {}
classes                    = {'metadata', 'plainlinks', 'ambox'},
MessageBox.__index = MessageBox
imageEmptyCell              = true,
 
imageCheckBlank            = true,
function MessageBox.new(boxType, args, cfg)
imageSmallSize              = '20x20px',
args = args or {}
imageCellDiv                = true,
local obj = {}
useCollapsibleTextFields    = true,
 
imageRightNone              = true,
obj.boxType = boxType
sectionDefault              = 'article',
 
allowMainspaceCategories    = true,
-- Set the title object and the namespace.
templateCategory            = 'Article message templates',
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
        templateCategoryRequireName = true,
 
templateErrorCategory      = nil,
-- Set the config for our box type.
templateErrorParamsToCheck  = {'issue', 'fix', 'subst'}
obj.cfg = cfg[boxType]
},
if not obj.cfg then
local ns = obj.title.namespace
cmbox = {
-- boxType is "mbox" or invalid input
types = {
if args.demospace and args.demospace ~= '' then
speedy = {
-- implement demospace parameter of mbox
class = 'cmbox-speedy',
local demospace = string.lower(args.demospace)
image = 'OOjs UI icon clock-destructive.svg'
if DEMOSPACES[demospace] then
},
-- use template from DEMOSPACES
delete = {
obj.cfg = cfg[DEMOSPACES[demospace]]
class = 'cmbox-delete',
obj.boxType = DEMOSPACES[demospace]
image = 'OOjs UI icon alert-destructive.svg'
elseif string.find( demospace, 'talk' ) then
},
-- demo as a talk page
content = {
obj.cfg = cfg.tmbox
class = 'cmbox-content',
obj.boxType = 'tmbox'
image = 'OOjs UI icon notice-warning.svg'
else
},
-- default to ombox
style = {
obj.cfg = cfg.ombox
class = 'cmbox-style',
obj.boxType = 'ombox'
image = 'Edit-clear.svg'
end
},
elseif ns == 0 then
move = {
obj.cfg = cfg.ambox -- main namespace
class = 'cmbox-move',
obj.boxType = 'ambox'
image = 'Merge-split-transwiki default.svg'
elseif ns == 6 then
},
obj.cfg = cfg.imbox -- file namespace
protection = {
obj.boxType = 'imbox'
class = 'cmbox-protection',
elseif ns == 14 then
image = 'Semi-protection-shackle-keyhole.svg'
obj.cfg = cfg.cmbox -- category namespace
},
obj.boxType = 'cmbox'
notice = {
else
class = 'cmbox-notice',
local nsTable = mw.site.namespaces[ns]
image = 'OOjs UI icon information-progressive.svg'
if nsTable and nsTable.isTalk then
},
obj.cfg = cfg.tmbox -- any talk namespace
caution = {
obj.boxType = 'tmbox'
class = 'cmbox-style',
else
image = 'Ambox warning yellow.svg'
obj.cfg = cfg.ombox -- other namespaces or invalid input
}
obj.boxType = 'ombox'
},
end
default              = 'notice',
end
showInvalidTypeError = true,
end
classes              = {'plainlinks', 'cmbox'},
 
imageEmptyCell      = true
-- Set the arguments, and remove all blank arguments except for the ones
},
-- listed in cfg.allowBlankParams.
do
fmbox = {
local newArgs = {}
types = {
for k, v in pairs(args) do
warning = {
if v ~= '' then
class = 'fmbox-warning',
newArgs[k] = v
image = 'OOjs UI icon clock-destructive.svg'
end
},
end
editnotice = {
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
class = 'fmbox-editnotice',
newArgs[param] = args[param]
image = 'OOjs UI icon information-progressive.svg'
end
},
obj.args = newArgs
system = {
end
class = 'fmbox-system',
 
image = 'OOjs UI icon information-progressive.svg'
-- Define internal data structure.
}
obj.categories = {}
},
obj.classes = {}
default              = 'system',
-- For lazy loading of [[Module:Category handler]].
showInvalidTypeError = true,
obj.hasCategories = false
classes              = {'plainlinks', 'fmbox'},
 
imageEmptyCell      = false,
return setmetatable(obj, MessageBox)
imageRightNone      = false
end
},
 
function MessageBox:addCat(ns, cat, sort)
imbox = {
if not cat then
types = {
return nil
speedy = {
end
class = 'imbox-speedy',
if sort then
image = 'OOjs UI icon clock-destructive.svg'
cat = string.format('[[Category:%s|%s]]', cat, sort)
},
else
delete = {
cat = string.format('[[Category:%s]]', cat)
class = 'imbox-delete',
end
image = 'OOjs UI icon alert-destructive.svg'
self.hasCategories = true
},
self.categories[ns] = self.categories[ns] or {}
content = {
table.insert(self.categories[ns], cat)
class = 'imbox-content',
end
image = 'OOjs UI icon notice-warning.svg'
 
},
function MessageBox:addClass(class)
style = {
if not class then
class = 'imbox-style',
return nil
image = 'Edit-clear.svg'
end
},
self.classes[class] = 1
move = {
end
class = 'imbox-move',
 
image = 'Merge-split-transwiki default.svg'
function MessageBox:removeClass(class)
},
if not class then
protection = {
return nil
class = 'imbox-protection',
end
image = 'Semi-protection-shackle-keyhole.svg'
self.classes[class] = nil
},
end
license = {
 
class = 'imbox-license licensetpl',
function MessageBox:setParameters()
image = 'Imbox-license.svg'
local args = self.args
},
local cfg = self.cfg
featured = {
 
class = 'imbox-featured',
-- Get type data.
image = 'Cscr-featured.svg'
self.type = args.type
},
local typeData = cfg.types[self.type]
notice = {
self.invalidTypeError = cfg.showInvalidTypeError
class = 'imbox-notice',
and self.type
image = 'OOjs UI icon information-progressive.svg'
and not typeData
}
typeData = typeData or cfg.types[cfg.default]
},
self.typeClass = typeData.class
default              = 'notice',
self.typeImage = typeData.image
showInvalidTypeError = true,
 
classes              = {'imbox'},
-- Find if the box has been wrongly substituted.
usePlainlinksParam  = true,
self.isSubstituted = cfg.substCheck and args.subst == 'SUBST'
imageEmptyCell      = true,
 
below                = true,
-- Find whether we are using a small message box.
templateCategory    = 'File message boxes'
self.isSmall = cfg.allowSmall and (
},
cfg.smallParam and args.small == cfg.smallParam
or not cfg.smallParam and yesno(args.small)
ombox = {
)
types = {
 
speedy = {
-- Add attributes, classes and styles.
class = 'ombox-speedy',
self.id = args.id
image = 'OOjs UI icon clock-destructive.svg'
self.name = args.name
},
for _, class in ipairs(cfg.classes or {}) do
delete = {
self:addClass(class)
class = 'ombox-delete',
end
image = 'OOjs UI icon alert-destructive.svg'
if self.name then
},
self:addClass('box-' .. string.gsub(self.name,' ','_'))
warning = { -- alias for content
end
class = 'ombox-content',
local plainlinks = yesno(args.plainlinks)
image = 'OOjs UI icon notice-warning.svg'
if plainlinks == true then
},
self:addClass('plainlinks')
content = {
elseif plainlinks == false then
class = 'ombox-content',
self:removeClass('plainlinks')
image = 'OOjs UI icon notice-warning.svg'
end
},
if self.isSmall then
style = {
self:addClass(cfg.smallClass or 'mbox-small')
class = 'ombox-style',
end
image = 'Edit-clear.svg'
self:addClass(self.typeClass)
},
self:addClass(args.class)
move = {
self.style = args.style
class = 'ombox-move',
self.attrs = args.attrs
image = 'Merge-split-transwiki default.svg'
 
},
-- Set text style.
protection = {
self.textstyle = args.textstyle
class = 'ombox-protection',
 
image = 'Semi-protection-shackle-keyhole.svg'
-- Find if we are on the template page or not. This functionality is only
},
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
notice = {
-- and cfg.templateCategoryRequireName are set.
class = 'ombox-notice',
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
image = 'OOjs UI icon information-progressive.svg'
if self.useCollapsibleTextFields
},
or cfg.templateCategory
critical = {
and cfg.templateCategoryRequireName
class = 'mbox-critical',
then
image = 'OOjs UI icon clock-destructive.svg'
if self.name then
}
local templateName = mw.ustring.match(
},
self.name,
default              = 'notice',
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
showInvalidTypeError = true,
) or self.name
classes              = {'plainlinks', 'ombox'},
templateName = 'Template:' .. templateName
allowSmall          = true,
self.templateTitle = getTitleObject(templateName)
imageEmptyCell      = true,
end
imageRightNone      = true
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
tmbox = {
-- used in {{ambox}}.
types = {
if self.useCollapsibleTextFields then
speedy = {
-- Get the self.issue value.
class = 'tmbox-speedy',
if self.isSmall and args.smalltext then
image = 'OOjs UI icon clock-destructive.svg'
self.issue = args.smalltext
},
else
delete = {
local sect
class = 'tmbox-delete',
if args.sect == '' then
image = 'OOjs UI icon alert-destructive.svg'
sect = 'This ' .. (cfg.sectionDefault or 'page')
},
elseif type(args.sect) == 'string' then
content = {
sect = 'This ' .. args.sect
class = 'tmbox-content',
end
image = 'OOjs UI icon notice-warning.svg'
local issue = args.issue
},
issue = type(issue) == 'string' and issue ~= '' and issue or nil
style = {
local text = args.text
class = 'tmbox-style',
text = type(text) == 'string' and text or nil
image = 'Edit-clear.svg'
local issues = {}
},
table.insert(issues, sect)
move = {
table.insert(issues, issue)
class = 'tmbox-move',
table.insert(issues, text)
image = 'Merge-split-transwiki default.svg'
self.issue = table.concat(issues, ' ')
},
end
protection = {
 
class = 'tmbox-protection',
-- Get the self.talk value.
image = 'Semi-protection-shackle-keyhole.svg'
local talk = args.talk
},
-- Show talk links on the template page or template subpages if the talk
notice = {
-- parameter is blank.
class = 'tmbox-notice',
if talk == ''
image = 'OOjs UI icon information-progressive.svg'
and self.templateTitle
}
and (
},
mw.title.equals(self.templateTitle, self.title)
default              = 'notice',
or self.title:isSubpageOf(self.templateTitle)
showInvalidTypeError = true,
)
classes              = {'plainlinks', 'tmbox'},
then
allowSmall          = true,
talk = '#'
imageRightNone      = true,
elseif talk == '' then
imageEmptyCell      = true,
talk = nil
imageEmptyCellStyle  = true,
end
templateCategory    = 'Talk message boxes'
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 class='date-container'>''(<span class='date'>%s</span>)''</small>", date)
end
self.info = args.info
if yesno(args.removalnotice) then
self.removalNotice = cfg.removalNotice
end
end
 
-- Set the non-collapsible text field. At the moment this is used by all box
-- types other than ambox, and also by ambox when small=yes.
if self.isSmall then
self.text = args.smalltext or args.text
else
self.text = args.text
end
 
-- Set the below row.
self.below = cfg.below and args.below
 
-- General image settings.
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 'Information icon4.svg', 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.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
 
-- Add TemplateStyles
root:wikitext(mw.getCurrentFrame():extensionTag{
name = 'templatestyles',
args = { src = TEMPLATE_STYLES:format(self.boxType) },
})
 
-- Create the box table.
local boxTable
-- Check for fmbox because not all interface messages have mw-parser-output
-- which is necessary for TemplateStyles. Add the wrapper class if it is and
-- then start the actual mbox, else start the mbox.
if self.boxType == 'fmbox' then
boxTable = root:tag('div')
:addClass('mw-parser-output')
:tag('table')
else
boxTable = root:tag('table')
end
 
boxTable:attr('id', self.id or nil)
for class, _ in pairs(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)

Revision as of 09:34, 2 September 2023

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

--------------------------------------------------------------------------------
--                          Message box configuration                         --
--                                                                            --
-- This module contains configuration data for [[Module:Message box]].        --
--------------------------------------------------------------------------------

return {
	ambox = {
		types = {
			speedy = {
				class = 'ambox-speedy',
				image = 'OOjs UI icon clock-destructive.svg'
			},
			delete = {
				class = 'ambox-delete',
				image = 'OOjs UI icon alert-destructive.svg'
			},
			warning = { -- alias for content
				class = 'ambox-content',
				image = 'OOjs UI icon notice-warning.svg'
			},
			content = {
				class = 'ambox-content',
				image = 'OOjs UI icon notice-warning.svg'
			},
			style = {
				class = 'ambox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'ambox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'ambox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			notice = {
				class = 'ambox-notice',
				image = 'OOjs UI icon information-progressive.svg'
			}
		},
		default                     = 'notice',
		allowBlankParams            = {'talk', 'sect', 'date', 'issue', 'fix', 'subst', 'hidden'},
		allowSmall                  = true,
		smallParam                  = 'left',
		smallClass                  = 'mbox-small-left',
		substCheck                  = true,
		classes                     = {'metadata', 'plainlinks', 'ambox'},
		imageEmptyCell              = true,
		imageCheckBlank             = true,
		imageSmallSize              = '20x20px',
		imageCellDiv                = true,
		useCollapsibleTextFields    = true,
		imageRightNone              = true,
		sectionDefault              = 'article',
		allowMainspaceCategories    = true,
		templateCategory            = 'Article message templates',
	        templateCategoryRequireName = true,
		templateErrorCategory       = nil,
		templateErrorParamsToCheck  = {'issue', 'fix', 'subst'}
	},
	
	cmbox = {
		types = {
			speedy = {
				class = 'cmbox-speedy',
				image = 'OOjs UI icon clock-destructive.svg'
			},
			delete = {
				class = 'cmbox-delete',
				image = 'OOjs UI icon alert-destructive.svg'
			},
			content = {
				class = 'cmbox-content',
				image = 'OOjs UI icon notice-warning.svg'
			},
			style = {
				class = 'cmbox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'cmbox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'cmbox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			notice = {
				class = 'cmbox-notice',
				image = 'OOjs UI icon information-progressive.svg'
			},
			caution = {
				class = 'cmbox-style',
				image = 'Ambox warning yellow.svg'
			}
		},
		default              = 'notice',
		showInvalidTypeError = true,
		classes              = {'plainlinks', 'cmbox'},
		imageEmptyCell       = true
	},
	
	fmbox = {
		types = {
			warning = {
				class = 'fmbox-warning',
				image = 'OOjs UI icon clock-destructive.svg'
			},
			editnotice = {
				class = 'fmbox-editnotice',
				image = 'OOjs UI icon information-progressive.svg'
			},
			system = {
				class = 'fmbox-system',
				image = 'OOjs UI icon information-progressive.svg'
			}
		},
		default              = 'system',
		showInvalidTypeError = true,
		classes              = {'plainlinks', 'fmbox'},
		imageEmptyCell       = false,
		imageRightNone       = false
	},
	
	imbox = {
		types = {
			speedy = {
				class = 'imbox-speedy',
				image = 'OOjs UI icon clock-destructive.svg'
			},
			delete = {
				class = 'imbox-delete',
				image = 'OOjs UI icon alert-destructive.svg'
			},
			content = {
				class = 'imbox-content',
				image = 'OOjs UI icon notice-warning.svg'
			},
			style = {
				class = 'imbox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'imbox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'imbox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			license = {
				class = 'imbox-license licensetpl',
				image = 'Imbox-license.svg'
			},
			featured = {
				class = 'imbox-featured',
				image = 'Cscr-featured.svg'
			},
			notice = {
				class = 'imbox-notice',
				image = 'OOjs UI icon information-progressive.svg'
			}
		},
		default              = 'notice',
		showInvalidTypeError = true,
		classes              = {'imbox'},
		usePlainlinksParam   = true,
		imageEmptyCell       = true,
		below                = true,
		templateCategory     = 'File message boxes'
	},
	
	ombox = {
		types = {
			speedy = {
				class = 'ombox-speedy',
				image = 'OOjs UI icon clock-destructive.svg'
			},
			delete = {
				class = 'ombox-delete',
				image = 'OOjs UI icon alert-destructive.svg'
			},
			warning = { -- alias for content
				class = 'ombox-content',
				image = 'OOjs UI icon notice-warning.svg'
			},
			content = {
				class = 'ombox-content',
				image = 'OOjs UI icon notice-warning.svg'
			},
			style = {
				class = 'ombox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'ombox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'ombox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			notice = {
				class = 'ombox-notice',
				image = 'OOjs UI icon information-progressive.svg'
			},
			critical = {
				class = 'mbox-critical',
				image = 'OOjs UI icon clock-destructive.svg'
			}
		},
		default              = 'notice',
		showInvalidTypeError = true,
		classes              = {'plainlinks', 'ombox'},
		allowSmall           = true,
		imageEmptyCell       = true,
		imageRightNone       = true
	},
	
	tmbox = {
		types = {
			speedy = {
				class = 'tmbox-speedy',
				image = 'OOjs UI icon clock-destructive.svg'
			},
			delete = {
				class = 'tmbox-delete',
				image = 'OOjs UI icon alert-destructive.svg'
			},
			content = {
				class = 'tmbox-content',
				image = 'OOjs UI icon notice-warning.svg'
			},
			style = {
				class = 'tmbox-style',
				image = 'Edit-clear.svg'
			},
			move = {
				class = 'tmbox-move',
				image = 'Merge-split-transwiki default.svg'
			},
			protection = {
				class = 'tmbox-protection',
				image = 'Semi-protection-shackle-keyhole.svg'
			},
			notice = {
				class = 'tmbox-notice',
				image = 'OOjs UI icon information-progressive.svg'
			}
		},
		default              = 'notice',
		showInvalidTypeError = true,
		classes              = {'plainlinks', 'tmbox'},
		allowSmall           = true,
		imageRightNone       = true,
		imageEmptyCell       = true,
		imageEmptyCellStyle  = true,
		templateCategory     = 'Talk message boxes'
	}
}
Retrieved from "https://map-wiki.com/index.php?title=Module:Message_box&oldid=22"