Climate Change AI Wiki

Module:Message box: Difference between revisions

Module Discussion

Module:Message box (edit)

Revision as of 17:56, 29 November 2014

1,445 bytes removed ,  9 years ago
bring in changes from sandbox
No edit summary
(bring in changes from sandbox)
Line 1:
-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
 
-- RequireLoad necessary modules.
local getArgs = require('Module:ArgumentsNo globals').getArgs
local getArgs
local htmlBuilder = require('Module:HtmlBuilder')
local categoryHandler = require('Module:Category handler').main_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, ...)
-- Get the title object, passing the function through pcall
if type(page) == 'string' then
-- Getin thecase titlewe object,are passingover the expensive function through pcallcount limit.
local success, title = pcall(mw.title.new, ...)
-- in case we are over the expensive function count limit.
if success then
local success, title = pcall(mw.title.new, page, ...)
return title
if success then
return title
end
end
end
 
local function union(t1, t2)
-- Returns the union of two arrays.
Line 46 ⟶ 35:
local ret = {}
for k in pairs(vals) do
tinserttable.insert(ret, k)
end
table.sort(ret)
return ret
end
 
local function getArgNums(args, prefix)
local nums = {}
Line 57 ⟶ 46:
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
if num then
tinserttable.insert(nums, tonumber(num))
end
end
Line 63 ⟶ 52:
return nums
end
 
--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------
 
local boxMessageBox = {}
boxMessageBox.__index = boxMessageBox
 
function boxMessageBox.new(boxType, args, cfg)
args = args or {}
local obj = {}
 
setmetatable(obj, box)
-- Set the title object and the namespace.
return obj
obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle()
end
 
-- Set the config for our box type.
function box.getNamespaceId(ns)
obj.cfg = cfg[boxType]
if not ns then return end
if type(ns)not == 'string'obj.cfg then
local ns = obj.title.namespace
ns = lang:ucfirst(mw.ustring.lower(ns))
-- boxType is "mbox" or invalid input
if ns == 'Main' then
if ns == 0 then
obj.cfg = cfg.ambox -- main namespace
end
elseif ns == 6 then
end
obj.cfg = cfg.imbox -- file namespace
local nsTable = mw.site.namespaces[ns]
if elseif nsTablens == 14 then
obj.cfg = cfg.cmbox -- category namespace
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
returnlocal 'ombox'nsTable -- other= mw.site.namespaces or invalid input[ns]
if nsTable and nsTable.isTalk then
obj.cfg = cfg.tmbox -- any talk namespace
else
obj.cfg = cfg.ombox -- other namespaces or invalid input
end
end
end
 
end
-- Set the arguments, and remove all blank arguments except for the ones
-- listed in cfg.allowBlankParams.
function box:addCat(ns, cat, sort)
do
if type(cat) ~= 'string' then return end
local nsValsnewArgs = {'main', 'template', 'all'}
for k, v in pairs(args) do
local tname
if v ~= '' then
for i, val in ipairs(nsVals) do
newArgs[k] = v
if ns == val then
end
tname = ns .. 'Cats'
end
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
end
newArgs[param] = args[param]
if not tname then
for i, val in ipairs(nsVals) do
nsVals[i] = format('"%s"', val)
end
obj.args = newArgs
error(
'invalid ns parameter passed to box:addCat; valid values are '
.. mw.text.listToText(nsVals, nil, ' or ')
)
end
 
self[tname] = self[tname] or {}
-- Define internal data structure.
if type(sort) == 'string' then
obj.categories = {}
tinsert(self[tname], format('[[Category:%s|%s]]', cat, sort))
obj.classes = {}
else
 
tinsert(self[tname], format('[[Category:%s]]', cat))
return setmetatable(obj, MessageBox)
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 boxMessageBox:getConfigaddCat(boxTypens, cat, sort)
if not cat then
-- Get the box config data from the data page.
return nil
if boxType == 'mbox' then
boxType = box.getMboxType(self.nsid)
end
if sort then
local cfg = cfgTables[boxType]
cat = string.format('[[Category:%s|%s]]', cat, sort)
if not cfg then
else
local boxTypes = {}
cat = string.format('[[Category:%s]]', cat)
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
self.categories[ns] = self.categories[ns] or {}
return cfg
table.insert(self.categories[ns], cat)
end
 
function boxMessageBox:removeBlankArgsaddClass(cfg, argsclass)
if not class then
-- Only allow blank arguments for the parameter names listed in
return nil
-- 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
table.insert(self.classes, class)
return newArgs
end
 
function boxMessageBox:setBoxParameterssetParameters(cfg, args)
local args = self.args
local cfg = self.cfg
 
-- Get type data.
self.type = args.type
Line 198 ⟶ 140:
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.
ifself.isSubstituted = cfg.substCheck and args.subst == 'SUBST' then
 
self.isSubstituted = true
end
-- Find whether we are using a small message box.
ifself.isSmall = 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
Line 237 ⟶ 170:
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
Line 260 ⟶ 193:
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}}.
Line 281 ⟶ 213:
text = type(text) == 'string' and text or nil
local issues = {}
tinserttable.insert(issues, sect)
tinserttable.insert(issues, issue)
tinserttable.insert(issues, text)
self.issue = tconcattable.concat(issues, ' ')
end
 
-- Get the self.talk value.
local talk = args.talk
Line 292 ⟶ 224:
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
Line 318 ⟶ 250:
local talkText = 'Relevant discussion may be found on'
if talkArgIsTalkPage then
talkText = string.format(
'%s [[%s|%s]].',
talkText,
Line 325 ⟶ 257:
)
else
talkText = string.format(
'%s the [[%s#%s|talk page]].',
talkText,
Line 335 ⟶ 267:
end
end
 
-- Get other values.
self.fix = args.fix ~= '' and args.fix or nil
Line 345 ⟶ 277:
end
if date then
self.date = string.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.
Line 357 ⟶ 289:
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
Line 378 ⟶ 310:
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
or 'Imbox notice.png', imageSize)
end
end
 
-- Right image settings.
local imageRight = self.isSmall and args.smallimageright or args.imageright
Line 388 ⟶ 320:
self.imageRight = imageRight
end
end
 
-- Add mainspace categories. At the moment these are only used in {{ambox}}.
function MessageBox:setMainspaceCategories()
if cfg.allowMainspaceCategories then
if local args.cat then= self.args
local cfg = self.cfg
args.cat1 = args.cat
 
end
if not cfg.allowMainspaceCategories then
self.catNums = getArgNums(args, 'cat')
return nil
if args.category then
end
args.category1 = args.category
 
end
local nums = {}
self.categoryNums = getArgNums(args, 'category')
for _, prefix in ipairs{'cat', 'category', 'all'} do
if args.all then
args[prefix ..all1 '1'] = args.all[prefix]
nums = union(nums, getArgNums(args, prefix))
end
end
self.allNums = getArgNums(args, 'all')
 
self.categoryParamNums = union(self.catNums, self.categoryNums)
-- The following is roughly equivalent to the old {{Ambox/category}}.
self.categoryParamNums = union(self.categoryParamNums, self.allNums)
local date = args.date
-- The following is roughly equivalent to the old {{Ambox/category}}.
local date = type(date) == 'string' and args.date
local preposition = 'from'
date = type(date) == 'string' and date
for _, num in ipairs(nums) do
local preposition = 'from'
local mainCat = args['cat' .. tostring(num)]
for _, num in ipairs(self.categoryParamNums) do
local mainCat =or args['catcategory' .. tostring(num)]
orlocal allCat = args['categoryall' .. tostring(num)]
mainCat = type(mainCat) == 'string' and mainCat
local allCat = args['all' .. tostring(num)]
mainCatallCat = type(mainCatallCat) == 'string' and mainCatallCat
if mainCat and date and date ~= '' then
allCat = type(allCat) == 'string' and allCat
local catTitle = string.format('%s %s %s', mainCat, preposition, date)
if mainCat and date and date ~= '' then
self:addCat(0, catTitle)
local catTitle = format('%s %s %s', mainCat, preposition, date)
self:addCatcatTitle = getTitleObject('mainCategory:', .. catTitle)
if not catTitle =or getTitleObject('Category:'not catTitle..exists catTitle)then
self:addCat(0, 'Articles with invalid date parameter in template')
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
elseif mainCat and (not date or date == '') then
self:addCat(0, mainCat)
end
if allCat then
self:addCat(0, allCat)
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.templateCategoryRequireName then
if self.isTemplatePage then
self:addCat('template'10, cfg.templateCategory)
end
elseif not self.title.isSubpage then
self:addCat('template'10, cfg.templateCategory)
end
end
 
-- Add template error categorycategories.
if cfg.templateErrorCategory then
local templateErrorCategory = cfg.templateErrorCategory
Line 468 ⟶ 400:
end
end
self:addCat('template'10, templateCat, templateSort)
end
end
 
-- Categories for all namespaces.
function MessageBox:setAllNamespaceCategories()
-- Set categories for all namespaces.
if self.invalidTypeError then
local allSort = (self.nsidtitle.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
end
Line 479 ⟶ 413:
self:addCat('all', 'Pages with incorrectly substituted templates')
end
end
 
function MessageBox:setCategories()
if self.title.namespace == 0 then
self:setMainspaceCategories()
elseif self.title.namespace == 10 then
self:setTemplateCategories()
end
self:setAllNamespaceCategories()
end
 
function MessageBox:renderCategories()
-- Convert category tables to strings and pass them through
-- [[Module:Category handler]].
self.categories =return categoryHandler{
main = tconcattable.concat(self.mainCatscategories[0] or {}),
template = tconcattable.concat(self.templateCatscategories[10] or {}),
all = tconcattable.concat(self.allCatscategories.all or {}),
nocat = self.args.nocat,
demospacepage = self.demospace,args.page
page = self.pageTitle and self.pageTitle.prefixedText or nil
}
end
 
function boxMessageBox:export()
local root = htmlBuildermw.html.create()
 
-- Add the subst check error.
if self.isSubstituted and self.name then
root:tag('b')
.tag:addClass('berror')
:wikitext(string.format(
.addClass('error')
'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.',
.wikitext(format(
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
'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 or nil)
.attr('id', self.id)
for i, class in ipairs(self.classes or {}) do
boxTable:addClass(class or nil)
.addClass(class)
end
boxTable
.:cssText(self.style or nil)
.:attr('role', 'presentation')
 
for attr, val in pairs(self.attrs or {}) do
if self.attrs then
boxTable
.boxTable:attr(attr, valself.attrs)
end
 
-- Add the left-hand image.
local row = boxTable.:tag('tr')
if self.imageLeft then
local imageLeftCell = row.:tag('td').:addClass('mbox-image')
if self.imageCellDiv then
-- If we are using a div, redefine imageLeftCell so that the image
Line 531 ⟶ 472:
-- image width to 52px. If any images in a div are wider than that,
-- they may overlap with the text or cause other display problems.
imageLeftCell = imageLeftCell.:tag('div').:css('width', '52px')
end
imageLeftCell:wikitext(self.imageLeft or nil)
.wikitext(self.imageLeft)
elseif self.imageEmptyCell then
-- Some message boxes define an empty cell if no image is specified, and
Line 540 ⟶ 480:
-- specified gives the following hint: "No image. Cell with some width
-- or padding necessary for text cell to have 100% width."
row.:tag('td')
.:addClass('mbox-empty-cell')
.:cssText(self.imageEmptyCellStyle or nil)
end
 
-- Add the text.
local textCell = row.:tag('td').:addClass('mbox-text')
if self.useCollapsibleTextFields then
-- The message box uses advanced text parameters that allow things to be
-- collapsible. At the moment, only ambox uses this.
textCell:cssText(self.textstyle or nil)
local textCellSpan = textCell:tag('span')
.cssText(self.textstyle)
local textCellSpan = textCell.tag('span')
textCellSpan
.:addClass('mbox-text-span')
.:wikitext(self.issue or nil)
if not self.isSmall then
textCellSpan:tag('span')
.tag:addClass('spanhide-when-compact')
:wikitext(self.talk and (' ' .. self.talk) or nil)
.addClass('hide-when-compact')
.:wikitext(self.talkfix and (' ' .. self.talkfix) or nil)
.wikitext(self.fix and ' ' .. self.fix)
end
textCellSpan:wikitext(self.date and (' ' .. self.date) or nil)
.wikitext(self.date and ' ' .. self.date)
if not self.isSmall then
textCellSpan
.:tag('span')
.:addClass('hide-when-compact')
.:wikitext(self.info and (' ' .. self.info) or nil)
end
else
-- Default text formatting - anything goes.
textCell
.:cssText(self.textstyle or nil)
.:wikitext(self.text or nil)
end
 
-- Add the right-hand image.
if self.imageRight then
local imageRightCell = row.:tag('td').:addClass('mbox-imageright')
if self.imageCellDiv then
-- If we are using a div, redefine imageRightCell so that the image
-- is inside it.
imageRightCell = imageRightCell.:tag('div').:css('width', '52px')
end
imageRightCell
.:wikitext(self.imageRight or nil)
end
 
-- Add the below row.
if self.below then
boxTable.:tag('tr')
.:tag('td')
.:attr('colspan', self.imageRight and '3' or '2')
.:addClass('mbox-text')
.:cssText(self.textstyle or nil)
.:wikitext(self.below or nil)
end
 
-- Add error message for invalid type parameters.
if self.invalidTypeError then
root:tag('div')
.tag:css('divtext-align', 'center')
:wikitext(string.format(
.css('text-align', 'center')
'This message box is using an invalid "type=%s" parameter and needs fixing.',
.wikitext(format(
self.type or ''
'This message box is using an invalid "type=%s" parameter and needs fixing.',
))
self.type or ''
))
end
 
-- Add categories.
root:wikitext(self:renderCategories() or nil)
root
 
.wikitext(self.categories)
return tostring(root)
end
 
--------------------------------------------------------------------------------
local function main(boxType, args)
-- Exports
local outputBox = box.new()
--------------------------------------------------------------------------------
outputBox:setTitle(args)
 
local cfg = outputBox:getConfig(boxType)
local p, mt = {}, {}
args = outputBox:removeBlankArgs(cfg, args)
 
outputBox:setBoxParameters(cfg, args)
function p._exportClasses()
return outputBox:export()
-- For testing.
return {
MessageBox = MessageBox
}
end
 
local function makeWrapperp.main(boxType, args, cfgTables)
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)
if not getArgs then
local args = getArgs(frame, {trim = false, removeBlanks = false})
getArgs = require('Module:Arguments').getArgs
return main(boxType, args)
end
return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
end
end
 
return setmetatable(p, mt)
local p = {
main = main,
mbox = makeWrapper('mbox')
}
for boxType in pairs(cfgTables) do
p[boxType] = makeWrapper(boxType)
end
return p
Anonymous user
Retrieved from "https://wiki.climatechange.ai/wiki/Special:MobileDiff/1331"