Changes
Undo revision 1688805 by Jackmcbarn (talk) Breaks a lot of templates because there is no css in the main css for this wiki. Wikipedia English has css for this.
-- This is a meta-module for producing message box templates, including
-- {{mbox}}, {{ambox}}, {{imbox}}, {{tmbox}}, {{ombox}}, {{cmbox}} and {{fmbox}}.
-- Load Require necessary modules.local getArgs = require('Module:No globalsArguments').getArgslocal getArgshtmlBuilder = require('Module:HtmlBuilder')local categoryHandler = require('Module:Category handler')._mainmain
local yesno = require('Module:Yesno')
-- Load the configuration page.local cfgTables = mw.loadData('Module:Message box/configuration')
-- Get a language object for formatDate and ucfirst.
local lang = mw.language.getContentLanguage()
-- Set aliases for often-used functions to reduce table lookups.local format = mw.ustring.formatlocal tinsert = table.insertlocal tconcat = table.concatlocal trim = mw.text.trim
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------
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
local function union(t1, t2)
-- Returns the union of two arrays.
local ret = {}
for k in pairs(vals) do
end
table.sort(ret)
return ret
end
local function getArgNums(args, prefix)
local nums = {}
local num = mw.ustring.match(tostring(k), '^' .. prefix .. '([1-9]%d*)$')
if num then
end
end
return nums
end
--------------------------------------------------------------------------------
-- Box class definition
--------------------------------------------------------------------------------
local MessageBox box = {}MessageBoxbox.__index = MessageBoxbox function MessageBoxbox.new(boxType, args, cfg) args = args or {}
local obj = {}
setmetatable(obj, box) -- Set the title object and the namespacereturn objend function box.getNamespaceId(ns) obj.title if not ns then return end if type(ns) == 'string' then ns = getTitleObjectlang:ucfirst(args.page) or mw.titleustring.getCurrentTitlelower(ns)) if ns == 'Main' then ns = 0 end -- Set the config for our box type.end objlocal nsTable = mw.site.cfg = cfgnamespaces[boxTypens] if not obj.cfg nsTable then local ns = objreturn nsTable.titleid endend function box.namespacegetMboxType(nsid) -- boxType is "Gets the mbox" or invalid inputtype from a namespace number. if ns nsid == 0 then obj.cfg = cfg. return 'ambox ' -- main namespace elseif ns nsid == 6 then obj.cfg = cfg. return 'imbox ' -- file namespace elseif ns nsid == 14 then obj return 'cmbox' -- category namespace else local nsTable = mw.site.cfg = cfgnamespaces[nsid] if nsTable and nsTable.cmbox isTalk then return 'tmbox' -- category any talk namespace
else
end
end
end -- Set the argumentsfunction box:addCat(ns, cat, and remove all blank arguments except for the onessort) -- listed in cfg.allowBlankParams.if type(cat) ~= 'string' then return end do local newArgs nsVals = {'main', 'template', 'all'} local tname for ki, v val in pairsipairs(argsnsVals) do if v ~ns == '' val then newArgs[k] tname = v endns .. 'Cats'
end
end if not tname then for i, param val in ipairs(obj.cfg.allowBlankParams or {}nsVals) do newArgsnsVals[parami] = args[param]format('"%s"', val)
end
end
end
function MessageBoxbox:addCataddClass(nsclass) if type(class) ~= 'string' then return end self.classes = self.classes or {} tinsert(self.classes, catclass)end function box:addAttr(attr, sortval) if not cat type(attr) ~= 'string' or type(val) ~= 'string' then return end self.attrs = self.attrs or {} tinsert(self.attrs, attr)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.namespaceend function box:getConfig(boxType) -- Get the box config data from the data page. if boxType == 'mbox' then return nilboxType = box.getMboxType(self.nsid)
end
local cfg = cfgTables[boxType] if sort not cfg then cat local boxTypes = string.{} for k, v in pairs(dataTables) do tinsert(boxTypes, format('[[Category:%s|"%s]]"', catk)) end tinsert(boxTypes, sort'"mbox"') else cat = string.error(format( '[[Category:invalid message box type "%s"; valid types are %s]]', cat tostring(boxType), mw.text.listToText(boxTypes) ), 2)
end
end
function MessageBoxbox:addClassremoveBlankArgs(classcfg, args) -- Only allow blank arguments for the parameter names listed in -- cfg.allowBlankParams. local newArgs = {} for k, v in pairs(args) do if not class v ~= '' then newArgs[k] = v return nilend
end
end
function MessageBoxbox:setParameterssetBoxParameters(cfg, args) local args = self.args local cfg = self.cfg
-- Get type data.
self.type = args.type
and self.type
and not typeData
and true
or false
typeData = typeData or cfg.types[cfg.default]
self.typeClass = typeData.class
self.typeImage = typeData.image
-- Find if the box has been wrongly substituted.
-- Find whether we are using a small message box.
cfg.smallParam and args.small == cfg.smallParam
or not cfg.smallParam and yesno(args.small)
)
then self.isSmall = true else self.isSmall = false end
-- Add attributes, classes and styles.
if cfg.allowId then self.id = args.id end
self:addClass(
cfg.usePlainlinksParam and yesno(args.plainlinks or true) and 'plainlinks'
self.style = args.style
self.attrs = args.attrs
-- Set text style.
self.textstyle = args.textstyle
-- Find if we are on the template page or not. This functionality is only
-- used if useCollapsibleTextFields is set, or if both cfg.templateCategory
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}}.
text = type(text) == 'string' and text or nil
local issues = {}
end
-- Get the self.talk value.
local talk = args.talk
-- parameter is blank.
if talk == ''
and self.templateTitle
and (
mw.title.equals(self.templateTitle, self.title)
local talkText = 'Relevant discussion may be found on'
if talkArgIsTalkPage then
talkText = string.format(
'%s [[%s|%s]].',
talkText,
)
else
talkText = string.format(
'%s the [[%s#%s|talk page]].',
talkText,
end
end
-- Get other values.
self.fix = args.fix ~= '' and args.fix or nil
end
if date then
self.date = string.format(" <small>''(%s)''</small>", date)
end
self.info = args.info
end
-- 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.
self.text = args.text
end
-- Set the below row.
self.below = cfg.below and args.below
-- General image settings.
self.imageCellDiv = not self.isSmall and cfg.imageCellDivand true or false
self.imageEmptyCell = cfg.imageEmptyCell
if cfg.imageEmptyCellStyle then
self.imageEmptyCellStyle = 'border:none;padding:0px;width:1px'
end
-- Left image settings.
local imageLeft = self.isSmall and args.smallimage or args.image
and (cfg.imageSmallSize or '30x30px')
or '40x40px'
self.imageLeft = string.format('[[File:%s|%s|link=|alt=]]', self.typeImage
or 'Imbox notice.png', imageSize)
end
end
-- Right image settings.
local imageRight = self.isSmall and args.smallimageright or args.imageright
self.imageRight = imageRight
end
end
end
end
if cfg.templateCategory then
if cfg.templateCategoryRequireName then
if self.isTemplatePage then
self:addCat(10'template', cfg.templateCategory)
end
elseif not self.title.isSubpage then
self:addCat(10'template', cfg.templateCategory)
end
end
-- Add template error categoriescategory.
if cfg.templateErrorCategory then
local templateErrorCategory = cfg.templateErrorCategory
end
end
self:addCat(10'template', templateCat, templateSort)
end
if self.invalidTypeError then
local allSort = (self.title.namespace nsid == 0 and 'Main:' or '') .. self.title.prefixedText
self:addCat('all', 'Wikipedia message box parameter needs fixing', allSort)
end
self:addCat('all', 'Pages with incorrectly substituted templates')
end
-- Convert category tables to strings and pass them through
-- [[Module:Category handler]].
}
end
function MessageBoxbox:export() local root = mw.htmlhtmlBuilder.create()
-- Add the subst check error.
if self.isSubstituted and self.name then
root: .tag('b') : .addClass('error') : .wikitext(string.format( 'Template <code>%s[[Template:%s|%s]]%s</code> has been incorrectly substituted.', mw.text.nowiki('{{'), self.name, self.name, mw.text.nowiki('}}') ))
end
-- Create the box table.
local boxTable = root:.tag('table') boxTable: .attr('id', self.id or nil)
for i, class in ipairs(self.classes or {}) do
boxTable: .addClass(class or nil)
end
boxTable
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.imageCellDiv then
-- If we are using a div, redefine imageLeftCell so that the image
-- 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'):.css('width', '52px')
end
imageLeftCell: .wikitext(self.imageLeft or nil)
elseif self.imageEmptyCell then
-- Some message boxes define an empty cell if no image is specified, and
-- specified gives the following hint: "No image. Cell with some width
-- or padding necessary for text cell to have 100% width."
row:.tag('td') :.addClass('mbox-empty-cell') :.cssText(self.imageEmptyCellStyle or nil)
end
-- Add the text.
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 textCellSpan = textCell:.tag('span')
textCellSpan
if not self.isSmall then
textCellSpan: .tag('span') : .addClass('hide-when-compact') : .wikitext(self.talk and (' ' .. self.talk) or nil) : .wikitext(self.fix and (' ' .. self.fix) or nil)
end
textCellSpan: .wikitext(self.date and (' ' .. self.date) or nil)
if not self.isSmall then
textCellSpan
end
else
-- Default text formatting - anything goes.
textCell
end
-- Add the right-hand image.
if self.imageRight then
local imageRightCell = row:.tag('td'):.addClass('mbox-imageright')
if self.imageCellDiv then
-- If we are using a div, redefine imageRightCell so that the image
-- is inside it.
imageRightCell = imageRightCell:.tag('div'):.css('width', '52px')
end
imageRightCell
end
-- Add the below row.
if self.below then
boxTable:.tag('tr') :.tag('td') :.attr('colspan', self.imageRight and '3' or '2') :.addClass('mbox-text') :.cssText(self.textstyle or nil) :.wikitext(self.below or nil)
end
-- Add error message for invalid type parameters.
if self.invalidTypeError then
root: .tag('div') : .css('text-align', 'center') : .wikitext(string.format( 'This message box is using an invalid "type=%s" parameter and needs fixing.', self.type or '' ))
end
-- Add categories.
root: .wikitext(self:renderCategories() or nil.categories)
return tostring(root)
end
end
local function mt.__indexmakeWrapper(t, kboxType)
return function (frame)
end
end