Module:Message box: Difference between revisions
Content added Content deleted
(update from enwiki) |
(Undo revision 1688805 by Jackmcbarn (talk) Breaks a lot of templates because there is no css in the main css for this wiki. Wikipedia English has css for this.) |
||
Line 1: | Line 1: | ||
-- This is a meta-module for producing message box templates, including |
-- This is a meta-module for producing message box templates, including |
||
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}. |
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}. |
||
-- |
-- Require necessary modules. |
||
require('Module: |
local getArgs = require('Module:Arguments').getArgs |
||
local htmlBuilder = require('Module:HtmlBuilder') |
|||
local getArgs |
|||
local categoryHandler = require('Module:Category handler'). |
local categoryHandler = require('Module:Category handler').main |
||
local yesno = require('Module:Yesno') |
local yesno = require('Module:Yesno') |
||
-- Load the configuration page. |
|||
local cfgTables = mw.loadData('Module:Message box/configuration') |
|||
-- 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() |
||
-- Set aliases for often-used functions to reduce table lookups. |
|||
local format = mw.ustring.format |
|||
local tinsert = table.insert |
|||
local tconcat = table.concat |
|||
local trim = mw.text.trim |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- Helper functions |
-- Helper functions |
||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local function getTitleObject(...) |
local function getTitleObject(page, ...) |
||
if type(page) == 'string' then |
|||
-- Get the title object, passing the function through pcall |
|||
-- 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, ...) |
|||
local success, title = pcall(mw.title.new, page, ...) |
|||
if success then |
|||
if success then |
|||
return title |
|||
return title |
|||
end |
|||
end |
end |
||
end |
end |
||
local function union(t1, t2) |
local function union(t1, t2) |
||
-- Returns the union of two arrays. |
-- Returns the union of two arrays. |
||
Line 35: | Line 46: | ||
local ret = {} |
local ret = {} |
||
for k in pairs(vals) do |
for k in pairs(vals) do |
||
tinsert(ret, k) |
|||
end |
end |
||
table.sort(ret) |
table.sort(ret) |
||
return ret |
return ret |
||
end |
end |
||
local function getArgNums(args, prefix) |
local function getArgNums(args, prefix) |
||
local nums = {} |
local nums = {} |
||
Line 46: | Line 57: | ||
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 |
||
tinsert(nums, tonumber(num)) |
|||
end |
end |
||
end |
end |
||
Line 52: | Line 63: | ||
return nums |
return nums |
||
end |
end |
||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- Box class definition |
-- Box class definition |
||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local |
local box = {} |
||
box.__index = box |
|||
function |
function box.new() |
||
args = args or {} |
|||
local obj = {} |
local obj = {} |
||
setmetatable(obj, box) |
|||
return obj |
|||
-- Set the title object and the namespace. |
|||
end |
|||
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle() |
|||
function box.getNamespaceId(ns) |
|||
-- Set the config for our box type. |
|||
if not ns then return end |
|||
obj.cfg = cfg[boxType] |
|||
if |
if type(ns) == 'string' then |
||
ns = lang:ucfirst(mw.ustring.lower(ns)) |
|||
local ns = obj.title.namespace |
|||
if ns == 'Main' then |
|||
-- boxType is "mbox" or invalid input |
|||
ns = 0 |
|||
end |
|||
obj.cfg = cfg.ambox -- main namespace |
|||
end |
|||
elseif ns == 6 then |
|||
local nsTable = mw.site.namespaces[ns] |
|||
obj.cfg = cfg.imbox -- file namespace |
|||
if nsTable then |
|||
return nsTable.id |
|||
obj.cfg = cfg.cmbox -- category namespace |
|||
end |
|||
end |
|||
function box.getMboxType(nsid) |
|||
-- Gets the mbox type from a namespace number. |
|||
if nsid == 0 then |
|||
return 'ambox' -- main namespace |
|||
elseif nsid == 6 then |
|||
return 'imbox' -- file namespace |
|||
elseif nsid == 14 then |
|||
return 'cmbox' -- category namespace |
|||
else |
|||
local nsTable = mw.site.namespaces[nsid] |
|||
if nsTable and nsTable.isTalk then |
|||
return 'tmbox' -- any talk namespace |
|||
else |
else |
||
return 'ombox' -- other namespaces or invalid input |
|||
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 |
||
end |
|||
-- Set the arguments, and remove all blank arguments except for the ones |
|||
function box:addCat(ns, cat, sort) |
|||
-- listed in cfg.allowBlankParams. |
|||
if type(cat) ~= 'string' then return end |
|||
do |
|||
local nsVals = {'main', 'template', 'all'} |
|||
local tname |
|||
for k, v in pairs(args) do |
|||
for i, val in ipairs(nsVals) do |
|||
if v ~= '' then |
|||
if ns == val then |
|||
newArgs[k] = v |
|||
tname = ns .. 'Cats' |
|||
end |
|||
end |
end |
||
end |
|||
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do |
|||
if not tname then |
|||
newArgs[param] = args[param] |
|||
for i, val in ipairs(nsVals) do |
|||
nsVals[i] = format('"%s"', val) |
|||
end |
end |
||
error( |
|||
obj.args = newArgs |
|||
'invalid ns parameter passed to box:addCat; valid values are ' |
|||
.. mw.text.listToText(nsVals, nil, ' or ') |
|||
) |
|||
end |
|||
self[tname] = self[tname] or {} |
|||
if type(sort) == 'string' then |
|||
tinsert(self[tname], format('[[Category:%s|%s]]', cat, sort)) |
|||
else |
|||
tinsert(self[tname], format('[[Category:%s]]', cat)) |
|||
end |
end |
||
-- Define internal data structure. |
|||
obj.categories = {} |
|||
obj.classes = {} |
|||
return setmetatable(obj, MessageBox) |
|||
end |
end |
||
function |
function box:addClass(class) |
||
if |
if type(class) ~= 'string' then return end |
||
self.classes = self.classes or {} |
|||
return nil |
|||
tinsert(self.classes, class) |
|||
end |
|||
function box:addAttr(attr, val) |
|||
if type(attr) ~= 'string' or type(val) ~= 'string' then return end |
|||
self.attrs = self.attrs or {} |
|||
tinsert(self.attrs, attr) |
|||
end |
|||
function box:setTitle(args) |
|||
-- Get the title object and the namespace. |
|||
self.pageTitle = getTitleObject(args.page ~= '' and args.page) |
|||
self.title = self.pageTitle or mw.title.getCurrentTitle() |
|||
self.demospace = args.demospace ~= '' and args.demospace or nil |
|||
self.nsid = box.getNamespaceId(self.demospace) or self.title.namespace |
|||
end |
|||
function box:getConfig(boxType) |
|||
-- Get the box config data from the data page. |
|||
if boxType == 'mbox' then |
|||
boxType = box.getMboxType(self.nsid) |
|||
end |
end |
||
local cfg = cfgTables[boxType] |
|||
if sort then |
|||
if not cfg then |
|||
cat = string.format('[[Category:%s|%s]]', cat, sort) |
|||
local boxTypes = {} |
|||
else |
|||
for k, v in pairs(dataTables) do |
|||
cat = string.format('[[Category:%s]]', cat) |
|||
tinsert(boxTypes, format('"%s"', k)) |
|||
end |
|||
tinsert(boxTypes, '"mbox"') |
|||
error(format( |
|||
'invalid message box type "%s"; valid types are %s', |
|||
tostring(boxType), |
|||
mw.text.listToText(boxTypes) |
|||
), 2) |
|||
end |
end |
||
return cfg |
|||
self.categories[ns] = self.categories[ns] or {} |
|||
table.insert(self.categories[ns], cat) |
|||
end |
end |
||
function |
function box:removeBlankArgs(cfg, args) |
||
-- Only allow blank arguments for the parameter names listed in |
|||
if not class then |
|||
-- cfg.allowBlankParams. |
|||
return nil |
|||
local newArgs = {} |
|||
for k, v in pairs(args) do |
|||
if v ~= '' then |
|||
newArgs[k] = v |
|||
end |
|||
end |
|||
for i, param in ipairs(cfg.allowBlankParams or {}) do |
|||
newArgs[param] = args[param] |
|||
end |
end |
||
return newArgs |
|||
table.insert(self.classes, class) |
|||
end |
end |
||
function |
function box:setBoxParameters(cfg, args) |
||
local args = self.args |
|||
local cfg = self.cfg |
|||
-- Get type data. |
-- Get type data. |
||
self.type = args.type |
self.type = args.type |
||
Line 140: | Line 198: | ||
and self.type |
and self.type |
||
and not typeData |
and not typeData |
||
and true |
|||
or false |
|||
typeData = typeData or cfg.types[cfg.default] |
typeData = typeData or cfg.types[cfg.default] |
||
self.typeClass = typeData.class |
self.typeClass = typeData.class |
||
self.typeImage = typeData.image |
self.typeImage = typeData.image |
||
-- Find if the box has been wrongly substituted. |
-- Find if the box has been wrongly substituted. |
||
if cfg.substCheck and args.subst == 'SUBST' then |
|||
self.isSubstituted = true |
|||
end |
|||
-- Find whether we are using a small message box. |
-- Find whether we are using a small message box. |
||
if 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) |
||
) |
) |
||
then |
|||
self.isSmall = true |
|||
else |
|||
self.isSmall = false |
|||
end |
|||
-- Add attributes, classes and styles. |
-- Add attributes, classes and styles. |
||
if cfg.allowId then |
|||
self.id = args.id |
|||
self.id = args.id |
|||
end |
|||
self:addClass( |
self:addClass( |
||
cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks' |
cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks' |
||
Line 168: | Line 237: | ||
self.style = args.style |
self.style = args.style |
||
self.attrs = args.attrs |
self.attrs = args.attrs |
||
-- Set text style. |
-- Set text style. |
||
self.textstyle = args.textstyle |
self.textstyle = args.textstyle |
||
-- Find if we are on the template page or not. This functionality is only |
-- Find if we are on the template page or not. This functionality is only |
||
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory |
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory |
||
Line 191: | Line 260: | ||
self.isTemplatePage = self.templateTitle |
self.isTemplatePage = self.templateTitle |
||
and mw.title.equals(self.title, self.templateTitle) |
and mw.title.equals(self.title, self.templateTitle) |
||
or false |
|||
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 211: | Line 281: | ||
text = type(text) == 'string' and text or nil |
text = type(text) == 'string' and text or nil |
||
local issues = {} |
local issues = {} |
||
tinsert(issues, sect) |
|||
tinsert(issues, issue) |
|||
tinsert(issues, text) |
|||
self.issue = |
self.issue = tconcat(issues, ' ') |
||
end |
end |
||
-- Get the self.talk value. |
-- Get the self.talk value. |
||
local talk = args.talk |
local talk = args.talk |
||
Line 222: | Line 292: | ||
-- 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 248: | Line 318: | ||
local talkText = 'Relevant discussion may be found on' |
local talkText = 'Relevant discussion may be found on' |
||
if talkArgIsTalkPage then |
if talkArgIsTalkPage then |
||
talkText = |
talkText = format( |
||
'%s [[%s|%s]].', |
'%s [[%s|%s]].', |
||
talkText, |
talkText, |
||
Line 255: | Line 325: | ||
) |
) |
||
else |
else |
||
talkText = |
talkText = format( |
||
'%s the [[%s#%s|talk page]].', |
'%s the [[%s#%s|talk page]].', |
||
talkText, |
talkText, |
||
Line 265: | Line 335: | ||
end |
end |
||
end |
end |
||
-- Get other values. |
-- Get other values. |
||
self.fix = args.fix ~= '' and args.fix or nil |
self.fix = args.fix ~= '' and args.fix or nil |
||
Line 275: | Line 345: | ||
end |
end |
||
if date then |
if date then |
||
self.date = |
self.date = format(" <small>''(%s)''</small>", date) |
||
end |
end |
||
self.info = args.info |
self.info = args.info |
||
end |
end |
||
-- Set the non-collapsible text field. At the moment this is used by all box |
-- 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. |
-- types other than ambox, and also by ambox when small=yes. |
||
Line 287: | Line 357: | ||
self.text = args.text |
self.text = args.text |
||
end |
end |
||
-- Set the below row. |
-- Set the below row. |
||
self.below = cfg.below and args.below |
self.below = cfg.below and args.below |
||
-- General image settings. |
-- General image settings. |
||
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv |
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false |
||
self.imageEmptyCell = cfg.imageEmptyCell |
self.imageEmptyCell = cfg.imageEmptyCell |
||
if cfg.imageEmptyCellStyle then |
if cfg.imageEmptyCellStyle then |
||
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px' |
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px' |
||
end |
end |
||
-- Left image settings. |
-- Left image settings. |
||
local imageLeft = self.isSmall and args.smallimage or args.image |
local imageLeft = self.isSmall and args.smallimage or args.image |
||
Line 308: | Line 378: | ||
and (cfg.imageSmallSize or '30x30px') |
and (cfg.imageSmallSize or '30x30px') |
||
or '40x40px' |
or '40x40px' |
||
self.imageLeft = |
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage |
||
or 'Imbox notice.png', imageSize) |
or 'Imbox notice.png', imageSize) |
||
end |
end |
||
end |
end |
||
-- Right image settings. |
-- Right image settings. |
||
local imageRight = self.isSmall and args.smallimageright or args.imageright |
local imageRight = self.isSmall and args.smallimageright or args.imageright |
||
Line 318: | Line 388: | ||
self.imageRight = imageRight |
self.imageRight = imageRight |
||
end |
end |
||
end |
|||
-- Add mainspace categories. At the moment these are only used in {{ambox}}. |
|||
if cfg.allowMainspaceCategories then |
|||
function MessageBox:setMainspaceCategories() |
|||
if args.cat then |
|||
args.cat1 = args.cat |
|||
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 |
end |
||
self.catNums = getArgNums(args, 'cat') |
|||
if allCat then |
|||
if args.category then |
|||
self:addCat(0, allCat) |
|||
args.category1 = args.category |
|||
end |
|||
self.categoryNums = getArgNums(args, 'category') |
|||
if args.all then |
|||
args.all1 = args.all |
|||
end |
|||
self.allNums = getArgNums(args, 'all') |
|||
self.categoryParamNums = union(self.catNums, self.categoryNums) |
|||
self.categoryParamNums = union(self.categoryParamNums, self.allNums) |
|||
-- 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(self.categoryParamNums) 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 = format('%s %s %s', mainCat, preposition, date) |
|||
self:addCat('main', catTitle) |
|||
catTitle = getTitleObject('Category:' .. catTitle) |
|||
if not catTitle or not catTitle.exists then |
|||
self:addCat( |
|||
'main', |
|||
'Articles with invalid date parameter in template' |
|||
) |
|||
end |
|||
elseif mainCat and (not date or date == '') then |
|||
self:addCat('main', mainCat) |
|||
end |
|||
if allCat then |
|||
self:addCat('main', allCat) |
|||
end |
|||
end |
end |
||
end |
end |
||
end |
|||
-- Add template-namespace categories. |
|||
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('template', cfg.templateCategory) |
||
end |
end |
||
elseif not self.title.isSubpage then |
elseif not self.title.isSubpage then |
||
self:addCat( |
self:addCat('template', cfg.templateCategory) |
||
end |
end |
||
end |
end |
||
-- Add template error |
-- Add template error category. |
||
if cfg.templateErrorCategory then |
if cfg.templateErrorCategory then |
||
local templateErrorCategory = cfg.templateErrorCategory |
local templateErrorCategory = cfg.templateErrorCategory |
||
Line 398: | Line 468: | ||
end |
end |
||
end |
end |
||
self:addCat( |
self:addCat('template', templateCat, templateSort) |
||
end |
end |
||
end |
|||
-- Categories for all namespaces. |
|||
function MessageBox:setAllNamespaceCategories() |
|||
-- Set categories for all namespaces. |
|||
if self.invalidTypeError then |
if self.invalidTypeError then |
||
local allSort = (self. |
local allSort = (self.nsid == 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 411: | Line 479: | ||
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() |
|||
-- Convert category tables to strings and pass them through |
-- Convert category tables to strings and pass them through |
||
-- [[Module:Category handler]]. |
-- [[Module:Category handler]]. |
||
self.categories = categoryHandler{ |
|||
main = |
main = tconcat(self.mainCats or {}), |
||
template = |
template = tconcat(self.templateCats or {}), |
||
all = |
all = tconcat(self.allCats or {}), |
||
nocat = |
nocat = args.nocat, |
||
demospace = self.demospace, |
|||
page = self.pageTitle and self.pageTitle.prefixedText or nil |
|||
} |
} |
||
end |
end |
||
function |
function box:export() |
||
local root = |
local root = htmlBuilder.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( |
|||
.wikitext(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 |
||
-- Create the box table. |
-- Create the box table. |
||
local boxTable = root |
local boxTable = root.tag('table') |
||
boxTable |
boxTable |
||
.attr('id', self.id) |
|||
for i, class in ipairs(self.classes or {}) do |
for i, class in ipairs(self.classes or {}) do |
||
boxTable |
boxTable |
||
.addClass(class) |
|||
end |
end |
||
boxTable |
boxTable |
||
.cssText(self.style) |
|||
.attr('role', 'presentation') |
|||
for attr, val in pairs(self.attrs or {}) do |
|||
boxTable |
|||
if self.attrs then |
|||
.attr(attr, val) |
|||
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 470: | Line 531: | ||
-- 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').css('width', '52px') |
||
end |
end |
||
imageLeftCell |
imageLeftCell |
||
.wikitext(self.imageLeft) |
|||
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 478: | Line 540: | ||
-- 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') |
|||
.cssText(self.imageEmptyCellStyle) |
|||
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) |
|||
local textCellSpan = textCell:tag('span') |
|||
local textCellSpan = textCell.tag('span') |
|||
textCellSpan |
textCellSpan |
||
.addClass('mbox-text-span') |
|||
.wikitext(self.issue) |
|||
if not self.isSmall then |
if not self.isSmall then |
||
textCellSpan |
textCellSpan |
||
.tag('span') |
|||
.addClass('hide-when-compact') |
|||
:wikitext(self.talk and (' ' .. self.talk) or nil) |
|||
.wikitext(self.talk and ' ' .. self.talk) |
|||
.wikitext(self.fix and ' ' .. self.fix) |
|||
end |
end |
||
textCellSpan |
textCellSpan |
||
.wikitext(self.date and ' ' .. self.date) |
|||
if not self.isSmall then |
if not self.isSmall then |
||
textCellSpan |
textCellSpan |
||
.tag('span') |
|||
.addClass('hide-when-compact') |
|||
.wikitext(self.info and ' ' .. self.info) |
|||
end |
end |
||
else |
else |
||
-- Default text formatting - anything goes. |
-- Default text formatting - anything goes. |
||
textCell |
textCell |
||
.cssText(self.textstyle) |
|||
.wikitext(self.text) |
|||
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').css('width', '52px') |
||
end |
end |
||
imageRightCell |
imageRightCell |
||
.wikitext(self.imageRight) |
|||
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) |
|||
.wikitext(self.below) |
|||
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( |
|||
.wikitext(format( |
|||
'This message box is using an invalid "type=%s" parameter and needs fixing.', |
|||
'This message box is using an invalid "type=%s" parameter and needs fixing.', |
|||
self.type or '' |
|||
self.type or '' |
|||
)) |
|||
)) |
|||
end |
end |
||
-- Add categories. |
-- Add categories. |
||
root |
|||
root:wikitext(self:renderCategories() or nil) |
|||
.wikitext(self.categories) |
|||
return tostring(root) |
return tostring(root) |
||
end |
end |
||
local function main(boxType, args) |
|||
-------------------------------------------------------------------------------- |
|||
local outputBox = box.new() |
|||
-- Exports |
|||
outputBox:setTitle(args) |
|||
-------------------------------------------------------------------------------- |
|||
local cfg = outputBox:getConfig(boxType) |
|||
args = outputBox:removeBlankArgs(cfg, args) |
|||
local p, mt = {}, {} |
|||
outputBox:setBoxParameters(cfg, args) |
|||
return outputBox:export() |
|||
function p._exportClasses() |
|||
-- For testing. |
|||
return { |
|||
MessageBox = MessageBox |
|||
} |
|||
end |
end |
||
function |
local function makeWrapper(boxType) |
||
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData('Module:Message box/configuration')) |
|||
box:setParameters() |
|||
box:setCategories() |
|||
return box:export() |
|||
end |
|||
function mt.__index(t, k) |
|||
return function (frame) |
return function (frame) |
||
local args = getArgs(frame, {trim = false, removeBlanks = false}) |
|||
if not getArgs then |
|||
return main(boxType, args) |
|||
getArgs = require('Module:Arguments').getArgs |
|||
end |
|||
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false})) |
|||
end |
end |
||
end |
end |
||
local p = { |
|||
return setmetatable(p, mt) |
|||
main = main, |
|||
mbox = makeWrapper('mbox') |
|||
} |
|||
for boxType in pairs(cfgTables) do |
|||
p[boxType] = makeWrapper(boxType) |
|||
end |
|||
return p |
Revision as of 16:52, 10 August 2015
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}}.
-- Require necessary modules.
local getArgs = require('Module:Arguments').getArgs
local htmlBuilder = require('Module:HtmlBuilder')
local categoryHandler = require('Module:Category handler').main
local yesno = require('Module:Yesno')
-- Load the configuration page.
local cfgTables = mw.loadData('Module:Message box/configuration')
-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()
-- Set aliases for often-used functions to reduce table lookups.
local format = mw.ustring.format
local tinsert = table.insert
local tconcat = table.concat
local trim = mw.text.trim
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------
local function getTitleObject(page, ...)
if type(page) == 'string' then
-- 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, page, ...)
if success then
return title
end
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
tinsert(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
tinsert(nums, tonumber(num))
end
end
table.sort(nums)
return nums
end
--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------
local box = {}
box.__index = box
function box.new()
local obj = {}
setmetatable(obj, box)
return obj
end
function box.getNamespaceId(ns)
if not ns then return end
if type(ns) == 'string' then
ns = lang:ucfirst(mw.ustring.lower(ns))
if ns == 'Main' then
ns = 0
end
end
local nsTable = mw.site.namespaces[ns]
if nsTable then
return nsTable.id
end
end
function box.getMboxType(nsid)
-- Gets the mbox type from a namespace number.
if nsid == 0 then
return 'ambox' -- main namespace
elseif nsid == 6 then
return 'imbox' -- file namespace
elseif nsid == 14 then
return 'cmbox' -- category namespace
else
local nsTable = mw.site.namespaces[nsid]
if nsTable and nsTable.isTalk then
return 'tmbox' -- any talk namespace
else
return 'ombox' -- other namespaces or invalid input
end
end
end
function box:addCat(ns, cat, sort)
if type(cat) ~= 'string' then return end
local nsVals = {'main', 'template', 'all'}
local tname
for i, val in ipairs(nsVals) do
if ns == val then
tname = ns .. 'Cats'
end
end
if not tname then
for i, val in ipairs(nsVals) do
nsVals[i] = format('"%s"', val)
end
error(
'invalid ns parameter passed to box:addCat; valid values are '
.. mw.text.listToText(nsVals, nil, ' or ')
)
end
self[tname] = self[tname] or {}
if type(sort) == 'string' then
tinsert(self[tname], format('[[Category:%s|%s]]', cat, sort))
else
tinsert(self[tname], format('[[Category:%s]]', cat))
end
end
function box:addClass(class)
if type(class) ~= 'string' then return end
self.classes = self.classes or {}
tinsert(self.classes, class)
end
function box:addAttr(attr, val)
if type(attr) ~= 'string' or type(val) ~= 'string' then return end
self.attrs = self.attrs or {}
tinsert(self.attrs, attr)
end
function box:setTitle(args)
-- Get the title object and the namespace.
self.pageTitle = getTitleObject(args.page ~= '' and args.page)
self.title = self.pageTitle or mw.title.getCurrentTitle()
self.demospace = args.demospace ~= '' and args.demospace or nil
self.nsid = box.getNamespaceId(self.demospace) or self.title.namespace
end
function box:getConfig(boxType)
-- Get the box config data from the data page.
if boxType == 'mbox' then
boxType = box.getMboxType(self.nsid)
end
local cfg = cfgTables[boxType]
if not cfg then
local boxTypes = {}
for k, v in pairs(dataTables) do
tinsert(boxTypes, format('"%s"', k))
end
tinsert(boxTypes, '"mbox"')
error(format(
'invalid message box type "%s"; valid types are %s',
tostring(boxType),
mw.text.listToText(boxTypes)
), 2)
end
return cfg
end
function box:removeBlankArgs(cfg, args)
-- Only allow blank arguments for the parameter names listed in
-- cfg.allowBlankParams.
local newArgs = {}
for k, v in pairs(args) do
if v ~= '' then
newArgs[k] = v
end
end
for i, param in ipairs(cfg.allowBlankParams or {}) do
newArgs[param] = args[param]
end
return newArgs
end
function box:setBoxParameters(cfg, args)
-- Get type data.
self.type = args.type
local typeData = cfg.types[self.type]
self.invalidTypeError = cfg.showInvalidTypeError
and self.type
and not typeData
and true
or false
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
self.typeImage = typeData.image
-- Find if the box has been wrongly substituted.
if cfg.substCheck and args.subst == 'SUBST' then
self.isSubstituted = true
end
-- Find whether we are using a small message box.
if cfg.allowSmall and (
cfg.smallParam and args.small == cfg.smallParam
or not cfg.smallParam and yesno(args.small)
)
then
self.isSmall = true
else
self.isSmall = false
end
-- Add attributes, classes and styles.
if cfg.allowId then
self.id = args.id
end
self:addClass(
cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks'
)
for _, class in ipairs(cfg.classes or {}) do
self:addClass(class)
end
if self.isSmall then
self:addClass(cfg.smallClass or 'mbox-small')
end
self:addClass(self.typeClass)
self:addClass(args.class)
self.style = args.style
self.attrs = args.attrs
-- Set text style.
self.textstyle = args.textstyle
-- Find if we are on the template page or not. This functionality is only
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
-- and cfg.templateCategoryRequireName are set.
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
if self.useCollapsibleTextFields
or cfg.templateCategory
and cfg.templateCategoryRequireName
then
self.name = args.name
if self.name then
local templateName = mw.ustring.match(
self.name,
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
) or self.name
templateName = 'Template:' .. templateName
self.templateTitle = getTitleObject(templateName)
end
self.isTemplatePage = self.templateTitle
and mw.title.equals(self.title, self.templateTitle)
or false
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 = {}
tinsert(issues, sect)
tinsert(issues, issue)
tinsert(issues, text)
self.issue = tconcat(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 = format(
'%s [[%s|%s]].',
talkText,
talk,
talkTitle.prefixedText
)
else
talkText = 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 = format(" <small>''(%s)''</small>", date)
end
self.info = args.info
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 and true or false
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 = 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
-- Add mainspace categories. At the moment these are only used in {{ambox}}.
if cfg.allowMainspaceCategories then
if args.cat then
args.cat1 = args.cat
end
self.catNums = getArgNums(args, 'cat')
if args.category then
args.category1 = args.category
end
self.categoryNums = getArgNums(args, 'category')
if args.all then
args.all1 = args.all
end
self.allNums = getArgNums(args, 'all')
self.categoryParamNums = union(self.catNums, self.categoryNums)
self.categoryParamNums = union(self.categoryParamNums, self.allNums)
-- 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(self.categoryParamNums) 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 = format('%s %s %s', mainCat, preposition, date)
self:addCat('main', catTitle)
catTitle = getTitleObject('Category:' .. catTitle)
if not catTitle or not catTitle.exists then
self:addCat(
'main',
'Articles with invalid date parameter in template'
)
end
elseif mainCat and (not date or date == '') then
self:addCat('main', mainCat)
end
if allCat then
self:addCat('main', allCat)
end
end
end
-- Add template-namespace categories.
if cfg.templateCategory then
if cfg.templateCategoryRequireName then
if self.isTemplatePage then
self:addCat('template', cfg.templateCategory)
end
elseif not self.title.isSubpage then
self:addCat('template', cfg.templateCategory)
end
end
-- Add template error category.
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('template', templateCat, templateSort)
end
-- Categories for all namespaces.
if self.invalidTypeError then
local allSort = (self.nsid == 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
-- Convert category tables to strings and pass them through
-- [[Module:Category handler]].
self.categories = categoryHandler{
main = tconcat(self.mainCats or {}),
template = tconcat(self.templateCats or {}),
all = tconcat(self.allCats or {}),
nocat = args.nocat,
demospace = self.demospace,
page = self.pageTitle and self.pageTitle.prefixedText or nil
}
end
function box:export()
local root = htmlBuilder.create()
-- Add the subst check error.
if self.isSubstituted and self.name then
root
.tag('b')
.addClass('error')
.wikitext(format(
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
))
end
-- Create the box table.
local boxTable = root.tag('table')
boxTable
.attr('id', self.id)
for i, class in ipairs(self.classes or {}) do
boxTable
.addClass(class)
end
boxTable
.cssText(self.style)
.attr('role', 'presentation')
for attr, val in pairs(self.attrs or {}) do
boxTable
.attr(attr, val)
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)
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)
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)
local textCellSpan = textCell.tag('span')
textCellSpan
.addClass('mbox-text-span')
.wikitext(self.issue)
if not self.isSmall then
textCellSpan
.tag('span')
.addClass('hide-when-compact')
.wikitext(self.talk and ' ' .. self.talk)
.wikitext(self.fix and ' ' .. self.fix)
end
textCellSpan
.wikitext(self.date and ' ' .. self.date)
if not self.isSmall then
textCellSpan
.tag('span')
.addClass('hide-when-compact')
.wikitext(self.info and ' ' .. self.info)
end
else
-- Default text formatting - anything goes.
textCell
.cssText(self.textstyle)
.wikitext(self.text)
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)
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)
.wikitext(self.below)
end
-- Add error message for invalid type parameters.
if self.invalidTypeError then
root
.tag('div')
.css('text-align', 'center')
.wikitext(format(
'This message box is using an invalid "type=%s" parameter and needs fixing.',
self.type or ''
))
end
-- Add categories.
root
.wikitext(self.categories)
return tostring(root)
end
local function main(boxType, args)
local outputBox = box.new()
outputBox:setTitle(args)
local cfg = outputBox:getConfig(boxType)
args = outputBox:removeBlankArgs(cfg, args)
outputBox:setBoxParameters(cfg, args)
return outputBox:export()
end
local function makeWrapper(boxType)
return function (frame)
local args = getArgs(frame, {trim = false, removeBlanks = false})
return main(boxType, args)
end
end
local p = {
main = main,
mbox = makeWrapper('mbox')
}
for boxType in pairs(cfgTables) do
p[boxType] = makeWrapper(boxType)
end
return p