Module:Message box: Difference between revisions
Jump to navigation
Jump to search
m>Mr. Stradivarius Allow passing attributes per protected edit request by User:Jackmcbarn. Also remove undocumented "hidden" parameter and format the module so it mostly fits within 80 chars. |
MeowyCats2 (talk | contribs) m 125 revisions imported |
||
(72 intermediate revisions by 41 users not shown) | |||
Line 1: | Line 1: | ||
require('Module:No globals') | |||
local getArgs | |||
local | |||
local yesno = require('Module:Yesno') | local yesno = require('Module:Yesno') | ||
local lang = mw.language.getContentLanguage() | local lang = mw.language.getContentLanguage() | ||
local CONFIG_MODULE = 'Module:Message box/configuration' | |||
local | local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'} | ||
local | |||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
Line 24: | Line 11: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
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 46: | Line 31: | ||
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 57: | Line 42: | ||
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 68: | Line 53: | ||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||
local | local MessageBox = {} | ||
MessageBox.__index = MessageBox | |||
function | function MessageBox.new(boxType, args, cfg) | ||
args = args or {} | |||
local obj = {} | 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 | 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]] | |||
elseif string.find( demospace, 'talk' ) then | |||
-- demo as a talk page | |||
obj.cfg = cfg.tmbox | |||
else | |||
-- default to ombox | |||
obj.cfg = cfg.ombox | |||
end | |||
elseif 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 | 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 | ||
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 | ||
Line 198: | Line 152: | ||
and self.type | and self.type | ||
and not typeData | 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 205: | Line 157: | ||
-- 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 | cfg.smallParam and args.small == cfg.smallParam | ||
or not cfg.smallParam and yesno(args.small) | 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 249: | Line 196: | ||
and cfg.templateCategoryRequireName | and cfg.templateCategoryRequireName | ||
then | then | ||
if self.name then | if self.name then | ||
local templateName = mw.ustring.match( | local templateName = mw.ustring.match( | ||
Line 260: | Line 206: | ||
self.isTemplatePage = self.templateTitle | self.isTemplatePage = self.templateTitle | ||
and mw.title.equals(self.title, self.templateTitle) | and mw.title.equals(self.title, self.templateTitle) | ||
end | end | ||
-- Process data for collapsible text fields. At the moment these are only | -- Process data for collapsible text fields. At the moment these are only | ||
-- used in {{ambox}}. | -- used in {{ambox}}. | ||
Line 281: | Line 226: | ||
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 | ||
Line 292: | Line 237: | ||
-- parameter is blank. | -- parameter is blank. | ||
if talk == '' | if talk == '' | ||
and self.templateTitle | and self.templateTitle | ||
and ( | and ( | ||
mw.title.equals(self.templateTitle, self.title) | mw.title.equals(self.templateTitle, self.title) | ||
Line 316: | Line 261: | ||
end | end | ||
if talkTitle and talkTitle.exists then | if talkTitle and talkTitle.exists then | ||
local talkText | |||
if self.isSmall then | |||
local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. '#' .. talk) | |||
talkText = string.format('([[%s|talk]])', talkLink) | |||
else | |||
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 | |||
end | |||
self.talk = talkText | self.talk = talkText | ||
end | end | ||
Line 345: | Line 296: | ||
end | end | ||
if date then | if date then | ||
self.date = format(" < | self.date = string.format(" <span class='date-container'><i>(<span class='date'>%s</span>)</i></span>", date) | ||
end | end | ||
self.info = args.info | self.info = args.info | ||
if yesno(args.removalnotice) then | |||
self.removalNotice = cfg.removalNotice | |||
end | |||
end | end | ||
Line 362: | Line 316: | ||
-- 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 | ||
-- Left image settings. | -- Left image settings. | ||
Line 378: | Line 329: | ||
and (cfg.imageSmallSize or '30x30px') | and (cfg.imageSmallSize or '30x30px') | ||
or '40x40px' | or '40x40px' | ||
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage | self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage | ||
or 'Imbox notice.png', imageSize) | or 'Imbox notice.png', imageSize) | ||
end | end | ||
Line 388: | Line 339: | ||
self.imageRight = imageRight | self.imageRight = imageRight | ||
end | end | ||
-- set templatestyles | |||
self.base_templatestyles = cfg.templatestyles | |||
self.templatestyles = args.templatestyles | |||
end | |||
-- | function MessageBox:setMainspaceCategories() | ||
local args = self.args | |||
local cfg = self.cfg | |||
args. | |||
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 | end | ||
if allCat then | |||
self:addCat(0, allCat) | |||
if | |||
end | end | ||
end | end | ||
end | |||
-- Add template | function MessageBox:setTemplateCategories() | ||
local args = self.args | |||
local cfg = self.cfg | |||
-- Add template categories. | |||
if cfg.templateCategory then | if cfg.templateCategory then | ||
if cfg.templateCategoryRequireName then | 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 468: | Line 423: | ||
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 479: | Line 436: | ||
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 | |||
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 | -- Convert category tables to strings and pass them through | ||
-- [[Module:Category handler]]. | -- [[Module:Category handler]]. | ||
return require('Module:Category handler')._main{ | |||
main = | main = table.concat(self.categories[0] or {}), | ||
template = | template = table.concat(self.categories[10] or {}), | ||
all = | all = table.concat(self.categories.all or {}), | ||
nocat = args.nocat | nocat = self.args.nocat, | ||
page = self.args.page | |||
page = self. | |||
} | } | ||
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.', | |||
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}') | |||
)) | |||
end | |||
local frame = mw.getCurrentFrame() | |||
root:wikitext(frame:extensionTag{ | |||
name = 'templatestyles', | |||
args = { src = self.base_templatestyles }, | |||
}) | |||
-- Add support for a single custom templatestyles sheet. Undocumented as | |||
-- need should be limited and many templates using mbox are substed; we | |||
-- don't want to spread templatestyles sheets around to arbitrary places | |||
if self.templatestyles then | |||
root:wikitext(frame:extensionTag{ | |||
name = 'templatestyles', | |||
args = { src = self.templatestyles }, | |||
}) | |||
end | end | ||
-- Create the box table. | -- Create the box table. | ||
local boxTable = root | local boxTable = root:tag('table') | ||
boxTable | 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') | |||
boxTable | if self.attrs then | ||
boxTable:attr(self.attrs) | |||
end | 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 | -- If we are using a div, redefine imageLeftCell so that the image | ||
Line 531: | Line 516: | ||
-- image width to 52px. If any images in a div are wider than that, | -- 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. | -- they may overlap with the text or cause other display problems. | ||
imageLeftCell = imageLeftCell | imageLeftCell = imageLeftCell:tag('div'):addClass('mbox-image-div') | ||
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 message boxes define an empty cell if no image is specified, and | ||
Line 540: | Line 524: | ||
-- specified gives the following hint: "No image. Cell with some width | -- specified gives the following hint: "No image. Cell with some width | ||
-- or padding necessary for text cell to have 100% width." | -- or padding necessary for text cell to have 100% width." | ||
row | row:tag('td') | ||
:addClass('mbox-empty-cell') | |||
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 | -- The message box uses advanced text parameters that allow things to be | ||
-- collapsible. At the moment, only ambox uses this. | -- 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) then | |||
if | 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('span') | |||
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 | ||
-- If we are using a div, redefine imageRightCell so that the image | -- If we are using a div, redefine imageRightCell so that the image | ||
-- is inside it. | -- is inside it. | ||
imageRightCell = imageRightCell | imageRightCell = imageRightCell:tag('div'):addClass('mbox-image-div') | ||
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') | ||
:addClass('mbox-invalid-type') | |||
: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 | |||
local p, mt = {}, {} | |||
return | 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 | end | ||
function mt.__index(t, k) | |||
return function (frame) | 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 | ||
end | end | ||
return setmetatable(p, mt) | |||