Difference between revisions of "Module:Message box"
Jump to navigation
Jump to search
>Mr. Stradivarius (switch indentation to tabs) |
>Mainframe98 |
||
(42 intermediate revisions by 22 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}}. | |||
-- | -- Load necessary modules. | ||
require('Module:No globals') | |||
local | local getArgs | ||
local yesno = require('Module:Yesno') | local yesno = require('Module:Yesno') | ||
-- Get a language object for formatDate and ucfirst. | -- Get a language object for formatDate and ucfirst. | ||
local lang = mw.language.getContentLanguage() | local lang = mw.language.getContentLanguage() | ||
-- | -- Define constants | ||
local | local CONFIG_MODULE = 'Module:Message box/configuration' | ||
local | local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'} | ||
local TEMPLATE_STYLES = 'Module:Message box/%s.css' | |||
local | |||
-------------------------------------------------------------------------------- | |||
-- Helper functions | |||
-------------------------------------------------------------------------------- | |||
local function getTitleObject( | 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 | ||
end | end | ||
Line 42: | Line 39: | ||
local ret = {} | local ret = {} | ||
for k in pairs(vals) do | for k in pairs(vals) do | ||
table.insert(ret, k) | |||
end | end | ||
table.sort(ret) | table.sort(ret) | ||
Line 53: | Line 50: | ||
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$') | local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$') | ||
if num then | if num then | ||
table.insert(nums, tonumber(num)) | |||
end | end | ||
end | end | ||
Line 60: | Line 57: | ||
end | end | ||
-------------------------------------------------------------------------------- | |||
-- Box class definition | |||
-------------------------------------------------------------------------------- | |||
local MessageBox = {} | |||
MessageBox.__index = MessageBox | |||
function MessageBox.new(boxType, args, cfg) | |||
args = args or {} | |||
local obj = {} | |||
obj.boxType = boxType | |||
-- Set the title object and the namespace. | |||
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle() | |||
-- Set the config for our box type. | |||
obj.cfg = cfg[boxType] | |||
if not obj.cfg then | |||
local ns = obj.title.namespace | |||
-- boxType is "mbox" or invalid input | |||
if args.demospace and args.demospace ~= '' then | |||
-- implement demospace parameter of mbox | |||
local demospace = string.lower(args.demospace) | |||
if DEMOSPACES[demospace] then | |||
-- use template from DEMOSPACES | |||
obj.cfg = cfg[DEMOSPACES[demospace]] | |||
obj.boxType = DEMOSPACES[demospace] | |||
elseif string.find( demospace, 'talk' ) then | |||
-- demo as a talk page | |||
obj.cfg = cfg.tmbox | |||
obj.boxType = 'tmbox' | |||
else | |||
-- default to ombox | |||
obj.cfg = cfg.ombox | |||
obj.boxType = 'ombox' | |||
end | |||
elseif ns == 0 then | |||
obj.cfg = cfg.ambox -- main namespace | |||
obj.boxType = 'ambox' | |||
elseif ns == 6 then | |||
obj.cfg = cfg.imbox -- file namespace | |||
obj.boxType = 'imbox' | |||
elseif ns == 14 then | |||
obj.cfg = cfg.cmbox -- category namespace | |||
obj.boxType = 'cmbox' | |||
else | else | ||
local nsTable = mw.site.namespaces[ns] | |||
if nsTable and nsTable.isTalk then | |||
obj.cfg = cfg.tmbox -- any talk namespace | |||
obj.boxType = 'tmbox' | |||
else | |||
obj.cfg = cfg.ombox -- other namespaces or invalid input | |||
obj.boxType = 'ombox' | |||
end | |||
end | end | ||
end | end | ||
-- Set the arguments, and remove all blank arguments except for the ones | |||
-- listed in cfg.allowBlankParams. | |||
local | do | ||
local newArgs = {} | |||
for k, v in pairs(args) do | |||
if v ~= '' then | |||
newArgs[k] = v | |||
end | |||
end | end | ||
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do | |||
newArgs[param] = args[param] | |||
for i, | |||
end | end | ||
obj.args = newArgs | |||
end | 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 | function MessageBox:addCat(ns, cat, sort) | ||
if not cat then | |||
if | return nil | ||
end | end | ||
if sort then | |||
if | cat = string.format('[[Category:%s|%s]]', cat, sort) | ||
else | |||
cat = string.format('[[Category:%s]]', cat) | |||
end | end | ||
self.hasCategories = true | |||
self.categories[ns] = self.categories[ns] or {} | |||
table.insert(self.categories[ns], cat) | |||
end | end | ||
function | function MessageBox:addClass(class) | ||
if not class then | |||
return nil | |||
end | end | ||
table.insert(self.classes, class) | |||
end | end | ||
function | function MessageBox:setParameters() | ||
local args = self.args | |||
local cfg = self.cfg | |||
-- Get type data. | -- Get type data. | ||
self.type = args.type | self.type = args.type | ||
local typeData = cfg.types[self.type] | local typeData = cfg.types[self.type] | ||
self.invalidTypeError = cfg.showInvalidTypeError and self.type and not typeData | self.invalidTypeError = cfg.showInvalidTypeError | ||
and self.type | |||
and not typeData | |||
typeData = typeData or cfg.types[cfg.default] | typeData = typeData or cfg.types[cfg.default] | ||
self.typeClass = typeData.class | self.typeClass = typeData.class | ||
Line 170: | Line 175: | ||
-- Find if the box has been wrongly substituted. | -- 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. | -- 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. | -- Add attributes, classes and styles. | ||
if | self.id = args.id | ||
self. | self.name = args.name | ||
if self.name then | |||
self:addClass('box-' .. string.gsub(self.name,' ','_')) | |||
end | |||
if yesno(args.plainlinks) ~= false then | |||
self:addClass('plainlinks') | |||
end | end | ||
for _, class in ipairs(cfg.classes or {}) do | for _, class in ipairs(cfg.classes or {}) do | ||
self:addClass(class) | self:addClass(class) | ||
Line 199: | Line 201: | ||
self:addClass(args.class) | self:addClass(args.class) | ||
self.style = args.style | self.style = args.style | ||
self.attrs = args.attrs | |||
-- Set text style. | -- Set text style. | ||
self.textstyle = args.textstyle | self.textstyle = args.textstyle | ||
-- Process data for collapsible text fields. At the moment these are only used in {{ambox}}. | -- 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 | |||
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 | if self.useCollapsibleTextFields then | ||
-- Get the self.issue value. | -- Get the self.issue value. | ||
if self.isSmall and args.smalltext then | if self.isSmall and args.smalltext then | ||
Line 221: | Line 240: | ||
end | end | ||
local issue = args.issue | local issue = args.issue | ||
issue = type(issue) == 'string' and issue or nil | issue = type(issue) == 'string' and issue ~= '' and issue or nil | ||
local text = args.text | local text = args.text | ||
text = type(text) == 'string' and text or nil | text = type(text) == 'string' and text or nil | ||
local issues = {} | local issues = {} | ||
table.insert(issues, sect) | |||
table.insert(issues, issue) | |||
table.insert(issues, text) | |||
self.issue = | self.issue = table.concat(issues, ' ') | ||
end | end | ||
-- Get the self.talk value. | -- Get the self.talk value. | ||
local talk = args.talk | local talk = args.talk | ||
if talk == '' and self. | -- 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 = '#' | talk = '#' | ||
elseif talk == '' then | |||
talk = nil | |||
end | end | ||
if talk then | 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 talkTitle = getTitleObject(talk) | ||
local talkArgIsTalkPage = true | |||
if not talkTitle or not talkTitle.isTalkPage then | if not talkTitle or not talkTitle.isTalkPage then | ||
talkArgIsTalkPage = false | |||
talkTitle = getTitleObject( | |||
self.title.text, | |||
mw.site.namespaces[self.title.namespace].talk.id | |||
) | |||
end | end | ||
if talkTitle and talkTitle.exists then | if talkTitle and talkTitle.exists then | ||
local talkText = 'Relevant discussion may be found on' | local talkText = 'Relevant discussion may be found on' | ||
if | if talkArgIsTalkPage then | ||
talkText = format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText) | talkText = string.format( | ||
'%s [[%s|%s]].', | |||
talkText, | |||
talk, | |||
talkTitle.prefixedText | |||
) | |||
else | else | ||
talkText = format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk) | talkText = string.format( | ||
'%s the [[%s#%s|talk page]].', | |||
talkText, | |||
talkTitle.prefixedText, | |||
talk | |||
) | |||
end | end | ||
self.talk = talkText | self.talk = talkText | ||
Line 259: | Line 300: | ||
-- Get other values. | -- Get other values. | ||
self.fix = args.fix | self.fix = args.fix ~= '' and args.fix or nil | ||
local date | local date | ||
if args.date and args.date ~= '' then | if args.date and args.date ~= '' then | ||
Line 267: | Line 308: | ||
end | end | ||
if date then | if date then | ||
self.date = format(" <small>''(%s)''</small>", date) | self.date = string.format(" <small class='date-container'>''(<span class='date'>%s</span>)''</small>", date) | ||
end | end | ||
self.info = args.info | self.info = args.info | ||
if yesno(args.removalnotice) then | |||
self.removalNotice = cfg.removalNotice | |||
end | |||
end | end | ||
-- Set the non-collapsible text field. At the moment this is used by all box types other than ambox, | -- 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 | if self.isSmall then | ||
self.text = args.smalltext or args.text | self.text = args.smalltext or args.text | ||
Line 284: | Line 328: | ||
-- General image settings. | -- General image settings. | ||
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv | self.imageCellDiv = not self.isSmall and cfg.imageCellDiv | ||
self.imageEmptyCell = cfg.imageEmptyCell | self.imageEmptyCell = cfg.imageEmptyCell | ||
if cfg.imageEmptyCellStyle then | if cfg.imageEmptyCellStyle then | ||
Line 297: | Line 341: | ||
self.imageLeft = imageLeft | self.imageLeft = imageLeft | ||
if not imageLeft then | if not imageLeft then | ||
local imageSize = self.isSmall and (cfg.imageSmallSize or '30x30px') or '40x40px' | local imageSize = self.isSmall | ||
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage or 'Imbox notice.png', imageSize) | 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 | ||
end | end | ||
Line 306: | Line 353: | ||
if not (cfg.imageRightNone and imageRight == 'none') then | if not (cfg.imageRightNone and imageRight == 'none') then | ||
self.imageRight = imageRight | 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 | end | ||
-- | -- The following is roughly equivalent to the old {{Ambox/category}}. | ||
local date = args.date | |||
date = type(date) == 'string' and date | |||
args. | 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 | end | ||
if allCat then | |||
self:addCat(0, allCat) | |||
if | |||
end | end | ||
end | end | ||
end | |||
function MessageBox:setTemplateCategories() | |||
local args = self.args | |||
local cfg = self.cfg | |||
-- Add template categories. | |||
if cfg.templateCategory then | if cfg.templateCategory then | ||
if | if cfg.templateCategoryRequireName then | ||
if self.isTemplatePage then | if self.isTemplatePage then | ||
self:addCat( | self:addCat(10, cfg.templateCategory) | ||
end | end | ||
elseif not self.title.isSubpage then | elseif not self.title.isSubpage then | ||
self:addCat( | self:addCat(10, cfg.templateCategory) | ||
end | end | ||
end | end | ||
-- Add template error | -- Add template error categories. | ||
if cfg.templateErrorCategory then | if cfg.templateErrorCategory then | ||
local templateErrorCategory = cfg.templateErrorCategory | local templateErrorCategory = cfg.templateErrorCategory | ||
Line 367: | Line 417: | ||
if not self.name and not self.title.isSubpage then | if not self.name and not self.title.isSubpage then | ||
templateCat = templateErrorCategory | templateCat = templateErrorCategory | ||
elseif | elseif self.isTemplatePage then | ||
local paramsToCheck = cfg.templateErrorParamsToCheck or {} | local paramsToCheck = cfg.templateErrorParamsToCheck or {} | ||
local count = 0 | local count = 0 | ||
Line 384: | Line 434: | ||
end | end | ||
end | end | ||
self:addCat( | self:addCat(10, templateCat, templateSort) | ||
end | end | ||
end | |||
-- | function MessageBox:setAllNamespaceCategories() | ||
-- Set categories for all namespaces. | |||
if self.invalidTypeError then | if self.invalidTypeError then | ||
local allSort = (self. | local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText | ||
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort) | self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort) | ||
end | end | ||
Line 395: | Line 447: | ||
self:addCat('all', 'Pages with incorrectly substituted templates') | self:addCat('all', 'Pages with incorrectly substituted templates') | ||
end | 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 | |||
-- Convert category tables to strings and pass them through [[Module:Category handler]]. | function MessageBox:renderCategories() | ||
if not self.hasCategories then | |||
main = | -- No categories added, no need to pass them to Category handler so, | ||
template = | -- if it was invoked, it would return the empty string. | ||
all = | -- So we shortcut and return the empty string. | ||
nocat = args.nocat | return "" | ||
end | |||
page = self. | -- 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 | end | ||
function | function MessageBox:export() | ||
local root = | local root = mw.html.create() | ||
-- Add the subst check error. | -- Add the subst check error. | ||
if self.isSubstituted and self.name then | if self.isSubstituted and self.name then | ||
root | root:tag('b') | ||
:addClass('error') | |||
:wikitext(string.format( | |||
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.', | 'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.', | ||
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}') | mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}') | ||
)) | )) | ||
end | end | ||
-- Add TemplateStyles | |||
root:wikitext(mw.getCurrentFrame():extensionTag{ | |||
name = 'templatestyles', | |||
args = { src = TEMPLATE_STYLES:format(self.boxType) }, | |||
}) | |||
-- Create the box table. | -- Create the box table. | ||
local boxTable = root | local boxTable | ||
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 i, class in ipairs(self.classes or {}) do | for i, class in ipairs(self.classes or {}) do | ||
boxTable | boxTable:addClass(class or nil) | ||
end | end | ||
boxTable | boxTable | ||
:cssText(self.style or nil) | |||
:attr('role', 'presentation') | |||
if self.attrs then | |||
boxTable:attr(self.attrs) | |||
end | |||
-- Add the left-hand image. | -- Add the left-hand image. | ||
local row = boxTable | local row = boxTable:tag('tr') | ||
if self.imageLeft then | if self.imageLeft then | ||
local imageLeftCell = row | local imageLeftCell = row:tag('td'):addClass('mbox-image') | ||
if self.imageCellDiv then | if self.imageCellDiv then | ||
-- If we are using a div, redefine imageLeftCell so that the image is inside it. | -- 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 | imageLeftCell = imageLeftCell:tag('div'):css('width', '52px') | ||
end | end | ||
imageLeftCell | imageLeftCell:wikitext(self.imageLeft or nil) | ||
elseif self.imageEmptyCell then | elseif self.imageEmptyCell then | ||
-- Some message boxes define an empty cell if no image is specified, and some don't. | -- 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 | |||
row | -- or padding necessary for text cell to have 100% width." | ||
row:tag('td') | |||
:addClass('mbox-empty-cell') | |||
:cssText(self.imageEmptyCellStyle or nil) | |||
end | end | ||
-- Add the text. | -- Add the text. | ||
local textCell = row | local textCell = row:tag('td'):addClass('mbox-text') | ||
if self.useCollapsibleTextFields then | if self.useCollapsibleTextFields then | ||
-- The message box uses advanced text parameters that allow things to be collapsible. At the | -- The message box uses advanced text parameters that allow things to be | ||
-- collapsible. At the moment, only ambox uses this. | |||
textCell | textCell:cssText(self.textstyle or nil) | ||
local textCellDiv = textCell:tag('div') | |||
local | textCellDiv | ||
:addClass('mbox-text-span') | |||
:wikitext(self.issue or nil) | |||
if (self.talk or self.fix) and not self.isSmall then | |||
if 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 | end | ||
if self.removalNotice then | |||
textCellDiv:tag('small') | |||
if | :addClass('hide-when-compact') | ||
:tag('i') | |||
:wikitext(string.format(" (%s)", self.removalNotice)) | |||
end | end | ||
else | else | ||
-- Default text formatting - anything goes. | -- Default text formatting - anything goes. | ||
textCell | textCell | ||
:cssText(self.textstyle or nil) | |||
:wikitext(self.text or nil) | |||
end | end | ||
-- Add the right-hand image. | -- Add the right-hand image. | ||
if self.imageRight then | if self.imageRight then | ||
local imageRightCell = row | local imageRightCell = row:tag('td'):addClass('mbox-imageright') | ||
if self.imageCellDiv then | if self.imageCellDiv then | ||
imageRightCell = imageRightCell | -- If we are using a div, redefine imageRightCell so that the image | ||
-- is inside it. | |||
imageRightCell = imageRightCell:tag('div'):css('width', '52px') | |||
end | end | ||
imageRightCell | imageRightCell | ||
:wikitext(self.imageRight or nil) | |||
end | end | ||
-- Add the below row. | -- Add the below row. | ||
if self.below then | if self.below then | ||
boxTable | 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 | end | ||
-- Add error message for invalid type parameters. | -- Add error message for invalid type parameters. | ||
if self.invalidTypeError then | if self.invalidTypeError then | ||
root | 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 | end | ||
-- Add categories. | -- Add categories. | ||
root | root:wikitext(self:renderCategories() or nil) | ||
return tostring(root) | return tostring(root) | ||
end | end | ||
local function | -------------------------------------------------------------------------------- | ||
-- Exports | |||
local | -------------------------------------------------------------------------------- | ||
box: | 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() | return box:export() | ||
end | end | ||
function mt.__index(t, k) | |||
return function (frame) | return function (frame) | ||
if not getArgs then | |||
getArgs = require('Module:Arguments').getArgs | |||
if | |||
end | end | ||
return main( | return t.main(k, getArgs(frame, {trim = false, removeBlanks = false})) | ||
end | end | ||
end | end | ||
return setmetatable(p, mt) | |||
Latest revision as of 16:41, 29 September 2021
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'
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}
local TEMPLATE_STYLES = 'Module:Message box/%s.css'
--------------------------------------------------------------------------------
-- 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 = {}
obj.boxType = boxType
-- Set the title object and the namespace.
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
-- Set the config for our box type.
obj.cfg = cfg[boxType]
if not obj.cfg then
local ns = obj.title.namespace
-- boxType is "mbox" or invalid input
if args.demospace and args.demospace ~= '' then
-- implement demospace parameter of mbox
local demospace = string.lower(args.demospace)
if DEMOSPACES[demospace] then
-- use template from DEMOSPACES
obj.cfg = cfg[DEMOSPACES[demospace]]
obj.boxType = DEMOSPACES[demospace]
elseif string.find( demospace, 'talk' ) then
-- demo as a talk page
obj.cfg = cfg.tmbox
obj.boxType = 'tmbox'
else
-- default to ombox
obj.cfg = cfg.ombox
obj.boxType = 'ombox'
end
elseif ns == 0 then
obj.cfg = cfg.ambox -- main namespace
obj.boxType = 'ambox'
elseif ns == 6 then
obj.cfg = cfg.imbox -- file namespace
obj.boxType = 'imbox'
elseif ns == 14 then
obj.cfg = cfg.cmbox -- category namespace
obj.boxType = 'cmbox'
else
local nsTable = mw.site.namespaces[ns]
if nsTable and nsTable.isTalk then
obj.cfg = cfg.tmbox -- any talk namespace
obj.boxType = 'tmbox'
else
obj.cfg = cfg.ombox -- other namespaces or invalid input
obj.boxType = 'ombox'
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
self.name = args.name
if self.name then
self:addClass('box-' .. string.gsub(self.name,' ','_'))
end
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
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 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 '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
-- 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 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)