Diff: Module:Message box
Comparing revision #2 (2023-02-02 02:41:43) with revision #3 (2023-09-02 22:54:30).
| Old | New |
|---|---|
require('strict') |
require('strict') |
local getArgs |
local getArgs |
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 CONFIG_MODULE = 'Module:Message box/configuration' |
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'} |
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'} |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- Helper functions |
-- Helper functions |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local function getTitleObject(...) |
local function getTitleObject(...) |
-- 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. |
-- in case we are over the expensive function count limit. |
local success, title = pcall(mw.title.new, ...) |
local success, title = pcall(mw.title.new, ...) |
if success then |
if success then |
return title |
return title |
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. |
local vals = {} |
local vals = {} |
for i, v in ipairs(t1) do |
for i, v in ipairs(t1) do |
vals[v] = true |
vals[v] = true |
end |
end |
for i, v in ipairs(t2) do |
for i, v in ipairs(t2) do |
vals[v] = true |
vals[v] = true |
end |
end |
local ret = {} |
local ret = {} |
for k in pairs(vals) do |
for k in pairs(vals) do |
table.insert(ret, k) |
table.insert(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 = {} |
for k, v in pairs(args) do |
for k, v in pairs(args) do |
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)) |
table.insert(nums, tonumber(num)) |
end |
end |
end |
end |
table.sort(nums) |
table.sort(nums) |
return nums |
return nums |
end |
end |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- Box class definition |
-- Box class definition |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local MessageBox = {} |
local MessageBox = {} |
MessageBox.__index = MessageBox |
MessageBox.__index = MessageBox |
function MessageBox.new(boxType, args, cfg) |
function MessageBox.new(boxType, args, cfg) |
args = args or {} |
args = args or {} |
local obj = {} |
local obj = {} |
-- Set the title object and the namespace. |
-- Set the title object and the namespace. |
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle() |
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle() |
-- Set the config for our box type. |
-- Set the config for our box type. |
obj.cfg = cfg[boxType] |
obj.cfg = cfg[boxType] |
if not obj.cfg then |
if not obj.cfg then |
local ns = obj.title.namespace |
local ns = obj.title.namespace |
-- boxType is "mbox" or invalid input |
-- boxType is "mbox" or invalid input |
if args.demospace and args.demospace ~= '' then |
if args.demospace and args.demospace ~= '' then |
-- implement demospace parameter of mbox |
-- implement demospace parameter of mbox |
local demospace = string.lower(args.demospace) |
local demospace = string.lower(args.demospace) |
if DEMOSPACES[demospace] then |
if DEMOSPACES[demospace] then |
-- use template from DEMOSPACES |
-- use template from DEMOSPACES |
obj.cfg = cfg[DEMOSPACES[demospace]] |
obj.cfg = cfg[DEMOSPACES[demospace]] |
elseif string.find( demospace, 'talk' ) then |
elseif string.find( demospace, 'talk' ) then |
-- demo as a talk page |
-- demo as a talk page |
obj.cfg = cfg.tmbox |
obj.cfg = cfg.tmbox |
else |
else |
-- default to ombox |
-- default to ombox |
obj.cfg = cfg.ombox |
obj.cfg = cfg.ombox |
end |
end |
elseif ns == 0 then |
elseif ns == 0 then |
obj.cfg = cfg.ambox -- main namespace |
obj.cfg = cfg.ambox -- main namespace |
elseif ns == 6 then |
elseif ns == 6 then |
obj.cfg = cfg.imbox -- file namespace |
obj.cfg = cfg.imbox -- file namespace |
elseif ns == 14 then |
elseif ns == 14 then |
obj.cfg = cfg.cmbox -- category namespace |
obj.cfg = cfg.cmbox -- category namespace |
else |
else |
local nsTable = mw.site.namespaces[ns] |
local nsTable = mw.site.namespaces[ns] |
if nsTable and nsTable.isTalk then |
if nsTable and nsTable.isTalk then |
obj.cfg = cfg.tmbox -- any talk namespace |
obj.cfg = cfg.tmbox -- any talk namespace |
else |
else |
obj.cfg = cfg.ombox -- other namespaces or invalid input |
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 |
-- Set the arguments, and remove all blank arguments except for the ones |
-- listed in cfg.allowBlankParams. |
-- listed in cfg.allowBlankParams. |
do |
do |
local newArgs = {} |
local newArgs = {} |
for k, v in pairs(args) do |
for k, v in pairs(args) do |
if v ~= '' then |
if v ~= '' then |
newArgs[k] = v |
newArgs[k] = v |
end |
end |
end |
end |
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do |
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do |
newArgs[param] = args[param] |
newArgs[param] = args[param] |
end |
end |
obj.args = newArgs |
obj.args = newArgs |
end |
end |
-- Define internal data structure. |
-- Define internal data structure. |
obj.categories = {} |
obj.categories = {} |
obj.classes = {} |
obj.classes = {} |
-- For lazy loading of [[Module:Category handler]]. |
-- For lazy loading of [[Module:Category handler]]. |
obj.hasCategories = false |
obj.hasCategories = false |
return setmetatable(obj, MessageBox) |
return setmetatable(obj, MessageBox) |
end |
end |
function MessageBox:addCat(ns, cat, sort) |
function MessageBox:addCat(ns, cat, sort) |
if not cat then |
if not cat then |
return nil |
return nil |
end |
end |
if sort then |
if sort then |
cat = string.format('[[Category:%s|%s]]', cat, sort) |
cat = string.format('[[Category:%s|%s]]', cat, sort) |
else |
else |
cat = string.format('[[Category:%s]]', cat) |
cat = string.format('[[Category:%s]]', cat) |
end |
end |
self.hasCategories = true |
self.hasCategories = true |
self.categories[ns] = self.categories[ns] or {} |
self.categories[ns] = self.categories[ns] or {} |
table.insert(self.categories[ns], cat) |
table.insert(self.categories[ns], cat) |
end |
end |
function MessageBox:addClass(class) |
function MessageBox:addClass(class) |
if not class then |
if not class then |
return nil |
return nil |
end |
end |
table.insert(self.classes, class) |
table.insert(self.classes, class) |
end |
end |
function MessageBox:setParameters() |
function MessageBox:setParameters() |
local args = self.args |
local args = self.args |
local cfg = self.cfg |
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 |
self.invalidTypeError = cfg.showInvalidTypeError |
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 |
self.typeImage = typeData.image |
self.typeImage = typeData.image |
self.typeImageNeedsLink = typeData.imageNeedsLink |
|
-- Find if the box has been wrongly substituted. |
-- Find if the box has been wrongly substituted. |
self.isSubstituted = cfg.substCheck and args.subst == 'SUBST' |
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 ( |
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. |
self.id = args.id |
self.id = args.id |
self.name = args.name |
self.name = args.name |
if self.name then |
if self.name then |
self:addClass('box-' .. string.gsub(self.name,' ','_')) |
self:addClass('box-' .. string.gsub(self.name,' ','_')) |
end |
end |
if yesno(args.plainlinks) ~= false then |
if yesno(args.plainlinks) ~= false then |
self:addClass('plainlinks') |
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) |
end |
end |
if self.isSmall then |
if self.isSmall then |
self:addClass(cfg.smallClass or 'mbox-small') |
self:addClass(cfg.smallClass or 'mbox-small') |
end |
end |
self:addClass(self.typeClass) |
self:addClass(self.typeClass) |
self:addClass(args.class) |
self:addClass(args.class) |
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 |
-- and cfg.templateCategoryRequireName are set. |
-- and cfg.templateCategoryRequireName are set. |
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields |
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields |
if self.useCollapsibleTextFields |
if self.useCollapsibleTextFields |
or cfg.templateCategory |
or cfg.templateCategory |
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( |
self.name, |
self.name, |
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$' |
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$' |
) or self.name |
) or self.name |
templateName = 'Template:' .. templateName |
templateName = 'Template:' .. templateName |
self.templateTitle = getTitleObject(templateName) |
self.templateTitle = getTitleObject(templateName) |
end |
end |
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}}. |
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 |
self.issue = args.smalltext |
self.issue = args.smalltext |
else |
else |
local sect |
local sect |
if args.sect == '' then |
if args.sect == '' then |
sect = 'This ' .. (cfg.sectionDefault or 'page') |
sect = 'This ' .. (cfg.sectionDefault or 'page') |
elseif type(args.sect) == 'string' then |
elseif type(args.sect) == 'string' then |
sect = 'This ' .. args.sect |
sect = 'This ' .. args.sect |
end |
end |
local issue = args.issue |
local issue = args.issue |
issue = type(issue) == 'string' and issue ~= '' 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, sect) |
table.insert(issues, issue) |
table.insert(issues, issue) |
table.insert(issues, text) |
table.insert(issues, text) |
self.issue = table.concat(issues, ' ') |
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 |
-- Show talk links on the template page or template subpages if the talk |
-- Show talk links on the template page or template subpages if the talk |
-- 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) |
or self.title:isSubpageOf(self.templateTitle) |
or self.title:isSubpageOf(self.templateTitle) |
) |
) |
then |
then |
talk = '#' |
talk = '#' |
elseif talk == '' then |
elseif talk == '' then |
talk = nil |
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 |
-- 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 |
-- assume that it's a section heading, and make a link to the talk |
-- page of the current page with that section heading. |
-- page of the current page with that section heading. |
local talkTitle = getTitleObject(talk) |
local talkTitle = getTitleObject(talk) |
local talkArgIsTalkPage = true |
local talkArgIsTalkPage = true |
if not talkTitle or not talkTitle.isTalkPage then |
if not talkTitle or not talkTitle.isTalkPage then |
talkArgIsTalkPage = false |
talkArgIsTalkPage = false |
talkTitle = getTitleObject( |
talkTitle = getTitleObject( |
self.title.text, |
self.title.text, |
mw.site.namespaces[self.title.namespace].talk.id |
mw.site.namespaces[self.title.namespace].talk.id |
) |
) |
end |
end |
if talkTitle and talkTitle.exists then |
if talkTitle and talkTitle.exists then |
local talkText |
local talkText |
if self.isSmall then |
if self.isSmall then |
local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. '#' .. talk) |
local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. '#' .. talk) |
talkText = string.format('([[%s|talk]])', talkLink) |
talkText = string.format('([[%s|talk]])', talkLink) |
else |
else |
talkText = 'Relevant discussion may be found on' |
talkText = 'Relevant discussion may be found on' |
if talkArgIsTalkPage then |
if talkArgIsTalkPage then |
talkText = string.format( |
talkText = string.format( |
'%s [[%s|%s]].', |
'%s [[%s|%s]].', |
talkText, |
talkText, |
talk, |
talk, |
talkTitle.prefixedText |
talkTitle.prefixedText |
) |
) |
else |
else |
talkText = string.format( |
talkText = string.format( |
'%s the [[%s#%s|talk page]].', |
'%s the [[%s#%s|talk page]].', |
talkText, |
talkText, |
talkTitle.prefixedText, |
talkTitle.prefixedText, |
talk |
talk |
) |
) |
end |
end |
end |
end |
self.talk = talkText |
self.talk = talkText |
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 |
local date |
local date |
if args.date and args.date ~= '' then |
if args.date and args.date ~= '' then |
date = args.date |
date = args.date |
elseif args.date == '' and self.isTemplatePage then |
elseif args.date == '' and self.isTemplatePage then |
date = lang:formatDate('F Y') |
date = lang:formatDate('F Y') |
end |
end |
if date then |
if date then |
self.date = string.format(" <span class='date-container'><i>(<span class='date'>%s</span>)</i></span>", date) |
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 |
if yesno(args.removalnotice) then |
self.removalNotice = cfg.removalNotice |
self.removalNotice = cfg.removalNotice |
end |
end |
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. |
if self.isSmall then |
if self.isSmall then |
self.text = args.smalltext or args.text |
self.text = args.smalltext or args.text |
else |
else |
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 |
self.imageEmptyCell = cfg.imageEmptyCell |
self.imageEmptyCell = cfg.imageEmptyCell |
-- 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 |
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none' |
if cfg.imageCheckBlank and imageLeft ~= 'blank' and imageLeft ~= 'none' |
or not cfg.imageCheckBlank and imageLeft ~= 'none' |
or not cfg.imageCheckBlank and imageLeft ~= 'none' |
then |
then |
self.imageLeft = imageLeft |
self.imageLeft = imageLeft |
if not imageLeft then |
if not imageLeft then |
local imageSize = self.isSmall |
local imageSize = self.isSmall |
and (cfg.imageSmallSize or '30x30px') |
and (cfg.imageSmallSize or '30x30px') |
or '40x40px' |
or '40x40px' |
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage |
|
or 'Imbox notice.png', imageSize) |
|
self.imageLeft = string.format('[[File:%s|%s%s|alt=]]', self.typeImage |
|
or 'Information icon4.svg', imageSize, self.typeImageNeedsLink and "" or "|link=" ) |
|
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 |
if not (cfg.imageRightNone and imageRight == 'none') then |
if not (cfg.imageRightNone and imageRight == 'none') then |
self.imageRight = imageRight |
self.imageRight = imageRight |
end |
end |
-- set templatestyles |
-- set templatestyles |
self.base_templatestyles = cfg.templatestyles |
self.base_templatestyles = cfg.templatestyles |
self.templatestyles = args.templatestyles |
self.templatestyles = args.templatestyles |
end |
end |
function MessageBox:setMainspaceCategories() |
function MessageBox:setMainspaceCategories() |
local args = self.args |
local args = self.args |
local cfg = self.cfg |
local cfg = self.cfg |
if not cfg.allowMainspaceCategories then |
if not cfg.allowMainspaceCategories then |
return nil |
return nil |
end |
end |
local nums = {} |
local nums = {} |
for _, prefix in ipairs{'cat', 'category', 'all'} do |
for _, prefix in ipairs{'cat', 'category', 'all'} do |
args[prefix .. '1'] = args[prefix] |
args[prefix .. '1'] = args[prefix] |
nums = union(nums, getArgNums(args, prefix)) |
nums = union(nums, getArgNums(args, prefix)) |
end |
end |
-- The following is roughly equivalent to the old {{Ambox/category}}. |
-- The following is roughly equivalent to the old {{Ambox/category}}. |
local date = args.date |
local date = args.date |
date = type(date) == 'string' and date |
date = type(date) == 'string' and date |
local preposition = 'from' |
local preposition = 'from' |
for _, num in ipairs(nums) do |
for _, num in ipairs(nums) do |
local mainCat = args['cat' .. tostring(num)] |
local mainCat = args['cat' .. tostring(num)] |
or args['category' .. tostring(num)] |
or args['category' .. tostring(num)] |
local allCat = args['all' .. tostring(num)] |
local allCat = args['all' .. tostring(num)] |
mainCat = type(mainCat) == 'string' and mainCat |
mainCat = type(mainCat) == 'string' and mainCat |
allCat = type(allCat) == 'string' and allCat |
allCat = type(allCat) == 'string' and allCat |
if mainCat and date and date ~= '' then |
if mainCat and date and date ~= '' then |
local catTitle = string.format('%s %s %s', mainCat, preposition, date) |
local catTitle = string.format('%s %s %s', mainCat, preposition, date) |
self:addCat(0, catTitle) |
self:addCat(0, catTitle) |
catTitle = getTitleObject('Category:' .. catTitle) |
catTitle = getTitleObject('Category:' .. catTitle) |
if not catTitle or not catTitle.exists then |
if not catTitle or not catTitle.exists then |
self:addCat(0, 'Articles with invalid date parameter in template') |
self:addCat(0, 'Articles with invalid date parameter in template') |
end |
end |
elseif mainCat and (not date or date == '') then |
elseif mainCat and (not date or date == '') then |
self:addCat(0, mainCat) |
self:addCat(0, mainCat) |
end |
end |
if allCat then |
if allCat then |
self:addCat(0, allCat) |
self:addCat(0, allCat) |
end |
end |
end |
end |
end |
end |
function MessageBox:setTemplateCategories() |
function MessageBox:setTemplateCategories() |
local args = self.args |
local args = self.args |
local cfg = self.cfg |
local cfg = self.cfg |
-- Add template categories. |
-- 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(10, cfg.templateCategory) |
self:addCat(10, cfg.templateCategory) |
end |
end |
elseif not self.title.isSubpage then |
elseif not self.title.isSubpage then |
self:addCat(10, cfg.templateCategory) |
self:addCat(10, cfg.templateCategory) |
end |
end |
end |
end |
-- Add template error categories. |
-- Add template error categories. |
if cfg.templateErrorCategory then |
if cfg.templateErrorCategory then |
local templateErrorCategory = cfg.templateErrorCategory |
local templateErrorCategory = cfg.templateErrorCategory |
local templateCat, templateSort |
local templateCat, templateSort |
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 self.isTemplatePage then |
elseif self.isTemplatePage then |
local paramsToCheck = cfg.templateErrorParamsToCheck or {} |
local paramsToCheck = cfg.templateErrorParamsToCheck or {} |
local count = 0 |
local count = 0 |
for i, param in ipairs(paramsToCheck) do |
for i, param in ipairs(paramsToCheck) do |
if not args[param] then |
if not args[param] then |
count = count + 1 |
count = count + 1 |
end |
end |
end |
end |
if count > 0 then |
if count > 0 then |
templateCat = templateErrorCategory |
templateCat = templateErrorCategory |
templateSort = tostring(count) |
templateSort = tostring(count) |
end |
end |
if self.categoryNums and #self.categoryNums > 0 then |
if self.categoryNums and #self.categoryNums > 0 then |
templateCat = templateErrorCategory |
templateCat = templateErrorCategory |
templateSort = 'C' |
templateSort = 'C' |
end |
end |
end |
end |
self:addCat(10, templateCat, templateSort) |
self:addCat(10, templateCat, templateSort) |
end |
end |
end |
end |
function MessageBox:setAllNamespaceCategories() |
function MessageBox:setAllNamespaceCategories() |
-- Set categories for all namespaces. |
-- Set categories for all namespaces. |
if self.invalidTypeError then |
if self.invalidTypeError then |
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText |
local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText |
self:addCat('all', 'iWiki message box parameter needs fixing', allSort) |
|
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort) |
|
end |
end |
if self.isSubstituted then |
if self.isSubstituted then |
self:addCat('all', 'Pages with incorrectly substituted templates') |
self:addCat('all', 'Pages with incorrectly substituted templates') |
end |
end |
end |
end |
function MessageBox:setCategories() |
function MessageBox:setCategories() |
if self.title.namespace == 0 then |
if self.title.namespace == 0 then |
self:setMainspaceCategories() |
self:setMainspaceCategories() |
elseif self.title.namespace == 10 then |
elseif self.title.namespace == 10 then |
self:setTemplateCategories() |
self:setTemplateCategories() |
end |
end |
self:setAllNamespaceCategories() |
self:setAllNamespaceCategories() |
end |
end |
function MessageBox:renderCategories() |
function MessageBox:renderCategories() |
if not self.hasCategories then |
if not self.hasCategories then |
-- No categories added, no need to pass them to Category handler so, |
-- No categories added, no need to pass them to Category handler so, |
-- if it was invoked, it would return the empty string. |
-- if it was invoked, it would return the empty string. |
-- So we shortcut and return the empty string. |
-- So we shortcut and return the empty string. |
return "" |
return "" |
end |
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{ |
return require('Module:Category handler')._main{ |
main = table.concat(self.categories[0] or {}), |
main = table.concat(self.categories[0] or {}), |
template = table.concat(self.categories[10] or {}), |
template = table.concat(self.categories[10] or {}), |
all = table.concat(self.categories.all or {}), |
all = table.concat(self.categories.all or {}), |
nocat = self.args.nocat, |
nocat = self.args.nocat, |
page = self.args.page |
page = self.args.page |
} |
} |
end |
end |
function MessageBox:export() |
function MessageBox:export() |
local root = mw.html.create() |
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:tag('b') |
root:tag('b') |
:addClass('error') |
:addClass('error') |
:wikitext(string.format( |
: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 |
local frame = mw.getCurrentFrame() |
local frame = mw.getCurrentFrame() |
root:wikitext(frame:extensionTag{ |
root:wikitext(frame:extensionTag{ |
name = 'templatestyles', |
name = 'templatestyles', |
args = { src = self.base_templatestyles }, |
args = { src = self.base_templatestyles }, |
}) |
}) |
-- Add support for a single custom templatestyles sheet. Undocumented as |
-- Add support for a single custom templatestyles sheet. Undocumented as |
-- need should be limited and many templates using mbox are substed; we |
-- need should be limited and many templates using mbox are substed; we |
-- don't want to spread templatestyles sheets around to arbitrary places |
-- don't want to spread templatestyles sheets around to arbitrary places |
if self.templatestyles then |
if self.templatestyles then |
root:wikitext(frame:extensionTag{ |
root:wikitext(frame:extensionTag{ |
name = 'templatestyles', |
name = 'templatestyles', |
args = { src = self.templatestyles }, |
args = { src = self.templatestyles }, |
}) |
}) |
end |
end |
-- Create the box table. |
-- Create the box table. |
local boxTable = root:tag('table') |
local boxTable = root:tag('table') |
boxTable:attr('id', self.id or nil) |
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:addClass(class or nil) |
boxTable:addClass(class or nil) |
end |
end |
boxTable |
boxTable |
:cssText(self.style or nil) |
:cssText(self.style or nil) |
:attr('role', 'presentation') |
:attr('role', 'presentation') |
if self.attrs then |
if self.attrs then |
boxTable:attr(self.attrs) |
boxTable:attr(self.attrs) |
end |
end |
-- Add the left-hand image. |
-- Add the left-hand image. |
local row = boxTable:tag('tr') |
local row = boxTable:tag('tr') |
if self.imageLeft then |
if self.imageLeft then |
local imageLeftCell = row:tag('td'):addClass('mbox-image') |
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 |
-- is inside it. Divs use style="width: 52px;", which limits the |
-- 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, |
-- 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:tag('div'):addClass('mbox-image-div') |
imageLeftCell = imageLeftCell:tag('div'):addClass('mbox-image-div') |
end |
end |
imageLeftCell:wikitext(self.imageLeft or nil) |
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 |
-- some don't. The old template code in templates where empty cells are |
-- some don't. The old template code in templates where empty cells are |
-- 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:tag('td') |
row:tag('td') |
:addClass('mbox-empty-cell') |
:addClass('mbox-empty-cell') |
end |
end |
-- Add the text. |
-- Add the text. |
local textCell = row:tag('td'):addClass('mbox-text') |
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:cssText(self.textstyle or nil) |
textCell:cssText(self.textstyle or nil) |
local textCellDiv = textCell:tag('div') |
local textCellDiv = textCell:tag('div') |
textCellDiv |
textCellDiv |
:addClass('mbox-text-span') |
:addClass('mbox-text-span') |
:wikitext(self.issue or nil) |
:wikitext(self.issue or nil) |
if (self.talk or self.fix) then |
if (self.talk or self.fix) then |
textCellDiv:tag('span') |
textCellDiv:tag('span') |
:addClass('hide-when-compact') |
:addClass('hide-when-compact') |
:wikitext(self.talk and (' ' .. self.talk) or nil) |
:wikitext(self.talk and (' ' .. self.talk) or nil) |
:wikitext(self.fix and (' ' .. self.fix) or nil) |
:wikitext(self.fix and (' ' .. self.fix) or nil) |
end |
end |
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil) |
textCellDiv:wikitext(self.date and (' ' .. self.date) or nil) |
if self.info and not self.isSmall then |
if self.info and not self.isSmall then |
textCellDiv |
textCellDiv |
:tag('span') |
:tag('span') |
:addClass('hide-when-compact') |
:addClass('hide-when-compact') |
:wikitext(self.info and (' ' .. self.info) or nil) |
:wikitext(self.info and (' ' .. self.info) or nil) |
end |
end |
if self.removalNotice then |
if self.removalNotice then |
textCellDiv:tag('span') |
textCellDiv:tag('span') |
:addClass('hide-when-compact') |
:addClass('hide-when-compact') |
:tag('i') |
:tag('i') |
:wikitext(string.format(" (%s)", self.removalNotice)) |
: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) |
:cssText(self.textstyle or nil) |
:wikitext(self.text 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:tag('td'):addClass('mbox-imageright') |
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:tag('div'):addClass('mbox-image-div') |
imageRightCell = imageRightCell:tag('div'):addClass('mbox-image-div') |
end |
end |
imageRightCell |
imageRightCell |
:wikitext(self.imageRight or nil) |
:wikitext(self.imageRight or nil) |
end |
end |
-- Add the below row. |
-- Add the below row. |
if self.below then |
if self.below then |
boxTable:tag('tr') |
boxTable:tag('tr') |
:tag('td') |
:tag('td') |
:attr('colspan', self.imageRight and '3' or '2') |
:attr('colspan', self.imageRight and '3' or '2') |
:addClass('mbox-text') |
:addClass('mbox-text') |
:cssText(self.textstyle or nil) |
:cssText(self.textstyle or nil) |
:wikitext(self.below 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:tag('div') |
root:tag('div') |
:addClass('mbox-invalid-type') |
:addClass('mbox-invalid-type') |
:wikitext(string.format( |
:wikitext(string.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:wikitext(self:renderCategories() or nil) |
root:wikitext(self:renderCategories() or nil) |
return tostring(root) |
return tostring(root) |
end |
end |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
-- Exports |
-- Exports |
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
local p, mt = {}, {} |
local p, mt = {}, {} |
function p._exportClasses() |
function p._exportClasses() |
-- For testing. |
-- For testing. |
return { |
return { |
MessageBox = MessageBox |
MessageBox = MessageBox |
} |
} |
end |
end |
function p.main(boxType, args, cfgTables) |
function p.main(boxType, args, cfgTables) |
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE)) |
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE)) |
box:setParameters() |
box:setParameters() |
box:setCategories() |
box:setCategories() |
return box:export() |
return box:export() |
end |
end |
function mt.__index(t, k) |
function mt.__index(t, k) |
return function (frame) |
return function (frame) |
if not getArgs then |
if not getArgs then |
getArgs = require('Module:Arguments').getArgs |
getArgs = require('Module:Arguments').getArgs |
end |
end |
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false})) |
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false})) |
end |
end |
end |
end |
return setmetatable(p, mt) |
return setmetatable(p, mt) |