Modul:Message box: Unterschied zwischen den Versionen
K
Schützte „Modul:Message box“: Häufig eingebundene Vorlage ([Bearbeiten=Nur Administratoren erlauben] (unbeschränkt) [Verschieben=Nur Administratoren erlauben] (unbeschränkt))
(remove cfg.allowId) |
K (Schützte „Modul:Message box“: Häufig eingebundene Vorlage ([Bearbeiten=Nur Administratoren erlauben] (unbeschränkt) [Verschieben=Nur Administratoren erlauben] (unbeschränkt))) |
||
Zeile 1: | Zeile 1: | ||
-- 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}}. | ||
-- | -- Require necessary modules. | ||
require(' | local htmlBuilder = require('Modul:HtmlBuilder') | ||
local categoryHandler = require('Modul:Category handler').main | |||
local categoryHandler = require(' | local yesno = require('Modul:Yesno') | ||
local yesno = require(' | |||
-- Load the configuration page. | |||
local cfgTables = mw.loadData('Modul: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() | ||
--- | -- Set aliases for often-used functions to reduce table lookups. | ||
local format = mw.ustring.format | |||
local tinsert = table.insert | |||
local tconcat = table.concat | |||
local trim = mw.text.trim | |||
local function getTitleObject( | local box = {} | ||
-- Get the title object, passing the function through pcall | |||
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 | ||
end | end | ||
Zeile 35: | Zeile 42: | ||
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) | ||
Zeile 46: | Zeile 53: | ||
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 | ||
Zeile 53: | Zeile 60: | ||
end | 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 | |||
function box.getMboxType(nsid) | |||
-- Gets the mbox type from a namespace number. | |||
if nsid == 0 then | |||
function | 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 | |||
if | |||
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, | end | ||
if not tname then | |||
for i, val in ipairs(nsVals) do | |||
nsVals[i] = format('"%s"', val) | |||
end | end | ||
error('invalid ns parameter passed to box:addCat; valid values are ' .. mw.text.listToText(nsVals, nil, ' or ')) | |||
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 | function box:getConfig(boxType) | ||
if | -- Get the box config data from the data page. | ||
if boxType == 'mbox' then | |||
boxType = box.getMboxType(self.nsid) | |||
end | end | ||
if | 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('invalid message box type "%s"; valid types are %s', tostring(boxType), mw.text.listToText(boxTypes)), 2) | |||
end | end | ||
return cfg | |||
end | end | ||
function | function box:removeBlankArgs(cfg, args) | ||
if | -- 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 | 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 | ||
Zeile 145: | Zeile 170: | ||
-- 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. | ||
self.id = args.id | if cfg.allowId then | ||
self:addClass( | self.id = args.id | ||
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) | ||
Zeile 167: | Zeile 199: | ||
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 | ||
-- | -- Process data for collapsible text fields. At the moment these are only used in {{ambox}}. | ||
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields | |||
if self.useCollapsibleTextFields then | |||
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields | |||
if self.useCollapsibleTextFields | |||
self.name = args.name | self.name = args.name | ||
local nameTitle = getTitleObject(self.name) | |||
self.isTemplatePage = nameTitle and self.title.prefixedText == ('Template:' .. nameTitle.text) and true or false | |||
self.isTemplatePage = self | |||
-- Get the self.issue value. | -- Get the self.issue value. | ||
if self.isSmall and args.smalltext then | if self.isSmall and args.smalltext then | ||
Zeile 211: | Zeile 225: | ||
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 = | self.issue = tconcat(issues, ' ') | ||
end | end | ||
-- Get the self.talk value. | -- Get the self.talk value. | ||
local talk = args.talk | local talk = args.talk | ||
if talk == '' and self.isTemplatePage then | |||
if talk == '' | |||
talk = '#' | talk = '#' | ||
end | end | ||
if talk then | if talk then | ||
-- | -- See if the talk link exists and is for a talk or a content namespace. | ||
local talkTitle = getTitleObject(talk) | local talkTitle = getTitleObject(talk) | ||
if not talkTitle or not talkTitle.isTalkPage then | if not talkTitle or not talkTitle.isTalkPage then | ||
-- If we couldn't process the talk page link, get the talk page of the current page. | |||
talkTitle = | local success | ||
success, talkTitle = pcall(self.title.talkPageTitle, self.title) | |||
if not success then | |||
talkTitle = nil | |||
end | |||
end | end | ||
if talkTitle and talkTitle.exists then | if talkTitle and talkTitle.exists then | ||
local talkText = 'Relevant discussion may be found on' | local talkText = 'Relevant discussion may be found on' | ||
if | if talkTitle.isTalkPage then | ||
talkText = | talkText = format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText) | ||
else | else | ||
talkText = | talkText = format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk) | ||
end | end | ||
self.talk = talkText | self.talk = talkText | ||
Zeile 275: | Zeile 267: | ||
end | end | ||
if date then | if date then | ||
self.date = | self.date = format(" <small>''(%s)''</small>", date) | ||
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 | ||
Zeile 292: | Zeile 284: | ||
-- 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 | ||
Zeile 305: | Zeile 297: | ||
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 'Imbox notice.png', imageSize) | |||
self.imageLeft = | |||
end | end | ||
end | end | ||
Zeile 318: | Zeile 307: | ||
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 | end | ||
self.catNums = getArgNums(args, 'cat') | |||
if args.category then | |||
args.category1 = args.category | |||
end | |||
self.categoryNums = getArgNums(args, 'category') | |||
args | 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 = 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 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) | |||
self:addCat( | if not catTitle or not catTitle.exists then | ||
self:addCat('main', 'Artikel mit ungültigen Datumsangaben in Vorlagen ') | |||
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-namespace categories. | |||
-- Add template categories. | |||
if cfg.templateCategory then | if cfg.templateCategory then | ||
if cfg.templateCategoryRequireName then | if cfg.templateCategoryRequireName then | ||
self.isTemplatePage = type(self.name) == 'string' and self.title.prefixedText == ('Template:' .. self.name) | |||
if self.isTemplatePage then | if self.isTemplatePage then | ||
self:addCat( | self:addCat('template', cfg.templateCategory) | ||
end | end | ||
elseif not self.title.isSubpage then | elseif not self.title.isSubpage then | ||
self:addCat( | self:addCat('template', cfg.templateCategory) | ||
end | end | ||
end | end | ||
-- Add template error | -- Add template error category. | ||
if cfg.templateErrorCategory then | if cfg.templateErrorCategory then | ||
local templateErrorCategory = cfg.templateErrorCategory | local templateErrorCategory = cfg.templateErrorCategory | ||
Zeile 384: | Zeile 370: | ||
local paramsToCheck = cfg.templateErrorParamsToCheck or {} | local paramsToCheck = cfg.templateErrorParamsToCheck or {} | ||
local count = 0 | local count = 0 | ||
for i, param in ipairs(paramsToCheck) do | -- for i, param in ipairs(paramsToCheck) do | ||
-- if not args[param] then | |||
-- count = count + 1 | |||
-- end | |||
end | -- end | ||
if count > 0 then | if count > 0 then | ||
templateCat = templateErrorCategory | templateCat = templateErrorCategory | ||
Zeile 398: | Zeile 384: | ||
end | end | ||
end | end | ||
self:addCat( | self:addCat('template', templateCat, templateSort) | ||
end | end | ||
-- Categories for all namespaces. | |||
-- | |||
if self.invalidTypeError then | if self.invalidTypeError then | ||
local allSort = (self. | local allSort = (self.nsid == 0 and 'Main:' or '') .. self.title.prefixedText | ||
self:addCat('all', ' | self:addCat('all', 'Infoboxen mit falsch verwendeten Parametern ', allSort) | ||
end | end | ||
if self.isSubstituted then | if self.isSubstituted then | ||
self:addCat('all', ' | self:addCat('all', 'Vorlagen, die ersetzt statt eingebunden wurden') | ||
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, | |||
page = self.pageTitle and self.pageTitle.prefixedText or nil | |||
-- Convert category tables to strings and pass them through | |||
main = | |||
template = | |||
all = | |||
nocat = | |||
page = self. | |||
} | } | ||
end | end | ||
function | function box:export() | ||
local root = | 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 | root | ||
.tag('b') | |||
.addClass('error') | |||
.wikitext(format( | |||
'Vorlage <code>%s[[Vorlage:%s|%s]]%s</code> wurde fälschlicherweise substituiert.', | |||
mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}') | |||
)) | |||
end | end | ||
-- Create the box table. | -- Create the box table. | ||
local boxTable = root | local boxTable = root.tag('table') | ||
boxTable | boxTable | ||
.attr('id', self.id) | |||
for i, class in ipairs(self.classes or {}) do | for i, class in ipairs(self.classes or {}) do | ||
boxTable | boxTable | ||
.addClass(class) | |||
end | end | ||
boxTable | boxTable | ||
.cssText(self.style) | |||
.attr('role', 'presentation') | |||
-- Add the left-hand image. | -- Add the left-hand image. | ||
local row = boxTable | local row = boxTable.tag('tr') | ||
if self.imageLeft then | if self.imageLeft then | ||
local imageLeftCell = row | 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. | ||
-- | -- 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 | imageLeftCell = imageLeftCell.tag('div').css('width', '52px') | ||
end | end | ||
imageLeftCell | 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 | .addClass('mbox-empty-cell') | ||
.cssText(self.imageEmptyCellStyle) | |||
end | end | ||
-- Add the text. | -- Add the text. | ||
local textCell = row | 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 | ||
-- | -- moment, only ambox uses this. | ||
textCell | textCell | ||
local textCellSpan = textCell | .cssText(self.textstyle) | ||
local textCellSpan = textCell.tag('span') | |||
textCellSpan | textCellSpan | ||
.addClass('mbox-text-span') | |||
.wikitext(self.issue) | |||
if not self.isSmall then | if not self.isSmall then | ||
textCellSpan | textCellSpan | ||
.tag('span') | |||
.addClass('hide-when-compact') | |||
.wikitext(self.talk and ' ' .. self.talk) | |||
.wikitext(self.fix and ' ' .. self.fix) | |||
end | end | ||
textCellSpan | textCellSpan | ||
.wikitext(self.date and ' ' .. self.date) | |||
if not self.isSmall then | if not self.isSmall then | ||
textCellSpan | textCellSpan | ||
.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) | |||
.wikitext(self.text) | |||
end | |||
-- Add a message, if used on ns11 | |||
if self.nsid == 11 then | |||
textCell | |||
.wikitext(format('<br /><strong>Hinweis:</strong> Bei der Vielzahl von Vorlagen wird nicht jede Diskussionsseite beobachtet. Melde Änderungswünsche bitte in der [[Wikivoyage:Vorlagen/Werkstatt|Vorlagenwerkstatt]], Fragen auf der [[Wikivoyage Diskussion:Vorlagen/Werkstatt|Werkstatt-Diskussionsseite]] oder auch in der [[Wikivoyage:Lounge|Lounge]] an.', self.type or '')) | |||
end | end | ||
-- Add the right-hand image. | -- Add the right-hand image. | ||
if self.imageRight then | if self.imageRight then | ||
local imageRightCell = row | 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. | ||
end | end | ||
imageRightCell | imageRightCell | ||
.wikitext(self.imageRight) | |||
end | end | ||
-- Add the below row. | -- Add the below row. | ||
if self.below then | if self.below then | ||
boxTable | boxTable.tag('tr') | ||
.tag('td') | |||
.attr('colspan', self.imageRight and '3' or '2') | |||
.addClass('mbox-text') | |||
.cssText(self.textstyle) | |||
.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 | root | ||
.tag('div') | |||
.css('text-align', 'center') | |||
.wikitext(format('This message box is using an invalid "type=%s" parameter and needs fixing.', self.type or '')) | |||
end | end | ||
-- Add categories. | -- Add categories. | ||
root | root | ||
.wikitext(self.categories) | |||
return tostring(root) | return tostring(root) | ||
end | end | ||
local function main(boxType, args) | |||
box:setTitle(args) | |||
local cfg = box:getConfig(boxType) | |||
args = box:removeBlankArgs(cfg, args) | |||
local | box:setBoxParameters(cfg, args) | ||
function | |||
local box | |||
box: | |||
box: | |||
return box:export() | return box:export() | ||
end | end | ||
function | local function makeWrapper(boxType) | ||
return function (frame) | return function (frame) | ||
if | -- If called via #invoke, use the args passed into the invoking | ||
-- template, or the args passed to #invoke if any exist. Otherwise | |||
-- assume args are being passed directly in from the debug console | |||
-- or from another Lua module. | |||
local origArgs | |||
if frame == mw.getCurrentFrame() then | |||
origArgs = frame:getParent().args | |||
for k, v in pairs(frame.args) do | |||
origArgs = frame.args | |||
break | |||
end | |||
else | |||
origArgs = frame | |||
end | end | ||
-- Trim whitespace. | |||
local args = {} | |||
for k, v in pairs(origArgs) do | |||
if type(v) == 'string' then | |||
v = trim(v) | |||
end | |||
args[k] = v | |||
end | |||
return main(boxType, args) | |||
end | end | ||
end | end | ||
local p = { | |||
main = main, | |||
mbox = makeWrapper('mbox') | |||
} | |||
for boxType in pairs(cfgTables) do | |||
p[boxType] = makeWrapper(boxType) | |||
end | |||
return p |