Строка 1: |
Строка 1: |
− | require('strict') | + | -- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}. |
− | local getArgs | + | |
| + | -- 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') | | 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() | | local lang = mw.language.getContentLanguage() |
| | | |
− | local CONFIG_MODULE = 'Module:Message box/configuration' | + | -- Set aliases for often-used functions to reduce table lookups. |
− | local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'} | + | local format = mw.ustring.format |
| + | local tinsert = table.insert |
| + | local tconcat = table.concat |
| + | local trim = mw.text.trim |
| | | |
| -------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------- |
Строка 11: |
Строка 23: |
| -------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------- |
| | | |
− | local function getTitleObject(...) | + | local function getTitleObject(page, ...) |
− | -- Get the title object, passing the function through pcall | + | if type(page) == 'string' then |
− | -- in case we are over the expensive function count limit.
| + | -- Get the title object, passing the function through pcall |
− | 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 |
| end | | end |
Строка 31: |
Строка 45: |
| local ret = {} | | local ret = {} |
| for k in pairs(vals) do | | for k in pairs(vals) do |
− | table.insert(ret, k) | + | tinsert(ret, k) |
| end | | end |
| table.sort(ret) | | table.sort(ret) |
Строка 42: |
Строка 56: |
| 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)) | + | tinsert(nums, tonumber(num)) |
| end | | end |
| end | | end |
Строка 53: |
Строка 67: |
| -------------------------------------------------------------------------------- | | -------------------------------------------------------------------------------- |
| | | |
− | local MessageBox = {} | + | local box = {} |
− | MessageBox.__index = MessageBox
| + | box.__index = box |
| | | |
− | function MessageBox.new(boxType, args, cfg) | + | function box.new() |
− | args = args or {}
| |
| local obj = {} | | local obj = {} |
| + | setmetatable(obj, box) |
| + | return obj |
| + | end |
| | | |
− | -- Set the title object and the namespace. | + | function box.getNamespaceId(ns) |
− | obj.title = getTitleObject(args.page) or mw.title.getCurrentTitle() | + | 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 |
| | | |
− | -- Set the config for our box type. | + | function box.getMboxType(nsid) |
− | obj.cfg = cfg[boxType] | + | -- Gets the mbox type from a namespace number. |
− | if not obj.cfg then
| + | if nsid == 0 then |
− | local ns = obj.title.namespace | + | return 'ambox' -- main namespace |
− | -- boxType is "mbox" or invalid input
| + | elseif nsid == 6 then |
− | if args.demospace and args.demospace ~= '' then
| + | return 'imbox' -- file namespace |
− | -- implement demospace parameter of mbox
| + | elseif nsid == 14 then |
− | local demospace = string.lower(args.demospace)
| + | return 'cmbox' -- category namespace |
− | if DEMOSPACES[demospace] then
| + | else |
− | -- use template from DEMOSPACES
| + | local nsTable = mw.site.namespaces[nsid] |
− | obj.cfg = cfg[DEMOSPACES[demospace]]
| + | if nsTable and nsTable.isTalk then |
− | elseif string.find( demospace, 'talk' ) then
| + | return 'tmbox' -- any talk namespace |
− | -- demo as a talk page
| |
− | obj.cfg = cfg.tmbox
| |
− | else
| |
− | -- default to ombox
| |
− | obj.cfg = cfg.ombox
| |
− | end
| |
− | elseif ns == 0 then
| |
− | obj.cfg = cfg.ambox -- main namespace
| |
− | elseif ns == 6 then | |
− | obj.cfg = cfg.imbox -- file namespace
| |
− | elseif ns == 14 then | |
− | obj.cfg = cfg.cmbox -- category namespace | |
| else | | else |
− | local nsTable = mw.site.namespaces[ns] | + | 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 newArgs = {}
| + | 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 |
− | 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 | | end |
− | obj.args = newArgs | + | error('invalid ns parameter passed to box:addCat; valid values are ' .. mw.text.listToText(nsVals, nil, ' or ')) |
| end | | 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.
| + | function box:addClass(class) |
− | obj.categories = {} | + | if type(class) ~= 'string' then return end |
− | obj.classes = {} | + | self.classes = self.classes or {} |
− | -- For lazy loading of [[Module:Category handler]]. | + | tinsert(self.classes, class) |
− | obj.hasCategories = false
| + | end |
| | | |
− | return setmetatable(obj, MessageBox) | + | 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 | | end |
| | | |
− | function MessageBox:addCat(ns, cat, sort) | + | function box:getConfig(boxType) |
− | 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 | | 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 | | end |
− | self.hasCategories = true | + | return cfg |
− | self.categories[ns] = self.categories[ns] or {}
| |
− | table.insert(self.categories[ns], cat)
| |
| end | | end |
| | | |
− | function MessageBox:addClass(class) | + | function box:removeBlankArgs(cfg, args) |
− | if not class then | + | -- Only allow blank arguments for the parameter names listed in 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 |
− | table.insert(self.classes, class) | + | return newArgs |
| end | | end |
| | | |
− | function MessageBox:setParameters() | + | 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 |
| local typeData = cfg.types[self.type] | | local typeData = cfg.types[self.type] |
− | self.invalidTypeError = cfg.showInvalidTypeError | + | self.invalidTypeError = cfg.showInvalidTypeError and self.type and not typeData and true or false |
− | and self.type
| |
− | 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' | + | 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. |
− | self.isSmall = cfg.allowSmall and ( | + | 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. |
− | self.id = args.id
| + | if cfg.allowId then |
− | self.name = args.name
| + | self.id = args.id |
− | if self.name then | |
− | self:addClass('box-' .. string.gsub(self.name,' ','_')) | |
− | end
| |
− | if yesno(args.plainlinks) ~= false then
| |
− | self:addClass('plainlinks')
| |
| end | | end |
| + | self:addClass(cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks') |
| for _, class in ipairs(cfg.classes or {}) do | | for _, class in ipairs(cfg.classes or {}) do |
| self:addClass(class) | | self:addClass(class) |
Строка 180: |
Строка 211: |
| if self.isSmall then | | if self.isSmall then |
| self:addClass(cfg.smallClass or 'mbox-small') | | self:addClass(cfg.smallClass or 'mbox-small') |
| + | end |
| + | if yesno(args.hidden) then |
| + | self:addClass('infobox editsection') |
| 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
| |
| | | |
| -- 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, |
− | -- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
| + | -- 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 and cfg.templateCategoryRequireName then |
− | or cfg.templateCategory
| + | self.name = args.name |
− | and cfg.templateCategoryRequireName
| |
− | then
| |
| if self.name then | | if self.name then |
− | local templateName = mw.ustring.match( | + | local templateName = mw.ustring.match(self.name, '^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$') or self.name |
− | self.name,
| |
− | '^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
| |
− | ) 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) or false |
− | 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. |
Строка 227: |
Строка 252: |
| text = type(text) == 'string' and text or nil | | text = type(text) == 'string' and text or nil |
| local issues = {} | | local issues = {} |
− | table.insert(issues, sect) | + | tinsert(issues, sect) |
− | table.insert(issues, issue) | + | tinsert(issues, issue) |
− | table.insert(issues, text) | + | tinsert(issues, text) |
− | self.issue = table.concat(issues, ' ') | + | self.issue = tconcat(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 | + | if talk == '' -- Show talk links on the template page or template subpages if the talk parameter is blank. |
− | -- parameter is blank.
| + | and self.templateTitle |
− | if talk == ''
| + | and (mw.title.equals(self.templateTitle, self.title) or self.title:isSubpageOf(self.templateTitle)) |
− | and self.templateTitle | |
− | and ( | |
− | mw.title.equals(self.templateTitle, self.title)
| |
− | or self.title:isSubpageOf(self.templateTitle)
| |
− | )
| |
| then | | then |
| talk = '#' | | talk = '#' |
Строка 249: |
Строка 269: |
| 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, |
− | -- assume that it's a section heading, and make a link to the talk
| + | -- 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, mw.site.namespaces[self.title.namespace].talk.id) |
− | self.title.text,
| |
− | 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 = 'Relevant discussion may be found on' |
− | if self.isSmall then
| + | if talkArgIsTalkPage then |
− | local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. '#' .. talk)
| + | talkText = format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText) |
− | talkText = string.format('([[%s|talk]])', talkLink)
| + | else |
− | else
| + | talkText = format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk) |
− | talkText = 'Relevant discussion may be found on'
| + | end |
− | if talkArgIsTalkPage then
| |
− | talkText = string.format(
| |
− | '%s [[%s|%s]].',
| |
− | talkText,
| |
− | talk,
| |
− | talkTitle.prefixedText
| |
− | )
| |
− | else
| |
− | talkText = string.format(
| |
− | '%s the [[%s#%s|talk page]].',
| |
− | talkText,
| |
− | talkTitle.prefixedText,
| |
− | talk
| |
− | )
| |
− | end
| |
− | end
| |
| self.talk = talkText | | self.talk = talkText |
| end | | end |
Строка 297: |
Строка 297: |
| 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 = format(" <small>''(%s)''</small>", date) |
| end | | end |
| self.info = args.info | | self.info = args.info |
− | if yesno(args.removalnotice) then
| |
− | self.removalNotice = cfg.removalNotice
| |
− | 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, |
− | -- types other than ambox, and also by ambox when small=yes.
| + | -- 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 |
Строка 317: |
Строка 314: |
| | | |
| -- 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 |
| + | self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px' |
| + | end |
| | | |
| -- Left image settings. | | -- Left image settings. |
Строка 327: |
Строка 327: |
| 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') or '40x40px' |
− | and (cfg.imageSmallSize or '30x30px')
| + | self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage or 'Imbox notice.png', imageSize) |
− | or '40x40px'
| |
− | 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 |
Строка 340: |
Строка 337: |
| self.imageRight = imageRight | | self.imageRight = imageRight |
| end | | end |
− |
| |
− | -- set templatestyles
| |
− | self.base_templatestyles = cfg.templatestyles
| |
− | self.templatestyles = args.templatestyles
| |
− | end
| |
| | | |
− | function MessageBox:setMainspaceCategories()
| + | -- Add mainspace categories. At the moment these are only used in {{ambox}}. |
− | local args = self.args | + | if cfg.allowMainspaceCategories then |
− | local cfg = self.cfg
| + | if args.cat then |
− | | + | args.cat1 = args.cat |
− | if not cfg.allowMainspaceCategories then | + | end |
− | return nil | + | self.catNums = getArgNums(args, 'cat') |
− | end
| + | if args.category then |
− | | + | args.category1 = args.category |
− | local nums = {}
| + | end |
− | for _, prefix in ipairs{'cat', 'category', 'all'} do
| + | self.categoryNums = getArgNums(args, 'category') |
− | args[prefix .. '1'] = args[prefix] | + | if args.all then |
− | nums = union(nums, getArgNums(args, prefix)) | + | args.all1 = args.all |
− | end
| + | end |
− | | + | self.allNums = getArgNums(args, 'all') |
− | -- The following is roughly equivalent to the old {{Ambox/category}}.
| + | self.categoryParamNums = union(self.catNums, self.categoryNums) |
− | local date = args.date
| + | self.categoryParamNums = union(self.categoryParamNums, self.allNums) |
− | date = type(date) == 'string' and date
| + | -- The following is roughly equivalent to the old {{Ambox/category}}. |
− | local preposition = 'from'
| + | local date = args.date |
− | for _, num in ipairs(nums) do
| + | date = type(date) == 'string' and date |
− | local mainCat = args['cat' .. tostring(num)]
| + | local preposition = 'from' |
− | or args['category' .. tostring(num)]
| + | for _, num in ipairs(self.categoryParamNums) do |
− | local allCat = args['all' .. tostring(num)]
| + | local mainCat = args['cat' .. tostring(num)] or args['category' .. tostring(num)] |
− | mainCat = type(mainCat) == 'string' and mainCat
| + | local allCat = args['all' .. tostring(num)] |
− | allCat = type(allCat) == 'string' and allCat
| + | mainCat = type(mainCat) == 'string' and mainCat |
− | 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) |
− | catTitle = getTitleObject('Category:' .. catTitle)
| + | self:addCat('main', catTitle) |
− | if not catTitle or not catTitle.exists then
| + | catTitle = getTitleObject('Category:' .. catTitle) |
− | 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 | | end |
− | elseif mainCat and (not date or date == '') then
| |
− | self:addCat(0, mainCat)
| |
− | end
| |
− | if allCat then
| |
− | self:addCat(0, allCat)
| |
| end | | end |
| end | | end |
− | end
| |
| | | |
− | function MessageBox:setTemplateCategories()
| + | -- Add template-namespace categories. |
− | 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(10, cfg.templateCategory) | + | self:addCat('template', cfg.templateCategory) |
| end | | end |
| elseif not self.title.isSubpage then | | elseif not self.title.isSubpage then |
− | self:addCat(10, cfg.templateCategory) | + | self:addCat('template', cfg.templateCategory) |
| end | | end |
| end | | end |
| | | |
− | -- Add template error categories. | + | -- Add template error category. |
| if cfg.templateErrorCategory then | | if cfg.templateErrorCategory then |
| local templateErrorCategory = cfg.templateErrorCategory | | local templateErrorCategory = cfg.templateErrorCategory |
Строка 424: |
Строка 413: |
| end | | end |
| end | | end |
− | self:addCat(10, templateCat, templateSort) | + | self:addCat('template', templateCat, templateSort) |
| end | | end |
− | end
| |
| | | |
− | function MessageBox:setAllNamespaceCategories()
| + | -- 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.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 |
Строка 437: |
Строка 424: |
| self:addCat('all', 'Pages with incorrectly substituted templates') | | self:addCat('all', 'Pages with incorrectly substituted templates') |
| end | | end |
− | end
| |
| | | |
− | function MessageBox:setCategories()
| + | -- Convert category tables to strings and pass them through [[Module:Category handler]]. |
− | if self.title.namespace == 0 then
| + | self.categories = categoryHandler{ |
− | self:setMainspaceCategories()
| + | main = tconcat(self.mainCats or {}), |
− | elseif self.title.namespace == 10 then
| + | template = tconcat(self.templateCats or {}), |
− | self:setTemplateCategories()
| + | all = tconcat(self.allCats or {}), |
− | end
| + | nocat = args.nocat, |
− | self:setAllNamespaceCategories()
| + | demospace = self.demospace, |
− | end
| + | page = self.pageTitle and self.pageTitle.prefixedText or nil |
− | | |
− | 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]].
| |
− | return require('Module:Category handler')._main{ | |
− | main = table.concat(self.categories[0] or {}), | |
− | template = table.concat(self.categories[10] or {}), | |
− | all = table.concat(self.categories.all or {}), | |
− | nocat = self.args.nocat, | |
− | page = self.args.page | |
| } | | } |
| end | | end |
| | | |
− | function MessageBox:export() | + | function box:export() |
− | local root = mw.html.create() | + | 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:tag('b') | + | root |
− | :addClass('error')
| + | .tag('b') |
− | :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
| + | )) |
− | | |
− | local frame = mw.getCurrentFrame()
| |
− | root:wikitext(frame:extensionTag{
| |
− | name = 'templatestyles',
| |
− | args = { src = self.base_templatestyles },
| |
− | })
| |
− | -- Add support for a single custom templatestyles sheet. Undocumented as
| |
− | -- need should be limited and many templates using mbox are substed; we
| |
− | -- don't want to spread templatestyles sheets around to arbitrary places
| |
− | if self.templatestyles then
| |
− | root:wikitext(frame:extensionTag{
| |
− | name = '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) |
| 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) |
| end | | end |
| boxTable | | boxTable |
− | :cssText(self.style or nil) | + | .cssText(self.style) |
− | :attr('role', 'presentation') | + | .attr('role', 'presentation') |
− | | |
− | if self.attrs then
| |
− | boxTable:attr(self.attrs)
| |
− | 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. |
− | -- is inside it. Divs use style="width: 52px;", which limits the | + | -- Divs use style="width: 52px;", which limits the image width to 52px. If any |
− | -- image width to 52px. If any images in a div are wider than that,
| + | -- images in a div are wider than that, they may overlap with the text or cause |
− | -- they may overlap with the text or cause other display problems.
| + | -- other display problems. |
− | imageLeftCell = imageLeftCell:tag('div'):addClass('mbox-image-div') | + | imageLeftCell = imageLeftCell.tag('div').css('width', '52px') |
| end | | end |
− | imageLeftCell:wikitext(self.imageLeft or nil) | + | 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 some don't. |
− | -- some don't. The old template code in templates where empty cells are
| + | -- The old template code in templates where empty cells are specified gives the following hint: |
− | -- specified gives the following hint: "No image. Cell with some width
| + | -- "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') | + | .cssText(self.imageEmptyCellStyle) |
| 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 |
− | -- collapsible. At the moment, only ambox uses this. | + | -- moment, only ambox uses this. |
− | textCell:cssText(self.textstyle or nil) | + | textCell |
− | local textCellDiv = textCell:tag('div') | + | .cssText(self.textstyle) |
− | textCellDiv | + | local textCellSpan = textCell.tag('span') |
− | :addClass('mbox-text-span') | + | textCellSpan |
− | :wikitext(self.issue or nil) | + | .addClass('mbox-text-span') |
− | if (self.talk or self.fix) then | + | .wikitext(self.issue) |
− | textCellDiv:tag('span') | + | if not self.isSmall then |
− | :addClass('hide-when-compact')
| + | textCellSpan |
− | :wikitext(self.talk and (' ' .. self.talk) or nil)
| + | .tag('span') |
− | :wikitext(self.fix and (' ' .. self.fix) or nil)
| + | .addClass('hide-when-compact') |
− | end
| + | .wikitext(self.talk and ' ' .. self.talk) |
− | textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
| + | .wikitext(self.fix and ' ' .. self.fix) |
− | 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 |
− | if self.removalNotice then | + | textCellSpan |
− | textCellDiv:tag('span') | + | .wikitext(self.date and ' ' .. self.date) |
− | :addClass('hide-when-compact') | + | if not self.isSmall then |
− | :tag('i') | + | textCellSpan |
− | :wikitext(string.format(" (%s)", self.removalNotice))
| + | .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 or nil) | + | .cssText(self.textstyle) |
− | :wikitext(self.text or nil) | + | .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: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 | + | imageRightCell = imageRightCell.tag('div').css('width', '52px') -- 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')
| |
| end | | end |
| imageRightCell | | imageRightCell |
− | :wikitext(self.imageRight or nil) | + | .wikitext(self.imageRight) |
| 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) |
− | :wikitext(self.below or nil) | + | .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:tag('div') | + | root |
− | :addClass('mbox-invalid-type')
| + | .tag('div') |
− | :wikitext(string.format(
| + | .css('text-align', 'center') |
− | 'This message box is using an invalid "type=%s" parameter and needs fixing.',
| + | .wikitext(format('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.categories) |
| | | |
| return tostring(root) | | return tostring(root) |
| end | | end |
| | | |
− | --------------------------------------------------------------------------------
| + | local function main(boxType, args) |
− | -- Exports
| + | 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 p, mt = {}, {} | + | local function makeWrapper(boxType) |
− | | + | return function (frame) |
− | function p._exportClasses() | + | local args = getArgs(frame, {trim = false, removeBlanks = false}) |
− | -- For testing. | + | return main(boxType, args) |
− | return {
| + | end |
− | MessageBox = MessageBox | |
− | } | |
| end | | end |
| | | |
− | function p.main(boxType, args, cfgTables)
| + | local p = { |
− | local box = MessageBox.new(boxType, args, cfgTables or mw.loadData(CONFIG_MODULE)) | + | main = main, |
− | box:setParameters() | + | mbox = makeWrapper('mbox') |
− | box:setCategories()
| + | } |
− | return box:export()
| |
− | end
| |
| | | |
− | function mt.__index(t, k)
| + | for boxType in pairs(cfgTables) do |
− | return function (frame) | + | p[boxType] = makeWrapper(boxType) |
− | if not getArgs then
| |
− | getArgs = require('Module:Arguments').getArgs
| |
− | end
| |
− | return t.main(k, getArgs(frame, {trim = false, removeBlanks = false}))
| |
− | end
| |
| end | | end |
| | | |
− | return setmetatable(p, mt) | + | return p |