Module:Message box/sandbox: Difference between revisions

Revision as of 04:37, 14 February 2021

Latest revision as of 18:25, 13 July 2025

(27 intermediate revisions by 14 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 yesno = require('Module:Yesno')

-- Get a language object for formatDate and ucfirst.

local lang = mw.language.getContentLanguage()

-- Define constants

local CONFIG_MODULE = 'Module:Message box/configuration/sandbox'

local DEMOSPACES = {talk = 'tmbox', image = 'imbox', file = 'imbox', category = 'cmbox', article = 'ambox', main = 'ambox'}

Line 90 ⟶ 83:

elseif ns == 0 then

obj.cfg = cfg.ambox -- main namespace

elseif ns == 118 then

obj.cfg = cfg.ambox -- draft namespace

elseif ns == 6 then

obj.cfg = cfg.imbox -- file namespace

Line 162 ⟶ 157:

self.typeClass = typeData.class

self.typeImage = typeData.image

self.typeImageNeedsLink = typeData.imageNeedsLink

-- Find if the box has been wrongly substituted.

Line 195 ⟶ 191:

self.textstyle = args.textstyle

-- Set headerimage styleclasses.

self.imageRightClass = args.imagerightclass or args.imageclass

-- Only for tmbox

self.headerimageLeftClass = cfgargs.headerimageleftclass andor args.headerimageclass

self.headerstyle = args.headerstyle

-- Specify header text

self.headertext = args.headertext

-- Find if we are on the template page or not. This functionality is only

-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory

Line 278 ⟶ 270:

local talkText

if self.isSmall then

local talkLink = talkArgIsTalkPage and talk or (talkTitle.prefixedText .. (talk == '#' and '' or '#') .. talk)

talkText = string.format('([[%s|talk]])', talkLink)

else

Line 291 ⟶ 283:

else

talkText = string.format(

'%s the [[%s' .. (talk == '#' and '' or '#') .. '%s|talk page]].',

talkText,

talkTitle.prefixedText,

Line 311 ⟶ 303:

end

if date then

self.date = string.format(" <smallspan class='date-container'>''<i>(<span class='date'>%s</span>)''</smalli></span>", date)

end

self.info = args.info

Line 333 ⟶ 325:

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

if self.isSmall then

self:addClass(cfg.smallClass or 'mbox-small')

end

-- Collapsible setting for tmbox

local setCollapsible = cfg.collapse and args.collapse

if self.setCollapsible then

self.tableCollapseStyle = 'border-collapse:separate;'

end

-- Left image settings.

Line 357 ⟶ 336:

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 367 ⟶ 346:

self.imageRight = imageRight

end

-- set templatestyles

self.base_templatestyles = cfg.templatestyles

self.templatestyles = args.templatestyles

end

Line 500 ⟶ 483:

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 508 ⟶ 506:

boxTable:addClass(class or nil)

end

if self.setCollapsible then

boxTable

:addClass ('mw-collapsible mw-made-collapsible collapsible collapsed wpbs mbox-inside')

:cssText (self.tableCollapseStyle)

:attr('cellspacing', '4')

:attr('role', 'presentation')

else

boxTable

:cssText(self.style or nil)

:attr('role', 'presentation')

end

if self.attrs then

boxTable:attr(self.attrs)

end

-- Add the left-hand image.

local row = boxTable:tag('tr')

if self.imageLeft then

local imageLeftCell = row:tag('td'):addClass('mbox-image')

if self.setCollapsibleimageCellDiv then

self.imageLeftCell = imageLeftCell:attr('rowspan', '2')

elseif self.imageCellDiv then

-- 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.

self.imageLeftCell = imageLeftCell:tag('div'):cssaddClass('width', '52pxmbox-image-div')

end

imageLeftCell:wikitext(self.imageLeft or nil)

:addClass(self.imageLeftClass)

:wikitext(self.imageLeft or nil)

elseif self.imageEmptyCell then

-- Some message boxes define an empty cell if no image is specified, and

Line 545 ⟶ 535:

row:tag('td')

:addClass('mbox-empty-cell')

:cssText(self.imageEmptyCellStyle or nil)

end

-- Add header?

if self.header then

local header = row:tag('td'):addClass('mbox-text')

if self.headertext then

if self.setCollapsible then

-- The show button

local showButton =

header:tag('span'):addClass('collapseButton'):cssText('float:left;')

:tag('span'):addClass('nowrap'):wikitext('&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;')

header

:cssText(self.headerstyle or nil)

:wikitext((self.showButton and self.headertext) or nil)

else

header --consider removing this else

:cssText(self.headerstyle or nil)

:wikitext(self.headertext or nil)

end

end

end

-- Add the text.

local textCell = row:tag('td'):addClass('mbox-text')

if self.setCollapsible then

if self.useCollapsibleTextFields then

local textCell =

boxTable:tag('tr')

:tag('td'):addClass('mbox-text')

if self.useCollapsibleTextFields then

-- The message box uses advanced text parameters that allow things to be

-- collapsible. At the moment, only ambox uses this.

Line 598 ⟶ 561:

end

if self.removalNotice then

textCellDiv:tag('small')

:addClass('hide-when-compact')

:tag('i')

:wikitext(string.format(" (%s)", self.removalNotice))

end

if self.setCollapsible then

textCell:addClass('outercollapse')

end

else

-- Default text formatting - anything goes.

textCell

:cssText(self.textstyle or nil)

:wikitext(self.text or nil)

end

else

local textCell = row:tag('td'):addClass('mbox-text')

if self.useCollapsibleTextFields then

-- The message box uses advanced text parameters that allow things to be

-- collapsible. At the moment, only ambox uses this.

textCell:cssText(self.textstyle or nil)

local textCellDiv = textCell:tag('div')

textCellDiv

:addClass('mbox-text-span')

:wikitext(self.issue or nil)

if (self.talk or self.fix) then

textCellDiv:tag('span')

:addClass('hide-when-compact')

:wikitext(self.talk and (' ' .. self.talk) or nil)

:wikitext(self.fix and (' ' .. self.fix) or nil)

end

textCellDiv:wikitext(self.date and (' ' .. self.date) or nil)

if self.info and not self.isSmall then

textCellDiv

:tag('span')

:addClass('hide-when-compact')

:wikitext(self.info and (' ' .. self.info) or nil)

end

if self.removalNotice then

textCellDiv:tag('small')

:addClass('hide-when-compact')

:tag('i')

:wikitext(string.format(" (%s)", self.removalNotice))

end

if self.setCollapsible then

textCell:addClass('outercollapse')

end

else

Line 651 ⟶ 571:

:cssText(self.textstyle or nil)

:wikitext(self.text or nil)

end end

-- Add the right-hand image.

Line 659 ⟶ 579:

-- 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

:addClass(self.imageRightClass)

:wikitext(self.imageRight or nil)

end

Line 678 ⟶ 599:

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.',