Module:Message box: Difference between revisions

m
1 revision imported from wikipedia:Module:Message_box
(remove cfg.allowId)
m (1 revision imported from wikipedia:Module:Message_box)
 
(27 intermediate revisions by 17 users not shown)
Line 1:
require('strict')
-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
 
-- Load necessary modules.
require('Module:No globals')
local getArgs
local categoryHandler = require('Module:Category handler')._main
local yesno = require('Module:Yesno')
local lang = mw.language.getContentLanguage()
 
local CONFIG_MODULE = 'Module:Message box/configuration'
-- Get a language object for formatDate and ucfirst.
local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}
local lang = mw.language.getContentLanguage()
 
--------------------------------------------------------------------------------
Line 72 ⟶ 68:
local ns = obj.title.namespace
-- boxType is "mbox" or invalid input
if nsargs.demospace =and args.demospace ~= 0'' then
-- implement demospace parameter of mbox
local demospace = string.lower(args.demospace)
if DEMOSPACES[demospace] then
-- use template from DEMOSPACES
obj.cfg = cfg[DEMOSPACES[demospace]]
elseif string.find( demospace, 'talk' ) then
-- 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
Line 106 ⟶ 115:
obj.categories = {}
obj.classes = {}
-- For lazy loading of [[Module:Category handler]].
obj.hasCategories = false
 
return setmetatable(obj, MessageBox)
Line 119 ⟶ 130:
cat = string.format('[[Category:%s]]', cat)
end
self.hasCategories = true
self.categories[ns] = self.categories[ns] or {}
table.insert(self.categories[ns], cat)
Line 143 ⟶ 155:
self.typeClass = typeData.class
self.typeImage = typeData.image
self.typeImageNeedsLink = typeData.imageNeedsLink
 
-- Find if the box has been wrongly substituted.
Line 155 ⟶ 168:
-- Add attributes, classes and styles.
self.id = args.id
self:addClass(.name = args.name
if self.name then
cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks'
self:addClass('box-' .. string.gsub(self.name,' ','_'))
)
end
if yesno(args.plainlinks) ~= false then
self:addClass('plainlinks')
end
for _, class in ipairs(cfg.classes or {}) do
self:addClass(class)
Line 180 ⟶ 197:
and cfg.templateCategoryRequireName
then
self.name = args.name
if self.name then
local templateName = mw.ustring.match(
Line 192 ⟶ 208:
and mw.title.equals(self.title, self.templateTitle)
end
 
-- Process data for collapsible text fields. At the moment these are only
-- used in {{ambox}}.
Line 246 ⟶ 262:
end
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 = string.format(
talkText = string.format('([[%s|talk]])', talkLink)
'%s [[%s|%s]].',
else
talkText,
talkText = 'Relevant discussion may be found on'
talk,
if talkArgIsTalkPage then
talkTitle.prefixedText
talkText = string.format(
)
'%s [[%s|%s]].',
else
talkText,
talkText = string.format(
talk,
'%s the [[%s#%s|talk page]].',
talkTitle.prefixedText
talkText,
)
talkTitle.prefixedText,
else
talk
talkText = string.format(
)
'%s the [[%s#%s|talk page]].',
end
talkText,
talkTitle.prefixedText,
talk
)
end
end
self.talk = talkText
end
Line 275 ⟶ 297:
end
if date then
self.date = string.format(" <small>span class='date-container'><i>(<span class='date'>%s</span>)''</smalli></span>", date)
end
self.info = args.info
if yesno(args.removalnotice) then
self.removalNotice = cfg.removalNotice
end
end
 
Line 294 ⟶ 319:
self.imageCellDiv = not self.isSmall and cfg.imageCellDiv
self.imageEmptyCell = cfg.imageEmptyCell
if cfg.imageEmptyCellStyle then
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
end
 
-- Left image settings.
Line 308 ⟶ 330:
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s|link=%s|alt=]]', self.typeImage
or 'ImboxInformation noticeicon4.pngsvg', imageSize, self.typeImageNeedsLink and "" or "|link=" )
end
end
Line 318 ⟶ 340:
self.imageRight = imageRight
end
-- set templatestyles
self.base_templatestyles = cfg.templatestyles
self.templatestyles = args.templatestyles
end
 
Line 423 ⟶ 449:
 
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{
return categoryHandler{
main = table.concat(self.categories[0] or {}),
template = table.concat(self.categories[10] or {}),
Line 445 ⟶ 477:
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
 
Line 470 ⟶ 517:
-- 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'):cssaddClass('width', '52pxmbox-image-div')
end
imageLeftCell:wikitext(self.imageLeft or nil)
Line 480 ⟶ 527:
row:tag('td')
:addClass('mbox-empty-cell')
:cssText(self.imageEmptyCellStyle or nil)
end
 
Line 489 ⟶ 535:
-- collapsible. At the moment, only ambox uses this.
textCell:cssText(self.textstyle or nil)
local textCellSpantextCellDiv = textCell:tag('spandiv')
textCellDiv
textCellSpan
:addClass('mbox-text-span')
:wikitext(self.issue or nil)
if not(self.talk or self.isSmallfix) then
textCellSpantextCellDiv:tag('span')
:addClass('hide-when-compact')
:wikitext(self.talk and (' ' .. self.talk) or nil)
:wikitext(self.fix and (' ' .. self.fix) or nil)
end
textCellSpantextCellDiv:wikitext(self.date and (' ' .. self.date) or nil)
if self.info and not self.isSmall then
textCellDiv
textCellSpan
:tag('span')
:addClass('hide-when-compact')
:wikitext(self.info and (' ' .. self.info) or nil)
end
if self.removalNotice then
textCellDiv:tag('span')
:addClass('hide-when-compact')
:tag('i')
:wikitext(string.format(" (%s)", self.removalNotice))
end
else
Line 519 ⟶ 571:
-- If we are using a div, redefine imageRightCell so that the image
-- is inside it.
imageRightCell = imageRightCell:tag('div'):cssaddClass('width', '52pxmbox-image-div')
end
imageRightCell
Line 538 ⟶ 590:
if self.invalidTypeError then
root:tag('div')
:cssaddClass('textmbox-align', 'centerinvalid-type')
:wikitext(string.format(
'This message box is using an invalid "type=%s" parameter and needs fixing.',
Line 565 ⟶ 617:
 
function p.main(boxType, args, cfgTables)
local box = MessageBox.new(boxType, args, cfgTables or mw.loadData('Module:Message box/configuration'CONFIG_MODULE))
box:setParameters()
box:setCategories()
verified
2,497

edits