1,588
edits
Changes
Jump to navigation
Jump to search
m
-- Load the configuration page.
local cfgTables = mw.loadData('Module:Message box/configuration')
tinserttable.insert(ret, k)
tinserttable.insert(nums, tonumber(num))
setmetatable(obj, box)
return obj
end
function box -- Set the title object and the namespace.getNamespaceId(ns) if not ns then return end if typeobj.title = getTitleObject(nsargs.page) == 'string' then ns = lang:ucfirst(or mw.ustringtitle.lowergetCurrentTitle(ns)) if ns == 'Main' then ns = 0 end end local nsTable = mw.site.namespaces[ns] if nsTable then return nsTable.id endend
function box.getMboxType(nsid) -- Gets Set the mbox config for our box type from a namespace number. obj.cfg = cfg[boxType] if nsid not obj.cfg then local ns == 0 thenobj.title.namespace -- boxType is "mbox" or invalid input return if args.demospace and args.demospace ~= 'ambox' then -- main namespaceimplement demospace parameter of mbox elseif nsid local demospace =string.lower(args.demospace) if DEMOSPACES[demospace] then -- use template from DEMOSPACES obj.cfg = 6 thencfg[DEMOSPACES[demospace]] return elseif string.find( demospace, 'imboxtalk' ) then -- file namespacedemo as a talk page obj.cfg = cfg.tmbox else -- default to ombox obj.cfg = cfg.ombox end elseif nsid ns == 14 0 then return 'cmbox' obj.cfg = cfg.ambox -- category main namespace else local nsTable elseif ns == mw6 then obj.sitecfg = cfg.namespaces[nsid]imbox -- file namespace if nsTable and nsTable.isTalk elseif ns == 14 then return 'tmbox' obj.cfg = cfg.cmbox -- any talk category namespace
return 'local nsTable = mw.site.namespaces[ns] if nsTable and nsTable.isTalk then obj.cfg = cfg.tmbox -- any talk namespace else obj.cfg = cfg.ombox' -- other namespaces or invalid input end
end
function box:addCat(ns -- Set the arguments, cat, sort)and remove all blank arguments except for the ones if type(cat) ~= 'string' then return end-- listed in cfg.allowBlankParams. do local nsVals newArgs = {'main', 'template', 'all'} local tname for ik, val v in ipairspairs(nsValsargs) do if ns v ~='' then newArgs[k] = val thenv tname = ns .. 'Cats'end
end if not tname then for i, val param in ipairs(nsValsobj.cfg.allowBlankParams or {}) do nsValsnewArgs[iparam] = format('"%s"', val)args[param]
error( 'invalid ns parameter passed to box:addCat; valid values are ' obj.. mw.text.listToText(nsVals, nil, ' or ') )args = newArgs
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) -- Define internal data structure. if type(class) ~obj.categories = 'string' then return end{} selfobj.classes = self.classes or {} tinsert(self-- For lazy loading of [[Module:Category handler]].classes, class)end obj.hasCategories = false
function box:addAttr(attr, val) if type(attr) ~= 'string' or type(val) ~= 'string' then return end self.attrs = self.attrs or {} tinsertsetmetatable(self.attrsobj, attrMessageBox)
local cfg = cfgTables[boxType] if not cfg sort then local boxTypes cat = {} for k, v in pairs(dataTables) do tinsert(boxTypes, string.format('"[[Category:%s|%s"]]', k)cat, sort) end else tinsert(boxTypes, '"mbox"') error(cat = string.format( 'invalid message box type "%s"; valid types are [[Category:%s]]', tostring(boxType), mw.text.listToText(boxTypes) ), 2cat)
return cfgself.hasCategories = true self.categories[ns] = self.categories[ns] or {} table.insert(self.categories[ns], cat)
for i, param in ipairstable.insert(cfgself.allowBlankParams or {}classes, class) do newArgs[param] = args[param] end return newArgs
and true
or false
if self.isSubstituted = cfg.substCheck and args.subst == 'SUBST' then self.isSubstituted = true end
if self.isSmall = cfg.allowSmall and (
then
self.isSmall = true
else
self.isSmall = false
end
self:addClass(
cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks'
)
self.name = args.name
or false
tinserttable.insert(issues, sect) tinserttable.insert(issues, issue) tinserttable.insert(issues, text) self.issue = tconcattable.concat(issues, ' ')
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 if 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'0, allCat) end
selfreturn require('Module:Category handler').categories = categoryHandler_main{ main = tconcattable.concat(self.mainCats categories[0] or {}), template = tconcattable.concat(self.templateCats categories[10] or {}), all = tconcattable.concat(self.allCats categories.all or {}), nocat = self.args.nocat, demospace = self.demospace, page = self.pageTitle and selfargs.pageTitle.prefixedText or nilpage
.:cssText(self.styleor nil) .:attr('role', 'presentation') for attr, val in pairs(if self.attrs or {}) dothen boxTable .:attr(attr, valself.attrs)
textCellSpan .wikitext(self.date and ' ' .. self.date) if not self.isSmall removalNotice then textCellSpan .textCellDiv:tag('spansmall') .:addClass('hide-when-compact') .wikitext:tag(self.info and ' i' ) :wikitext(string.. format(" (%s)", self.inforemovalNotice))
.:cssText(self.textstyleor nil) .:wikitext(self.textor nil)
.:wikitext(self.imageRightor nil)
local function makeWrappermt.__index(boxTypet, k)
local args if not getArgs then getArgs = require('Module:Arguments').getArgs end return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}) return main(boxType, args)
local return setmetatable(p = { main = main, mbox = makeWrapper('mbox')} for boxType in pairs(cfgTablesmt) do p[boxType] = makeWrapper(boxType)end return p
63 revisions imported
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
-- Require Load necessary modules.local getArgs = require('Module:ArgumentsNo globals').getArgslocal htmlBuilder = require('Module:HtmlBuilder')local categoryHandler = require('Module:Category handler').maingetArgs
local yesno = require('Module:Yesno')
-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()
-- Set aliases for often-used functions to reduce table lookups.Define constantslocal format CONFIG_MODULE = mw.ustring.format'Module:Message box/configuration'local tinsert DEMOSPACES = table.insertlocal tconcat {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = table.concatlocal trim 'ambox', main = mw.text.trim'ambox'}
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
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 ret = {}
for k in pairs(vals) do
end
table.sort(ret)
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
if num then
end
end
--------------------------------------------------------------------------------
local box MessageBox = {}boxMessageBox.__index = boxMessageBox
function boxMessageBox.new(boxType, args, cfg) args = args or {}
local obj = {}
else
end
end
end
end
end
end
function boxMessageBox:setTitleaddCat(argsns, cat, sort) -- 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.namespaceend function box:getConfig(boxType) -- Get the box config data from the data page. if boxType == 'mbox' not cat then boxType = box.getMboxType(self.nsid)return nil
end
end
end
function boxMessageBox:removeBlankArgsaddClass(cfg, argsclass) -- Only allow blank arguments for the parameter names listed in -- cfg.allowBlankParams. local newArgs = {} for k, v in pairs(args) do if v ~= '' not class then newArgs[k] = v endreturn nil
end
end
function boxMessageBox:setBoxParameterssetParameters() local args = self.args local cfg = self.cfg, args)
-- Get type data.
self.type = args.type
and self.type
and not typeData
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
-- Find if the box has been wrongly substituted.
-- Find whether we are using a small message box.
cfg.smallParam and args.small == cfg.smallParam
or not cfg.smallParam and yesno(args.small)
)
-- Add attributes, classes and styles.
self.id = args.id self.name = args.name if cfgself.allowId name then self:addClass('box-' .. string.gsub(self.id = name,' ','_')) end if yesno(args.idplainlinks) ~= false then self:addClass('plainlinks')
end
for _, class in ipairs(cfg.classes or {}) do
self:addClass(class)
and cfg.templateCategoryRequireName
then
if self.name then
local templateName = mw.ustring.match(
self.isTemplatePage = self.templateTitle
and mw.title.equals(self.title, self.templateTitle)
end
-- Process data for collapsible text fields. At the moment these are only
-- used in {{ambox}}.
text = type(text) == 'string' and text or nil
local issues = {}
end
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
local talkText = 'Relevant discussion may be found on'
if talkArgIsTalkPage then
talkText = string.format(
'%s [[%s|%s]].',
talkText,
)
else
talkText = string.format(
'%s the [[%s#%s|talk page]].',
talkText,
end
if date then
self.date = string.format(" <smallclass='date-container'>''(<span class='date'>%s</span>)''</small>", date)
end
self.info = args.info
if yesno(args.removalnotice) then
self.removalNotice = cfg.removalNotice
end
end
-- General image settings.
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv and true or false
self.imageEmptyCell = cfg.imageEmptyCell
if cfg.imageEmptyCellStyle then
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
or 'Imbox notice.png', imageSize)
end
if not (cfg.imageRightNone and imageRight == 'none') then
self.imageRight = imageRight
end
end
function MessageBox:setMainspaceCategories()
local args = self.args
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 -- Add mainspace categories. At The following is roughly equivalent to the moment these are only used in old {{amboxAmbox/category}}. if cfglocal date = args.allowMainspaceCategories thendate date = type(date) == 'string' and date local preposition = 'from' for _, num in ipairs(nums) do if local mainCat = args['cat' .cat then. tostring(num)] or args['category' .cat1 . tostring(num)] local allCat = args['all' ..cattostring(num)] endmainCat = type(mainCat) == 'string' and mainCat self.catNums allCat = getArgNumstype(args, allCat) == 'catstring')and allCat if args.category mainCat and date and date ~= '' then argslocal catTitle = string.category1 format('%s %s %s', mainCat, preposition, date) self:addCat(0, catTitle) catTitle = argsgetTitleObject('Category:' ..categorycatTitle) end if not catTitle or not catTitle.exists then self.categoryNums = getArgNums:addCat(args0, 'categoryArticles with invalid date parameter in template') end if args.all elseif mainCat and (not date or date == '') then args.all1 = args.allself:addCat(0, mainCat)
end
end
end
end
function MessageBox:setTemplateCategories() local args = self.args local cfg = self.cfg -- Add template-namespace 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
end
end
self:addCat('template'10, templateCat, templateSort)
end
end
function MessageBox:setAllNamespaceCategories() -- Categories Set categories for all namespaces.
if self.invalidTypeError then
local allSort = (self.nsid title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
end
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()
if not self.hasCategories then
-- No categories added, no need to pass them to Category handler so,
-- if it was invoked, it would return the empty string.
-- So we shortcut and return the empty string.
return ""
end
-- Convert category tables to strings and pass them through
-- [[Module:Category handler]].
}
end
function boxMessageBox:export() local root = htmlBuildermw.html.create()
-- Add the subst check error.
if self.isSubstituted and self.name then
root .:tag('b') . :addClass('error') . :wikitext(string.format( 'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.', mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}') ))
end
-- Create the box table.
local boxTable = root.:tag('table') boxTable .:attr('id', self.idor nil)
for i, class in ipairs(self.classes or {}) do
boxTable .:addClass(classor nil)
end
boxTable
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
-- 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.imageLeftor nil)
elseif self.imageEmptyCell then
-- Some message boxes define an empty cell if no image is specified, and
-- 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.imageEmptyCellStyleor 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.textstyleor nil) local textCellSpan textCellDiv = textCell.:tag('spandiv') textCellSpantextCellDiv .:addClass('mbox-text-span') .:wikitext(self.issueor nil) if (self.talk or self.fix) and not self.isSmall then textCellSpan .textCellDiv:tag('span') . :addClass('hide-when-compact') . :wikitext(self.talk and (' ' .. self.talk) or nil) . :wikitext(self.fix and (' ' .. self.fix) or nil) end textCellDiv:wikitext(self.date and (' ' .. self.date) or nil) if self.info and not self.isSmall then textCellDiv :tag('span') :addClass('hide-when-compact') :wikitext(self.info and (' ' .. self.info) or nil)
end
end
else
-- Default text formatting - anything goes.
textCell
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
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.textstyleor nil) .:wikitext(self.belowor nil)
end
-- Add error message for invalid type parameters.
if self.invalidTypeError then
root .:tag('div') . :css('text-align', 'center') . :wikitext(string.format( 'This message box is using an invalid "type=%s" parameter and needs fixing.', self.type or '' ))
end
-- Add categories.
root .:wikitext(self.categories:renderCategories() or nil)
return tostring(root)
end
---------------------------------------------------------------------------------- Exports-------------------------------------------------------------------------------- local p, mt = {}, {} function mainp._exportClasses(boxType, args) local outputBox -- For testing. return { MessageBox = box.new()MessageBox outputBox:setTitle}end function p.main(boxType, args, cfgTables) local cfg box = outputBox:getConfigMessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE)) args = outputBoxbox:removeBlankArgssetParameters(cfg, args) outputBoxbox:setBoxParameterssetCategories(cfg, args) return outputBoxbox:export()
end
return function (frame)
end
end