Anonymous user
Module:Message box: Difference between revisions
rewrite with a "box" object to make the code a little less spaghetti-like
(pass nocat, page, and demospace parameters to Module:Category handler, and add a choice for which arguments to allow as blank) |
(rewrite with a "box" object to make the code a little less spaghetti-like) |
||
Line 14:
local tconcat = table.concat
local
local function getTitleObject(page)
Line 34:
return false
end
end
Line 87 ⟶ 65:
end
if not ns then return end
if type(ns) == 'string' then
Line 101 ⟶ 79:
end
-- Gets the mbox type from a namespace number.
if nsid == 0 then
Line 119 ⟶ 97:
end
function
if type(
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:setTitle(args)
-- Get the title object and the namespace.
local pageTitle = getTitleObject(args.page ~= '' and args.page)
local demospace = box.getNamespaceId(args.demospace ~= '' and args.demospace)
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
local
if not
local boxTypes = {}
for k, v in pairs(dataTables) do
Line 144 ⟶ 149:
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
for i, param in ipairs(
if v ~= '' or k == param then
newArgs[k] = v
Line 154 ⟶ 162:
end
end
end
function box:setBoxParameters(cfg, args)
-- Get type data.
self.type = args.type
local typeData = cfg.types[self.type]
self.invalidType = 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.
self.isSmall = cfg.allowSmall and (args.small == 'yes' or args.small == true) and true or false
-- Add attributes, classes and styles.
self.id = args.id
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.style = args.style
-- Set text style.
self.textstyle = args.textstyle
-- Process data for collapsible text fields. At the moment these are only used in {{ambox}}.
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
if
self.name = args.name
local nameTitle = getTitleObject(name)
-- Get the self.issue value.
local sect = args.sect
if presentButBlank(sect) then
sect =
elseif type(sect) == 'string' then
sect = 'This ' .. sect
else
sect = nil
end
local issue =
issue = type(issue) == 'string' 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, ' ')
-- Get the self.talk value.
local talk = args.talk
if presentButBlank(talk) and self.isTemplatePage then
talk = '#'
end
-- See if the talk link exists and is for a talk or a content namespace.
local talkTitle = getTitleObject(talk)
-- If we couldn't process the talk page link, get the talk page of the current page.
success, talkTitle = pcall(title.talkPageTitle, title)
if not success then
talkTitle = nil
end
if talkTitle and talkTitle.exists then
local talkText = 'Relevant discussion may be found on'
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
local date = args.date
self.date = date and format(" <small>''(%s)''</small>", date)
if presentButBlank(self.date) and self.isTemplatePage then
self.date = lang:formatDate('F Y')
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
if
else
self.text = args.smalltext or args.text
end
else
end
--
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 imageCheckBlank = cfg.imageCheckBlank
local imageLeft = self.isSmall and args.smallimage or args.image
if imageLeft ~= 'none' and not imageCheckBlank or imageLeft ~= 'none' and imageCheckBlank and image ~= 'blank' 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
if args.category then
args.category1 = args.category
end
-- The following is roughly equivalent to the old {{Ambox/category}}.
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 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 then
self:addCat('main', mainCat)
end
if allCat then
self:addCat('main', allCat)
end
end
end
--
if cfg.templateCategory then
if
if
self:addCat('template', cfg.templateCategory)
end
elseif not self.title.isSubpage then
end
end
-- Add
if
local
local templateCat, templateSort
if not self.name and not self.title.isSubpage then
templateCat =
elseif type(self.name) == 'string' and title.prefixedText == ('Template:' .. name) then
local paramsToCheck =
local count = 0
for i, param in ipairs(paramsToCheck) do
Line 281 ⟶ 362:
end
if count > 0 then
templateCat =
templateSort = tostring(count)
end
if
templateCat =
templateSort = 'C'
end
end
self:addCat('template', templateCat, templateSort)
end
-- Categories for all namespaces.
if self.invalidType then
local allSort = (nsid == 0 and 'Main:' or '') .. 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 and args.demospace or nil,
page = self.pageTitle and pageTitle.prefixedText or nil
}
end
function box:export()
local root = htmlBuilder.create()
--
if
.
'Template <code>%s%s%s</code> has been incorrectly substituted.
end
-- Create the box table.
local
.attr('id',
for i, class in ipairs(
.addClass(class)
end
.
.attr('role', 'presentation')
-- Add the left-hand image.
local row =
if self.imageLeft then
local imageLeftCell = row.tag('td').addClass('mbox-image')
if
-- Not sure why only some box types use divs, but it probably has something to do
-- with that style="width: 52px;". @TODO: find out exactly what this does and fix this comment.
imageLeftCell = imageLeftCell.tag('div').css('width', '52px')
end
imageLeftCell
.wikitext(
elseif
-- 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(
end
-- Add the text.
local textCell = row.tag('td').addClass('mbox-text')
if
-- The message box uses advanced text parameters that allow things to be collapsible. At the
-- moment, only ambox uses this.
textCell
.cssText(
local textCellSpan = textCell.tag('span')
textCellSpan
.addClass('mbox-text-span')
.wikitext(self.issue)
if not 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
if not isSmall then
textCellSpan
.tag('span')
.addClass('hide-when-compact')
.wikitext(self.info and ' ' .. self.info)
end
else
-- Default text formatting - anything goes.
textCell
.cssText(
.wikitext(self.text)
end
-- Add the right-hand image.
if
local imageRightCell = row.tag('td').addClass('mbox-imageright')
if not
imageRightCell = imageRightCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
end
imageRightCell
.wikitext(self.imageRight)
end
-- Add the below row.
if
.tag('td')
.attr('colspan',
.addClass('mbox-text')
.cssText(
.wikitext(
end
-- Add error message for invalid type parameters.
if self.invalidType then
root
.tag('div')
.addClass('error')
.css('text-align', 'center')
.wikitext(format('This message box is using an invalid type parameter (<code>type=%s</code>) and needs fixing.',
end
-- Add categories
root
.wikitext(
return tostring(root)
end
local function makeBox(boxType, args)
box:setTitle(args)
local cfg = box:getConfig(boxType)
args = box:removeBlankArgs(cfg, args)
box:setBoxParameters(cfg, args)
return box:export()
end
Line 430 ⟶ 523:
-- assume args are being passed directly in from the debug console
-- or from another Lua module.
local
if frame == mw.getCurrentFrame() then
for k, v in pairs(frame.args) do
break
end
else
end
return makeBox(boxType, args)
end
end
return {
box = box,
makeBox = makeBox,
imbox = makeWrapper('imbox'),
ombox = makeWrapper('ombox'),
tmbox = makeWrapper('tmbox')
}
|