中医百科

Module:Message box：修订间差异

以互动方式浏览历史
←上一编辑下一编辑→
删除的内容 添加的内容
移植求闻版 Message box 模块（flex div 结构）；修复 getConfig 报错分支引用未定义 dataTables、export 中 nsid 字符串比较两处 bug
融合重构：工程组织取 mw.org 版（strict/常量表/类/方法拆分），行为对齐求闻版（div 输出、dmbox、中文、干支）——输出与 rev 71078 等价，配置/模板/样式不动
第1行：
-- 融合版 Module:Message box
-- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{tmbox}}, {{ombox}} and {{fmbox}}.
-- 工程组织：mediawiki.org 版风格（require('strict')、常量表、辅助函数、类方法拆分、命名规范）
-- 行为基准：求闻版（rev 71078）——div.flex 输出结构、dmbox(disambig/setindex)、全中文文案、干支排序键
-- 输出 HTML 与求闻版严格一致（样式/配置/模板均依赖该结构，零漂移）
 
-- RequireLoad necessary modules.
require('strict')
local getArgs = require('Module:Arguments').getArgs
local categoryHandler = require('Module:Category handler').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()
 
-- Define constants
local CONFIG_MODULE = 'Module:Message box/configuration'
local DEFAULT_IMAGE = 'Information Mark (Blue).svg'
 
-- Set aliases for often-used functions to reduce table lookups.
local format = mw.ustring.format
local tconcat = table.concat
local tinsert = table.insert
local tconcat = table.concat
local trim = mw.text.trim
 
--------------------------------------------------------------------------------
第24行 ⟶ 第28行：
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, ...)
第63行 ⟶ 第67行：
 
--------------------------------------------------------------------------------
-- Namespace resolution
-- Box class definition
--------------------------------------------------------------------------------
 
local boxfunction = {}getNamespaceId(ns)
box.__index = box
 
function box.new()
local obj = {}
setmetatable(obj, box)
return obj
end
 
function box.getNamespaceId(ns)
if not ns then return end
if type(ns) == 'string' then
第89行 ⟶ 第84行：
end
 
local function box.getMboxType(nsid)
-- Gets the mbox type from a namespace number.
if nsid == 0 then
第103行 ⟶ 第98行：
end
 
--------------------------------------------------------------------------------
function box:addCat(ns, cat, sort)
-- 干支日期排序键
--------------------------------------------------------------------------------
 
local dayName = {
[1] = '㏠', [2] = '㏡', [3] = '㏢', [4] = '㏣', [5] = '㏤',
[6] = '㏥', [7] = '㏦', [8] = '㏧', [9] = '㏨', [10] = '㏩',
[11] = '㏪', [12] = '㏫', [13] = '㏬', [14] = '㏭', [15] = '㏮',
[16] = '㏯', [17] = '㏰', [18] = '㏱', [19] = '㏲', [20] = '㏳',
[21] = '㏴', [22] = '㏵', [23] = '㏶', [24] = '㏷', [25] = '㏸',
[26] = '㏹', [27] = '㏺', [28] = '㏻', [29] = '㏼', [30] = '㏽',
[31] = '㏾'
}
 
--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------
 
local MessageBox = {}
MessageBox.__index = MessageBox
 
function MessageBox.new(boxType, args, cfgTables)
args = args or {}
local obj = {}
 
obj.boxType = boxType
 
-- Get the title object and the namespace.
obj.pageTitle = getTitleObject(args.page ~= '' and args.page)
obj.title = obj.pageTitle or mw.title.getCurrentTitle()
obj.demospace = args.demospace ~= '' and args.demospace or nil
obj.nsid = getNamespaceId(obj.demospace) or obj.title.namespace
 
-- Resolve mbox to the concrete box type from the namespace.
if obj.boxType == 'mbox' then
obj.boxType = getMboxType(obj.nsid)
end
 
-- Get the config for our box type.
obj.cfg = cfgTables[obj.boxType]
if not obj.cfg then
local boxTypes = {}
for k, v in pairs(cfgTables) do
tinsert(boxTypes, format('"%s"', k))
end
tinsert(boxTypes, '"mbox"')
error(format('无效的消息框类型「%s」；有效的类型为%s', tostring(obj.boxType), mw.text.listToText(boxTypes)), 2)
end
 
obj.args = args
obj.classes = {}
obj.mainCats = nil
obj.templateCats = nil
obj.allCats = nil
return obj
end
 
function MessageBox:addCat(ns, cat, sort)
if type(cat) ~= 'string' then return end
local nsVals = {'main', 'template', 'all'}
第126行 ⟶ 第178行：
end
 
function boxMessageBox:addClass(class)
if type(class) ~= 'string' then return end
self.classes = self.classes or {}
tinsert(self.classes, class)
end
 
--------------------------------------------------------------------------------
function box:setTitle(args)
-- Parameter processing
-- 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:getConfigsetTypeData(boxType)
local cfg = self.cfg
-- Get the box config data from the data page.
local args = self.args
if boxType == 'mbox' then
boxType = box.getMboxType(self.nsid)
end
local cfg = cfgTables[boxType]
if not cfg then
local boxTypes = {}
for k, v in pairs(cfgTables) do
tinsert(boxTypes, format('"%s"', k))
end
tinsert(boxTypes, '"mbox"')
error(format('无效的消息框类型「%s」；有效的类型为%s', tostring(boxType), mw.text.listToText(boxTypes)), 2)
end
return cfg
end
 
function box:removeBlankArgs(cfg, args)
-- Only allow blank arguments for the parameter names listed in cfg.allowBlankParams.
local newArgs = {}
for k, v in pairs(args) do
if v ~= '' then
newArgs[k] = v
end
end
for i, param in ipairs(cfg.allowBlankParams or {}) do
newArgs[param] = args[param]
end
return newArgs
end
 
function box:setBoxParameters(cfg, args)
-- Get type data.
self.type = args.type
第195行 ⟶ 第214行：
self.isSmall = false
end
end
 
function MessageBox:setClasses()
local cfg = self.cfg
local args = self.args
 
-- Add attributes, classes and styles.
第201行 ⟶ 第225行：
self.name = args.name
if self.name then
self:addClass('box-' .. string.gsub(self.name, ' ', '_'))
end
end
第219行 ⟶ 第243行：
-- Set text style.
self.textstyle = args.textstyle
self.abovestyle = args.abovestyle
self.belowstyle = args.belowstyle
end
 
function MessageBox:setCollapsibleTextFields()
local cfg = self.cfg
local args = self.args
 
-- 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
if self.useCollapsibleTextFields or cfg.templateCategory and cfg.templateCategoryRequireName then
第235行 ⟶ 第263行：
end
 
if not self.useCollapsibleTextFields then
-- Process data for collapsible text fields. At the moment these are only used in {{ambox}}.
return
if self.useCollapsibleTextFields then
end
-- Get the self.issue value.
 
if self.isSmall and args.smalltext then
-- Get the self.issue = argsvalue.smalltext
if self.isSmall and args.smalltext then
else
self.issue = args.smalltext
local sect
else
if args.sect == '' then
local sect
sect = '此' .. (cfg.sectionDefault or '页面')
elseifif type(args.sect) == 'string' then
sect = '此' .. args(cfg.sectsectionDefault or '页面')
elseif type(args.sect) == 'string' then
end
local issuesect = '此' .. args.issuesect
issue = type(issue) == 'string' and issue ~= '' and issue or nil
local text = args.text
text = type(text) == 'string' and text or nil
local issues = {}
tinsert(issues, sect)
tinsert(issues, issue)
tinsert(issues, text)
self.issue = tconcat(issues)
end
local issue = args.issue
issue = type(issue) == 'string' and issue ~= '' and issue or nil
local text = args.text
text = type(text) == 'string' and text or nil
local issues = {}
tinsert(issues, sect)
tinsert(issues, issue)
tinsert(issues, text)
self.issue = tconcat(issues)
end
 
-- Get the self.talk value.
local talk = args.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))
then
talk = '#'
elseif talk == '' then
talk = nil
end
if talk then
-- 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 talkArgIsTalkPage = true
if not talkTitle or not talkTitle.isTalkPage then
talkArgIsTalkPage = false
talkTitle = getTitleObject(self.title.text, mw.site.namespaces[self.title.namespace].talk.id)
end
if talktalkTitle and talkTitle.exists then
local talkText = '相关讨论可见于'
-- If the talk value is a talk page, make a link to that page. Else assume that it's a section heading,
if talkArgIsTalkPage then
-- and make a link to the talk page of the current page with that section heading.
talkText = format('%s[[%s|%s]]。', talkText, talk, talkTitle.prefixedText)
local talkTitle = getTitleObject(talk)
else
local talkArgIsTalkPage = true
talkText = format('%s[[%s#%s|讨论页]]。', talkText, talkTitle.prefixedText, talk)
if not talkTitle or not talkTitle.isTalkPage then
talkArgIsTalkPage = false
talkTitle = getTitleObject(self.title.text, mw.site.namespaces[self.title.namespace].talk.id)
end
if talkTitle and talkTitle.exists then
local talkText = '相关讨论可见于'
if talkArgIsTalkPage then
talkText = format('%s[[%s|%s]]。', talkText, talk, talkTitle.prefixedText)
else
talkText = format('%s[[%s#%s|讨论页]]。', talkText, talkTitle.prefixedText, talk)
end
self.talk = talkText
end
self.talk = talkText
end
end
 
-- Get other values.
local date
if args.date and args.date ~= '' then
date = args.date
elseif args.time == '' and self.isTemplatePage then
date = lang:formatDate('Y年n月j日')
elseif args.time and args.time ~= '' then
date = lang:formatDate('Y年n月j日', args.time)
end
if date then
local ok, tempdate = pcall(lang.formatDate, lang, 'Y年n月j日', date) -- 正規化日期
if ok then
date = tempdate
end
end
if date then
self.date = string.format(" <small class='date-container'>''(<span class='date'>%s</span>)''</small>", date)
end
if args.fix and args.fix ~= '' then
self.fix = format("<br><small>%s</small>", args.fix)
else
self.fix = ''
end
self.info = args.info
end
if date then
self.date = string.format(" <small class='date-container'>''(<span class='date'>%s</span>)''</small>", date)
end
if args.fix and args.fix ~= '' then
self.fix = format('<br><small>%s</small>', args.fix)
else
self.fix = ''
end
self.info = args.info
end
 
function MessageBox:setTextFields()
local args = self.args
 
-- 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
self.text = args.smalltext or args.text
第327行 ⟶ 第359行：
-- Set the below row.
self.below = args.below
end
 
function MessageBox:setImages()
local cfg = self.cfg
local args = self.args
 
-- General image settings.
第340行 ⟶ 第377行：
if not imageLeft then
local imageSize = self.isSmall and (cfg.imageSmallSize or '30x30px') or '40px'
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage or 'Information Mark (Blue).svg'DEFAULT_IMAGE, imageSize)
end
end
第349行 ⟶ 第386行：
self.imageRight = imageRight
end
end
 
--------------------------------------------------------------------------------
-- Category processing
--------------------------------------------------------------------------------
 
function MessageBox:setMainspaceCategories()
local cfg = self.cfg
local args = self.args
 
if not cfg.allowMainspaceCategories then
return
end
 
if args.cat then
args.cat1 = args.cat
end
self.catNums = getArgNums(args, 'cat')
if args.category then
args.category1 = args.category
end
self.categoryNums = getArgNums(args, 'category')
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}}.
-- Add mainspace categories. At the moment these are only used in {{ambox}}.
local date
if cfg.allowMainspaceCategories then
local sortDay
if args.cat then
if args.cat1date =and args.catdate ~= '' then
date = args.date
local ok, tempdate = pcall(lang.formatDate, lang, 'Y年n月', date) -- 正規化日期
if ok then
date = tempdate
end
elseif args.time and args.time ~= '' then
self.catNums = getArgNums(args, 'cat')
date = lang:formatDate('Y年n月', args.time)
if args.category then
sortDay = lang:formatDate('j', args.time)
args.category1 = args.category
sortDay = tonumber(sortDay)
end
sortDay = dayName[sortDay]
self.categoryNums = getArgNums(args, 'category')
end
if args.all then
date = type(date) == 'string' and date
args.all1 = args.all
local preposition = '自'
end
for _, num in ipairs(self.categoryParamNums) do
self.allNums = getArgNums(args, 'all')
local mainCat = args['cat' .. tostring(num)] or args['category' .. tostring(num)]
self.categoryParamNums = union(self.catNums, self.categoryNums)
local allCat = args['all' .. tostring(num)]
self.categoryParamNums = union(self.categoryParamNums, self.allNums)
mainCat = type(mainCat) == 'string' and mainCat
-- The following is roughly equivalent to the old {{Ambox/category}}.
allCat = type(allCat) == 'string' and allCat
local date
if mainCat and date and date ~= '' then
local sortDay
local catTitle = format('%s%s%s', preposition, date, mainCat)
local dayName = {
[1]if =sortDay '㏠',then
self:addCat('main', catTitle, sortDay)
[2] = '㏡',
else
[3] = '㏢',
self:addCat('main', catTitle)
[4] = '㏣',
[5] = '㏤',
[6] = '㏥',
[7] = '㏦',
[8] = '㏧',
[9] = '㏨',
[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
local ok, tempdate = pcall(lang.formatDate, lang, 'Y年n月', date) -- 正規化日期
if ok then
date = tempdate
end
catTitle = getTitleObject('Category:' .. catTitle)
elseif args.time and args.time ~= '' then
if not catTitle or not catTitle.exists then
date = lang:formatDate('Y年n月', args.time)
self:addCat('main', '模板中使用无效日期参数的条目')
sortDay = lang:formatDate('j', args.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
elseif mainCat and (not date or date == '') then
self:addCat('main', mainCat)
end
if allCat then
self:addCat('main', allCat)
end
end
end
 
function MessageBox:setTemplateCategories()
local cfg = self.cfg
local args = self.args
 
-- Add template-namespace categories.
第477行 ⟶ 第497行：
self:addCat('template', templateCat, templateSort)
end
end
 
function MessageBox:setAllNamespaceCategories()
-- Categories for all namespaces.
if self.invalidTypeError then
第486行 ⟶ 第508行：
self:addCat('all', '错误使用替换引用的页面')
end
end
 
function MessageBox:setCategories()
if self.cfg.allowMainspaceCategories then
self:setMainspaceCategories()
end
if self.cfg.templateCategory 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 = tconcat(self.mainCats or {}),
template = tconcat(self.templateCats or {}),
all = tconcat(self.allCats or {}),
nocat = self.args.nocat,
demospace = self.demospace,
page = self.pageTitle and self.pageTitle.prefixedText or nil
第498行 ⟶ 第532行：
end
 
--------------------------------------------------------------------------------
function box:export()
-- Export
--------------------------------------------------------------------------------
 
function MessageBox:export()
local root = mw.html.create()
 
第533行 ⟶ 第571行：
-- 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
第542行 ⟶ 第580行：
-- "No image. Cell with some width or padding necessary for text cell to have 100% width."
row:tag('div')
:addClass('mbox-empty-cell')
end
 
第613行 ⟶ 第651行：
:wikitext(self.imageRight)
end
 
-- Add __DISAMBIG__ for {{dmbox|type=disambig}}
if self.type == 'disambig' then
if self.nsid == 10 then
root:wikitext('[[Category:消歧义消息模板]]')
elseif self.nsid == 0 then
root:wikitext('__DISAMBIG__'):wikitext('[[Category:全部消歧义页面]]')
else
root:wikitext('<!-- omitted -->')
end
第626行 ⟶ 第664行：
 
-- Add category for {{dmbox|type=setindex}}
if self.type == 'setindex' then
if self.nsid == 10 then
root:wikitext('[[Category:消歧义消息模板]]')
else
root:wikitext('__DISAMBIG__')
end
root:wikitext('[[Category:全部设置索引条目]]')
end
 
-- Add error message for invalid type parameters.
if self.invalidTypeError then
第645行 ⟶ 第683行：
-- Add categories.
root
:wikitext(self.categories:renderCategories())
 
return tostring(root)
end
 
--------------------------------------------------------------------------------
-- Exports
--------------------------------------------------------------------------------
 
local function main(boxType, args)
local outputBox = boxMessageBox.new(boxType, args, mw.loadData(CONFIG_MODULE))
outputBox.args = outputBox:setTitleremoveBlankArgs(args)
local cfg = outputBox:getConfigsetTypeData(boxType)
args = outputBox:removeBlankArgssetClasses(cfg, args)
outputBox:setBoxParameterssetCollapsibleTextFields(cfg, args)
outputBox:setTextFields()
outputBox:setImages()
outputBox:setCategories()
return outputBox:export()
end
 
function MessageBox:removeBlankArgs(args)
-- Only allow blank arguments for the parameter names listed in cfg.allowBlankParams.
local cfg = self.cfg
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
return newArgs
end
 
第671行 ⟶ 第731行：
}
 
for boxType in pairs(cfgTablesmw.loadData(CONFIG_MODULE)) do
p[boxType] = makeWrapper(boxType)
end
 
function p._exportClasses()
-- For testing.
return {
MessageBox = MessageBox
}
end
 
检索自“https://zybkcn.com/wiki/Module:Message_box”