Module:Message box: Difference between revisions

Line 1:

-- This is a meta-module for producing message box templates, including

-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.

-- Load necessary modules.

require('strict')

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'

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

local TEMPLATE_STYLES = 'Module:Message box/%s.css'

--------------------------------------------------------------------------------

Line 59:

Line 67:

args = args or {}

local obj = {}

obj.boxType = boxType

-- Set the title object and the namespace.

Line 74:

Line 84:

-- use template from DEMOSPACES

obj.cfg = cfg[DEMOSPACES[demospace]]

obj.boxType = DEMOSPACES[demospace]

elseif string.find( demospace, 'talk' ) then

-- demo as a talk page

obj.cfg = cfg.tmbox

obj.boxType = 'tmbox'

else

-- default to ombox

obj.cfg = cfg.ombox

obj.boxType = 'ombox'

end

elseif ns == 0 then

obj.cfg = cfg.ambox -- main namespace

obj.boxType = 'ambox'

elseif ns == 6 then

obj.cfg = cfg.imbox -- file namespace

obj.boxType = 'imbox'

elseif ns == 14 then

obj.cfg = cfg.cmbox -- category namespace

obj.boxType = 'cmbox'

else

local nsTable = mw.site.namespaces[ns]

if nsTable and nsTable.isTalk then

obj.cfg = cfg.tmbox -- any talk namespace

obj.boxType = 'tmbox'

else

obj.cfg = cfg.ombox -- other namespaces or invalid input

obj.boxType = 'ombox'

end

Line 139:

Line 157:

return nil

end

~~table.insert(~~self.classes, class)

self.classes[class] = 1

end

function MessageBox:removeClass(class)

if not class then

return nil

end

self.classes[class] = nil

end

Line 168:

Line 193:

self.id = args.id

self.name = args.name

for _, class in ipairs(cfg.classes or {}) do

self:addClass(class)

end

if self.name then

self:addClass('box-' .. string.gsub(self.name,' ','_'))

end

if yesno(args.plainlinks) ~~~= false then~~

local plainlinks = yesno(args.plainlinks)

if plainlinks == true then

self:addClass('plainlinks')

elseif plainlinks == false then

end

self:removeClass('plainlinks')

for _, class in ipairs(cfg.classes or {}) do

self:addClass(class)

end

if self.isSmall then

Line 261:

Line 289:

end

if talkTitle and talkTitle.exists then

local talkText = 'Relevant discussion may be found on'

local talkText

if talkArgIsTalkPage then

if self.isSmall then

talkText = string.format(

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

'%s [[%s|%s]].',

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

talkText,

else

talk,

talkText = 'Relevant discussion may be found on'

talkTitle.prefixedText

if talkArgIsTalkPage then

)

talkText = string.format(

else

'%s [[%s|%s]].',

talkText = string.format(

talkText,

'%s the [[%s#%s|talk page]].',

talk,

talkText,

talkTitle.prefixedText

talkTitle.prefixedText,

)

talk

else

)

talkText = string.format(

end

'%s the [[%s#%s|talk page]].',

talkText,

talkTitle.prefixedText,

talk

)

end

self.talk = talkText

end

Line 296:

Line 318:

end

if date then

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

self.date = string.format(" ''(%s)''", date)

end

self.info = args.info

Line 318:

Line 340:

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

Line 355:

or '40x40px'

self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage

or '~~Imbox~~ ~~notice~~.~~png~~', imageSize)

or 'Information icon4.svg', imageSize)

end

Line 339:

Line 364:

self.imageRight = imageRight

end

-- set templatestyles

self.base_templatestyles = cfg.templatestyles

self.templatestyles = args.templatestyles

end

Line 429:

Line 450:

function MessageBox:setAllNamespaceCategories()

-- Set categories for all namespaces.

if self.invalidTypeError then

local allSort = (self.title.namespace == 0 and 'Main:' or '') .. self.title.prefixedText

self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)

end

if self.isSubstituted then

self:addCat('all', 'Pages with incorrectly substituted templates')

Line 478:

Line 495:

end

-- Add TemplateStyles

local frame = mw.getCurrentFrame()

root:wikitext(~~frame~~:extensionTag{

root:wikitext(mw.getCurrentFrame():extensionTag{

name = 'templatestyles',

args = { src = self.~~base_templatestyles~~ },

args = { src = TEMPLATE_STYLES:format(self.boxType) },

})

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

-- Create the box table.

local boxTable ~~= root:tag('table')~~

local boxTable

-- Check for fmbox because not all interface messages have mw-parser-output

-- which is necessary for TemplateStyles. Add the wrapper class if it is and

-- then start the actual mbox, else start the mbox.

if self.boxType == 'fmbox' then

boxTable = root:tag('div')

:addClass('mw-parser-output')

:tag('table')

else

boxTable = root:tag('table')

end

boxTable:attr('id', self.id or nil)

for i, ~~class~~ in ~~ipairs~~(self.classes or {}) do

for class, _ in pairs(self.classes or {}) do

boxTable:addClass(class or nil)

end

Line 516:

Line 535:

-- 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'):~~addClass~~('~~mbox-image-div~~')

imageLeftCell = imageLeftCell:tag('div'):css('width', '52px')

end

imageLeftCell:wikitext(self.imageLeft or nil)

Line 526:

Line 545:

row:tag('td')

:addClass('mbox-empty-cell')

:cssText(self.imageEmptyCellStyle or nil)

end

Line 538:

Line 558:

:addClass('mbox-text-span')

:wikitext(self.issue or nil)

if (self.talk or self.fix) then

if (self.talk or self.fix) and not self.isSmall then

textCellDiv:tag('span')

:addClass('hide-when-compact')

Line 552:

Line 572:

end

if self.removalNotice then

textCellDiv:tag('~~span~~')

textCellDiv:tag('small')

:addClass('hide-when-compact')

:tag('i')

Line 570:

Line 590:

-- If we are using a div, redefine imageRightCell so that the image

-- is inside it.

imageRightCell = imageRightCell:tag('div'):~~addClass~~('~~mbox-image-div~~')

imageRightCell = imageRightCell:tag('div'):css('width', '52px')

end

imageRightCell

Line 589:

Line 609:

if self.invalidTypeError then

root:tag('div')

:~~addClass~~('~~mbox~~-~~invalid-type~~')

:css('text-align', 'center')

:wikitext(string.format(

'This message box is using an invalid "type=%s" parameter and needs fixing.',