Module:Message box: Difference between revisions

Jump to navigation Jump to search

Module:Message box (view source)

Revision as of 07:38, 3 February 2015

1,243 bytes added ,  3 February 2015
test
m (1 revision)
 
(test)
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
-- This is a meta-module for producing message box templates, including {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.


-- Require necessary modules.
-- Require necessary modules.
local getArgs = require('Module:Arguments').getArgs
local htmlBuilder = require('Module:HtmlBuilder')
local htmlBuilder = require('Module:HtmlBuilder')
local categoryHandler = require('Module:Category handler').main
local categoryHandler = require('Module:Category handler').main
Line 18: Line 20:
local trim = mw.text.trim
local trim = mw.text.trim


local box = {}
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------


local function getTitleObject(page)
local function getTitleObject(page, ...)
if type(page) == 'string' then
if type(page) == 'string' then
-- Get the title object, passing the function through pcall  
-- Get the title object, passing the function through pcall  
-- in case we are over the expensive function count limit.
-- in case we are over the expensive function count limit.
local success, title = pcall(mw.title.new, page)
local success, title = pcall(mw.title.new, page, ...)
if success then
if success then
return title
return title
Line 58: Line 62:
table.sort(nums)
table.sort(nums)
return nums
return nums
end
--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------
local box = {}
box.__index = box
function box.new()
local obj = {}
setmetatable(obj, box)
return obj
end
end


Line 105: Line 122:
nsVals[i] = format('"%s"', val)
nsVals[i] = format('"%s"', val)
end
end
error('invalid ns parameter passed to box:addCat; valid values are ' .. mw.text.listToText(nsVals, nil, ' or '))
error(
'invalid ns parameter passed to box:addCat; valid values are '
.. mw.text.listToText(nsVals, nil, ' or ')
)
end
end
self[tname] = self[tname] or {}
self[tname] = self[tname] or {}
Line 119: Line 139:
self.classes = self.classes or {}
self.classes = self.classes or {}
tinsert(self.classes, class)
tinsert(self.classes, class)
end
function box:addAttr(attr, val)
if type(attr) ~= 'string' or type(val) ~= 'string' then return end
self.attrs = self.attrs or {}
tinsert(self.attrs, attr)
end
end


Line 141: Line 167:
end
end
tinsert(boxTypes, '"mbox"')
tinsert(boxTypes, '"mbox"')
error(format('invalid message box type "%s"; valid types are %s', tostring(boxType), mw.text.listToText(boxTypes)), 2)
error(format(
'invalid message box type "%s"; valid types are %s',
tostring(boxType),
mw.text.listToText(boxTypes)
), 2)
end
end
return cfg
return cfg
Line 147: Line 177:


function box:removeBlankArgs(cfg, args)
function box:removeBlankArgs(cfg, args)
-- Only allow blank arguments for the parameter names listed in cfg.allowBlankParams.
-- Only allow blank arguments for the parameter names listed in
-- cfg.allowBlankParams.
local newArgs = {}
local newArgs = {}
for k, v in pairs(args) do
for k, v in pairs(args) do
Line 164: Line 195:
self.type = args.type
self.type = args.type
local typeData = cfg.types[self.type]
local typeData = cfg.types[self.type]
self.invalidTypeError = cfg.showInvalidTypeError and self.type and not typeData and true or false
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
Line 189: Line 224:
self.id = args.id
self.id = args.id
end
end
self:addClass(cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks')
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)
Line 199: Line 236:
self:addClass(args.class)
self:addClass(args.class)
self.style = args.style
self.style = args.style
self.attrs = args.attrs


-- 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}}.
-- Find if we are on the template page or not. This functionality is only
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields  
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
if self.useCollapsibleTextFields then
-- and cfg.templateCategoryRequireName are set.
self.useCollapsibleTextFields = cfg.useCollapsibleTextFields
if self.useCollapsibleTextFields
or cfg.templateCategory
and cfg.templateCategoryRequireName
then
self.name = args.name
self.name = args.name
local nameTitle = getTitleObject(self.name)
if self.name then
self.isTemplatePage = nameTitle and self.title.prefixedText == ('Template:' .. nameTitle.text) and true or false
local templateName = mw.ustring.match(
self.name,
'^[tT][eE][mM][pP][lL][aA][tT][eE][%s_]*:[%s_]*(.*)$'
) or self.name
templateName = 'Template:' .. templateName
self.templateTitle = getTitleObject(templateName)
end
self.isTemplatePage = self.templateTitle
and mw.title.equals(self.title, self.templateTitle)
or false
end


-- Process data for collapsible text fields. At the moment these are only
-- used in {{ambox}}.
if self.useCollapsibleTextFields then
-- Get the self.issue value.
-- Get the self.issue value.
if self.isSmall and args.smalltext then
if self.isSmall and args.smalltext then
Line 233: Line 289:
-- Get the self.talk value.
-- Get the self.talk value.
local talk = args.talk
local talk = args.talk
if talk == '' and self.isTemplatePage then
-- Show talk links on the template page or template subpages if the talk
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
or self.title:isSubpageOf(self.templateTitle)
)
then
talk = '#'
talk = '#'
elseif talk == '' then
talk = nil
end
end
if talk then
if talk then
-- See if the talk link exists and is for a talk or a content namespace.
-- 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 talkTitle = getTitleObject(talk)
local talkArgIsTalkPage = true
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.
talkArgIsTalkPage = false
local success
talkTitle = getTitleObject(
success, talkTitle = pcall(self.title.talkPageTitle, self.title)
self.title.text,
if not success then
mw.site.namespaces[self.title.namespace].talk.id
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 talkTitle.isTalkPage then
if talkArgIsTalkPage then
talkText = format('%s [[%s|%s]].', talkText, talk, talkTitle.prefixedText)
talkText = format(
'%s [[%s|%s]].',
talkText,
talk,
talkTitle.prefixedText
)
else
else
talkText = format('%s the [[%s#%s|talk page]].', talkText, talkTitle.prefixedText, talk)
talkText = format(
'%s the [[%s#%s|talk page]].',
talkText,
talkTitle.prefixedText,
talk
)
end
end
self.talk = talkText
self.talk = talkText
Line 272: Line 350:
end
end


-- Set the non-collapsible text field. At the moment this is used by all box types other than ambox,
-- Set the non-collapsible text field. At the moment this is used by all box
-- and also by ambox when small=yes.
-- 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
Line 297: Line 375:
self.imageLeft = imageLeft
self.imageLeft = imageLeft
if not imageLeft then
if not imageLeft then
local imageSize = self.isSmall and (cfg.imageSmallSize or '30x30px') or '40x40px'
local imageSize = self.isSmall
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage or 'Imbox notice.png', imageSize)
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = format('[[File:%s|%s|link=|alt=]]', self.typeImage
or 'Imbox notice.png', imageSize)
end
end
end
end
Line 329: Line 410:
local preposition = 'from'
local preposition = 'from'
for _, num in ipairs(self.categoryParamNums) do
for _, num in ipairs(self.categoryParamNums) do
local mainCat = args['cat' .. tostring(num)] or args['category' .. tostring(num)]
local mainCat = args['cat' .. tostring(num)]
or args['category' .. tostring(num)]
local allCat = args['all' .. tostring(num)]
local allCat = args['all' .. tostring(num)]
mainCat = type(mainCat) == 'string' and mainCat
mainCat = type(mainCat) == 'string' and mainCat
Line 338: Line 420:
catTitle = getTitleObject('Category:' .. catTitle)
catTitle = getTitleObject('Category:' .. catTitle)
if not catTitle or not catTitle.exists then
if not catTitle or not catTitle.exists then
self:addCat('main', 'Articles with invalid date parameter in template')
self:addCat(
'main',
'Articles with invalid date parameter in template'
)
end
end
elseif mainCat and (not date or date == '') then
elseif mainCat and (not date or date == '') then
Line 352: Line 437:
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('template', cfg.templateCategory)
self:addCat('template', cfg.templateCategory)
Line 396: Line 480:
end
end


-- Convert category tables to strings and pass them through [[Module:Category handler]].
-- Convert category tables to strings and pass them through
-- [[Module:Category handler]].
self.categories = categoryHandler{
self.categories = categoryHandler{
main = tconcat(self.mainCats or {}),
main = tconcat(self.mainCats or {}),
Line 432: Line 517:
.cssText(self.style)
.cssText(self.style)
.attr('role', 'presentation')
.attr('role', 'presentation')
for attr, val in pairs(self.attrs or {}) do
boxTable
.attr(attr, val)
end


-- Add the left-hand image.
-- Add the left-hand image.
Line 438: Line 527:
local imageLeftCell = row.tag('td').addClass('mbox-image')
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 is inside it.
-- If we are using a div, redefine imageLeftCell so that the image
-- Divs use style="width: 52px;", which limits the image width to 52px. If any
-- is inside it. Divs use style="width: 52px;", which limits the
-- images in a div are wider than that, they may overlap with the text or cause
-- image width to 52px. If any images in a div are wider than that,
-- other display problems.
-- they may overlap with the text or cause other display problems.
imageLeftCell = imageLeftCell.tag('div').css('width', '52px')  
imageLeftCell = imageLeftCell.tag('div').css('width', '52px')  
end
end
Line 447: Line 536:
.wikitext(self.imageLeft)
.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 don't.
-- Some message boxes define an empty cell if no image is specified, and
-- The old template code in templates where empty cells are specified gives the following hint:
-- some don't. The old template code in templates where empty cells are
-- "No image. Cell with some width or padding necessary for text cell to have 100% width."
-- 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.tag('td')
.addClass('mbox-empty-cell')  
.addClass('mbox-empty-cell')  
Line 458: Line 548:
local textCell = row.tag('td').addClass('mbox-text')
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 collapsible. At the
-- The message box uses advanced text parameters that allow things to be
-- moment, only ambox uses this.
-- collapsible. At the moment, only ambox uses this.
textCell
textCell
.cssText(self.textstyle)
.cssText(self.textstyle)
Line 492: Line 582:
local imageRightCell = row.tag('td').addClass('mbox-imageright')
local imageRightCell = row.tag('td').addClass('mbox-imageright')
if self.imageCellDiv then
if self.imageCellDiv then
imageRightCell = imageRightCell.tag('div').css('width', '52px') -- If we are using a div, redefine imageRightCell so that the image is inside it.
-- If we are using a div, redefine imageRightCell so that the image
-- is inside it.
imageRightCell = imageRightCell.tag('div').css('width', '52px')
end
end
imageRightCell
imageRightCell
Line 513: Line 605:
.tag('div')
.tag('div')
.css('text-align', 'center')
.css('text-align', 'center')
.wikitext(format('This message box is using an invalid "type=%s" parameter and needs fixing.', self.type or ''))
.wikitext(format(
'This message box is using an invalid "type=%s" parameter and needs fixing.',
self.type or ''
))
end
end


Line 524: Line 619:


local function main(boxType, args)
local function main(boxType, args)
box:setTitle(args)
local outputBox = box.new()
local cfg = box:getConfig(boxType)
outputBox:setTitle(args)
args = box:removeBlankArgs(cfg, args)
local cfg = outputBox:getConfig(boxType)
box:setBoxParameters(cfg, args)
args = outputBox:removeBlankArgs(cfg, args)
return box:export()
outputBox:setBoxParameters(cfg, args)
return outputBox:export()
end
end


local function makeWrapper(boxType)
local function makeWrapper(boxType)
return function (frame)
return function (frame)
-- If called via #invoke, use the args passed into the invoking
local args = getArgs(frame, {trim = false, removeBlanks = false})
-- 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
-- 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)
return main(boxType, args)
end
end
T12
Administrators
14,061

edits

Retrieved from "https://sarkarverse.org/wiki/Special:MobileDiff/4338...34726"

Navigation menu