更改
// Edit via Wikiplus
-- This is a meta-module for producing message box templates, including
-- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
-- Load necessary modules.
-- Require necessary modules.
require('Module:No globals')
local getArgs = require('Module:Arguments').getArgs
local getArgs
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.
-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()
local lang = mw.language.getContentLanguage()
-- Define constants
-- Set aliases for often-used functions to reduce table lookups.
local CONFIG_MODULE = 'Module:Message box/configuration'
local format = mw.ustring.format
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}
local tinsert = table.insert
local tconcat = table.concat
local trim = mw.text.trim
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
local function getTitleObject(...)
local function getTitleObject(page, ...)
-- Get the title object, passing the function through pcall
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
end
end
local ret = {}
local ret = {}
for k in pairs(vals) do
for k in pairs(vals) do
tinsert(ret, k)
end
end
table.sort(ret)
table.sort(ret)
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
tinsert(nums, tonumber(num))
end
end
end
end
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
local MessageBox = {}
local box = {}
box.__index = box
function MessageBox.new(boxType, args, cfg)
function box.new()
local obj = {}
local obj = {}
setmetatable(obj, box)
return obj
end
function box.getNamespaceId(ns)
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)
-- 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
else
return 'ombox' -- other namespaces or invalid input
end
end
end
end
end
function box:addCat(ns, cat, sort)
if type(cat) ~= 'string' then return end
local nsVals = {'main', 'template', 'all'}
local tname
for i, val in ipairs(nsVals) do
if ns == val then
tname = ns .. 'Cats'
end
end
for i, param in ipairs(obj.cfg.allowBlankParams or {}) do
end
if not tname then
for i, val in ipairs(nsVals) do
nsVals[i] = format('"%s"', val)
end
end
error('無效的ns參數傳送到box:addCat;有效的數值為' .. mw.text.listToText(nsVals, '、', '或'))
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
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.
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.
if boxType == 'mbox' then
boxType = box.getMboxType(self.nsid)
end
end
if sort then
local cfg = cfgTables[boxType]
if not cfg then
local boxTypes = {}
for k, v in pairs(dataTables) do
tinsert(boxTypes, format('"%s"', k))
end
tinsert(boxTypes, '"mbox"')
error(format(' 無效的訊息框類型「%s」;有效的類型為%s', tostring(boxType), mw.text.listToText(boxTypes)), 2)
end
end
return cfg
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.
local newArgs = {}
for k, v in pairs(args) do
if v ~= '' then
newArgs[k] = v
end
end
end
for i, param in ipairs(cfg.allowBlankParams or {}) do
newArgs[param] = args[param]
end
return newArgs
end
end
function MessageBox:setParameters()
function box:setBoxParameters(cfg, args)
-- 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
typeData = typeData or cfg.types[cfg.default]
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
self.typeClass = typeData.class
-- Find if the box has been wrongly substituted.
-- 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.
-- Find whether we are using a small message box.
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.
if cfg.allowId then
self.id = args.id
if self.name then
self:addClass('box-' .. string.gsub(self.name,' ','_'))
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)
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
-- 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 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
self.name = args.name
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
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
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}}.
if self.useCollapsibleTextFields then
if self.useCollapsibleTextFields then
-- Get the self.issue value.
-- Get the self.issue value.
local sect
local sect
if args.sect == '' then
if args.sect == '' then
sect = 'This ' .. (cfg.sectionDefault or 'page')
sect = ' 本' .. (cfg.sectionDefault or ' 頁面')
elseif type(args.sect) == 'string' then
elseif type(args.sect) == 'string' then
sect = 'This ' .. args.sect
sect = ' 本' .. args.sect
end
end
local issue = args.issue
local issue = args.issue
text = type(text) == 'string' and text or nil
text = type(text) == 'string' and text or nil
local issues = {}
local issues = {}
tinsert(issues, sect)
tinsert(issues, issue)
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.
and self.templateTitle
and (mw.title.equals(self.templateTitle, self.title) or self.title:isSubpageOf(self.templateTitle))
and self.templateTitle
and (
then
then
talk = '#'
talk = '#'
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 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)
end
end
if talkTitle and talkTitle.exists then
if talkTitle and talkTitle.exists then
local talkText = 'Relevant discussion may be found on'
local talkText = ' 相關討論可見於'
if talkArgIsTalkPage then
if talkArgIsTalkPage then
talkText = string.format(
talkText = format('%s[[%s|%s]].', talkText, talk, talkTitle.prefixedText)
else
else
talkText = string.format(
talkText = format('%s[[%s#%s| 討論頁]].', talkText, talkTitle.prefixedText, talk)
end
end
self.talk = talkText
self.talk = talkText
-- Get other values.
-- Get other values.
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('Y 年n月j日')
elseif args.time and args.time ~= '' then
date = lang:formatDate('Y年n月j日', time)
end
end
if date then
if date then
self.date = string.format(" <small class='date-container'>''(<span class='date'>%s</span>)''</small>", date)
self.date = format("<small> (%s )</small>", date)
end
if args.fix and args.fix ~= '' then
self.fix = format("<br /><small>%s</small>", args.fix)
else
self.fix = ''
end
end
self.info = args.info
self.info = args.info
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.
if self.isSmall then
if self.isSmall then
self.text = args.smalltext or args.text
self.text = args.smalltext or args.text
-- 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
if cfg.imageEmptyCellStyle 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') or '40x40px'
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage or 'OOjs UI icon information-progressive.svg', imageSize)
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
end
end
end
end
self.imageRight = imageRight
self.imageRight = imageRight
end
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
if not cfg.allowMainspaceCategories then
end
self.catNums = getArgNums(args, 'cat')
if args.category then
args.category1 = args.category
end
self.categoryNums = getArgNums(args, 'category')
args[prefix .. '1'] = args[prefix]
if args.all then
args.all1 = args.all
end
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
local sortDay
local dayName = {
[1] = '㏠',
[2] = '㏡',
[3] = '㏢',
[4] = '㏣',
[5] = '㏤',
[6] = '㏥',
[7] = '㏦',
[8] = '㏧',
[9] = '㏨',
self:addCat(0, 'Articles with invalid date parameter in template')
[10] = '㏩',
[11] = '㏪',
[12] = '㏫',
[13] = '㏬',
[14] = '㏭',
[15] = '㏮',
[16] = '㏯',
[17] = '㏰',
[18] = '㏱',
[19] = '㏲',
[20] = '㏳',
[21] = '㏴',
[22] = '㏵',
[23] = '㏶',
[24] = '㏷',
[25] = '㏸',
[26] = '㏹',
[27] = '㏺',
[28] = '㏻',
[29] = '㏼',
[30] = '㏽',
[31] = '㏾'
}
if args.date and args.date ~= '' then
date = args.date
elseif args.time and args.time ~= '' then
date = lang:formatDate('Y年n月', time)
sortDay = lang:formatDate('j', time)
sortDay = tonumber(sortDay)
sortDay = dayName[sortDay]
end
date = type(date) == 'string' and date
local preposition = ' 自'
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 and date ~= '' then
local catTitle = format('%s%s%s', preposition, date, mainCat)
if sortDay then
self:addCat('main', catTitle, sortDay)
else
self:addCat('main', catTitle)
end
catTitle = getTitleObject('Category:' .. catTitle)
if not catTitle or not catTitle.exists then
self:addCat('main', '模板中使用无效日期参数的条目')
end
elseif mainCat and (not date or date == '') then
self:addCat('main', mainCat)
end
if allCat then
self:addCat('main', allCat)
end
end
end
end
end
end
-- Add template categories.
-- Add template-namespace 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
end
end
end
end
self:addCat(10, templateCat, templateSort)
self:addCat('template', templateCat, templateSort)
end
end
-- 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', ' 需要修复的信息框', allSort)
end
end
if self.isSubstituted then
if self.isSubstituted then
self:addCat('all', 'Pages with incorrectly substituted templates')
self:addCat('all', ' 錯誤使用替換引用的頁面')
end
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,
-- Convert category tables to strings and pass them through
page = self.pageTitle and self.pageTitle.prefixedText or nil
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 = 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')
:wikitext(format(
' 模板<code>%s[[Template:%s|%s]]%s</code> 被錯誤地替代。',
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}')
))
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')
-- Add the left-hand image.
-- Add the left-hand image.
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
-- 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')
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.
-- 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')
row:tag('td')
:addClass('mbox-empty-cell')
:addClass('mbox-empty-cell')
:cssText(self.imageEmptyCellStyle or nil)
:cssText(self.imageEmptyCellStyle)
end
end
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)
local textCellSpan = textCell:tag('span')
textCellSpan
:addClass('mbox-text-span')
:addClass('mbox-text-span')
:wikitext(self.issue or nil)
:wikitext(self.issue)
if (self.talk or self.fix) and not self.isSmall then
if not self.isSmall then
textCellSpan
:tag('span')
:addClass('hide-when-compact')
:wikitext(self.talk and self.talk)
end
end
textCellSpan
if self.info and not self.isSmall then
:wikitext(self.date and self.date)
if not self.isSmall and self.fix ~= '' then
textCellSpan
:tag('span')
:tag('span')
:addClass('hide-when-compact')
:wikitext(self.fix and self.fix)
end
end
if self.removalNotice then
if not self.isSmall then
textCellSpan
:tag('span')
:addClass('hide-when-compact')
: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
local imageRightCell = row:tag('td'):addClass('mbox-imageright')
local imageRightCell = row:tag('td'):addClass('mbox-imageright')
if self.imageCellDiv then
if self.imageCellDiv then
imageRightCell = imageRightCell:tag('div'):css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
imageRightCell = imageRightCell:tag('div'):css('width', '52px')
end
end
imageRightCell
imageRightCell
:wikitext(self.imageRight or nil)
:wikitext(self.imageRight)
end
end
: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
:tag('div')
:css('text-align', 'center')
:wikitext(format(' 本訊息框使用無效的「type=%s 」參數,需要修復。', 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)
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})
return main(boxType, args)
end
end
end
local p = {
main = main,
mbox = makeWrapper('mbox')
}
for boxType in pairs(cfgTables) do
p[boxType] = makeWrapper(boxType)
end
end
return setmetatable(p, mt)
return p