Changes
rename formatMessage --> message, as it is no longer just doing formatting; tweak the function's comment as well
----------------------------------------------------------------------------
local function formatMessagemessage(cfgKey, expectType, valArray)
--[[
-- Formats Gets a message from the cfg tableand formats it if appropriate. -- The function raises an error if the value from the cfg table is not -- of the type expectType. -- Values from If the table valArray can be specified is present, strings such as $1, $2 etc. in the -- message by using $1 for are substituted with values from the table keys [1], $2 for [2], etc.
-- For example, if the message cfg.fooMessage had the value 'Foo $2 bar $1.',
-- formatMessagemessage('fooMessage', 'string', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
if expectType and type(msg) ~= expectType then
error('formatMessagemessage: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
if not valArray then
local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error('formatMessagemessage: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end
local function makeInvokeFunc(funcName)
return function (frame)
local headingArg = formatMessagemessage('headingArg', 'string')
local args = getArgs(frame, {
valueFunc = function (key, value)
-- so that we don't have to worry about unclosed tags.
.tag('div')
.attr('id', formatMessagemessage('mainDivId', 'string')) .addClass(formatMessagemessage('mainDivClasses', 'string'))
.newline()
.wikitext(p._startBox(args))
function p.sandboxNotice(args)
local sandboxNoticeTemplate = formatMessagemessage('sandboxNoticeTemplate', 'string') if not (sandboxNoticeTemplate and currentTitle.subpageText == formatMessagemessage('sandboxSubpage', 'string')) then
return nil
end
.css('clear', 'both')
.done()
.wikitext(frame:expandTemplate{title = sandboxNoticeTemplate, args = {[formatMessagemessage('sandboxNoticeLivepageParam')] = args[formatMessagemessage('livepageArg', 'string')]}})
return tostring(notice)
end
function p.protectionTemplate()
local protectionTemplate = formatMessagemessage('protectionTemplate', 'string')
if not (protectionTemplate and currentTitle.namespace == 10) then
-- Don't display the protection template if we are not in the template namespace.
if getProtectionLevel('move') == 'sysop' or getProtectionLevel('edit') then
-- The page is full-move protected, or full, template, or semi-protected.
return frame:expandTemplate{title = protectionTemplate, args = formatMessagemessage('protectionTemplateArgs', 'table')}
end
return nil
function p._startBox(args)
-- Arg processing from {{documentation}}.
local preload = args[formatMessagemessage('preloadArg', 'string')] -- Allow custom preloads. local heading = args[formatMessagemessage('headingArg', 'string')] -- Blank values are not removed. local headingStyle = args[formatMessagemessage('headingStyleArg', 'string')] local content = args[formatMessagemessage('contentArg', 'string')]
local docspace = p.docspace()
local docname = args[1] -- Other docname, if fed.
local namespace = docspace or currentTitle.nsText
local pagename = templatePage or currentTitle.text
docpage = namespace .. ':' .. pagename .. '/' .. formatMessagemessage('docSubpage', 'string')
end
local docTitle = mw.title.new(docpage)
hspan.wikitext(heading)
elseif subjectSpace == 10 then -- Template namespace
hspan.wikitext(formatMessagemessage('documentationIconWikitext', 'string') .. ' ' .. formatMessagemessage('templateNamespaceHeading', 'string'))
elseif subjectSpace == 828 then -- Module namespace
hspan.wikitext(formatMessagemessage('documentationIconWikitext', 'string') .. ' ' .. formatMessagemessage('moduleNamespaceHeading', 'string'))
elseif subjectSpace == 6 then -- File namespace
hspan.wikitext(formatMessagemessage('fileNamespaceHeading', 'string'))
else
hspan.wikitext(formatMessagemessage('otherNamespacesHeading', 'string'))
end
local lspan = sbox.tag('span') -- lspan is short for "link span".
lspan
.addClass(formatMessagemessage('startBoxLinkclasses', 'string')) .attr('id', formatMessagemessage('startBoxLinkId', 'string'))
if docExist then
local viewLink = makeWikilink(docpage, formatMessagemessage('viewLinkDisplay', 'string')) local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, formatMessagemessage('editLinkDisplay', 'string')) local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, formatMessagemessage('historyLinkDisplay', 'string')) local purgeLink = makeUrlLink(currentTitle:fullUrl{action = 'purge'}, formatMessagemessage('purgeLinkDisplay', 'string'))
local text = '[%s] [%s] [%s] [%s]'
text = text:gsub('%[', '[') -- Replace square brackets with HTML entities.
if not preload then
if subjectSpace == 6 then -- File namespace
preload = formatMessagemessage('fileDocpagePreload', 'string')
else
preload = formatMessagemessage('docpagePreload', 'string')
end
end
lspan.wikitext(makeUrlLink(docTitle:fullUrl{action = 'edit', preload = preload}, formatMessagemessage('createLinkDisplay', 'string')))
end
end
function p._content(args)
local content = args[formatMessagemessage('contentArg', 'string')]
if not content then
local docpage = args[1]
content = frame:preprocess('{{ ' .. docpage .. ' }}')
else
docpage = p.docspace() .. ':' .. p.templatePage() .. '/' .. formatMessagemessage('docSubpage', 'string')
if mw.title.new(docpage).exists then
local frame = mw.getCurrentFrame()
function p._endBox(args)
-- Argument processing in {{documentation}}.
local content = args[formatMessagemessage('contentArg', 'string')] local linkBox = args[formatMessagemessage('linkBoxArg', 'string')] -- So "link box=off" works.
local docspace = p.docspace()
local docname = args[1] -- Other docname, if fed.
docpage = docname
else
docpage = docpageRoot .. '/' .. formatMessagemessage('docSubpage', 'string')
end
local docTitle = mw.title.new(docpage)
local docExist = docTitle.exists
local docnameFed = args[1] and true
local sandbox = docpageRoot .. '/' .. formatMessagemessage('sandboxSubpage', 'string') local testcases = docpageRoot .. '/' .. formatMessagemessage('testcasesSubpage', 'string')
templatePage = currentTitle.nsText .. ':' .. templatePage
-- First, check whether we should output the end box at all. Add the end box by default if the documentation
-- exists or if we are in the user, module or template namespaces.
if linkBox == formatMessagemessage('linkBoxOff', 'string') or not (docExist or subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10) then
return nil
end
-- Assemble the arguments for {{fmbox}}.
local fmargs = {}
fmargs[formatMessagemessage('fmboxIdParam', 'string')] = formatMessagemessage('fmboxId', 'string') -- Sets fmargs.id = 'documentation-meta-data' fmargs[formatMessagemessage('fmboxImageParam', 'string')] = formatMessagemessage('fmboxImageNone', 'string') -- Sets fmargs.image = 'none' fmargs[formatMessagemessage('fmboxStyleParam', 'string')] = formatMessagemessage('fmboxStyle', 'string') -- Sets fmargs.style = 'background-color: #ecfcf4' fmargs[formatMessagemessage('fmboxTextstyleParam', 'string')] = formatMessagemessage('fmboxTextstyle', 'string') -- Sets fmargs.textstyle = 'font-style: italic;'
-- Assemble the fmbox text field.
-- /doc exists; link to it.
local docLink = makeWikilink(docpage)
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, formatMessagemessage('editLinkDisplay', 'string')) local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, formatMessagemessage('historyLinkDisplay', 'string')) text = text .. formatMessagemessage('transcludedFromBlurb', 'string', {docLink}) .. ' ' .. makeToolbar(editLink, historyLink) .. '<br />'
elseif subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = formatMessagemessage('modulePreload', 'string')}, formatMessagemessage('createLinkDisplay', 'string')) text = text .. formatMessagemessage('createModuleDocBlurb', 'string', {createLink}) .. '<br />'
end
-- Add links to /sandbox and /testcases when appropriate.
-- We are in the user, module or template namespaces.
local sandboxLinks, testcasesLinks
local pagePossessive = subjectSpace == 828 and formatMessagemessage('modulePossessive', 'string') or formatMessagemessage('templatePossessive', 'string')
local sandboxTitle = mw.title.new(sandbox)
if sandboxTitle.exists then
local sandboxLink = makeWikilink(sandbox, formatMessagemessage('sandboxLinkDisplay', 'string')) local sandboxEditLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit'}, formatMessagemessage('sandboxEditLinkDisplay', 'string')) local compareLink = makeUrlLink(mw.title.new('Special:ComparePages'):fullUrl{page1 = templatePage, page2 = sandbox}, formatMessagemessage('compareLinkDisplay', 'string'))
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
local sandboxPreload = subjectSpace == 828 and formatMessagemessage('moduleSandboxPreload', 'string') or formatMessagemessage('templateSandboxPreload', 'string') local sandboxCreateLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}, formatMessagemessage('sandboxCreateLinkDisplay', 'string')) local mirrorSummary = formatMessagemessage('mirrorEditSummary', 'string', {makeWikilink(templatePage)}) local mirrorLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}, formatMessagemessage('mirrorLinkDisplay', 'string')) sandboxLinks = formatMessagemessage('sandboxLinkDisplay', 'string') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
local testcaseTitle = mw.title.new(testcases)
if testcaseTitle.exists then
local testcasesLink = makeWikilink(testcases, formatMessagemessage('testcasesLinkDisplay', 'string')) local testcasesEditLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit'}, formatMessagemessage('testcasesEditLinkDisplay', 'string'))
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
else
local testcasesPreload = subjectSpace == 828 and formatMessagemessage('moduleTestcasesPreload', 'string') or formatMessagemessage('templateTestcasesPreload', 'string') local testcasesCreateLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit', preload = testcasesPreload}, formatMessagemessage('testcasesCreateLinkDisplay', 'string')) testcasesLinks = formatMessagemessage('testcasesLinkDisplay', 'string') .. ' ' .. makeToolbar(testcasesCreateLink)
end
text = text .. formatMessagemessage('experimentBlurb', 'string', {pagePossessive, sandboxLinks, testcasesLinks}) .. '<br />'
-- Show the categories text, but not if "content" fed or "docname fed" since then it is unclear where to add the categories.
if not content and not docnameFed then
local docPathLink = makeWikilink(docpage, formatMessagemessage('docLinkDisplay', 'string')) text = text .. formatMessagemessage('addCategoriesBlurb', 'string', {docPathLink})
end
-- Show the "subpages" link.
local pagetype
if subjectSpace == 10 then
pagetype = formatMessagemessage('templatePagetype', 'string')
elseif subjectSpace == 828 then
pagetype = formatMessagemessage('modulePagetype', 'string')
else
pagetype = formatMessagemessage('defaultPagetype', 'string')
end
text = text .. ' ' .. makeWikilink('Special:PrefixIndex/' .. templatePage .. '/', formatMessagemessage('subpagesLinkDisplay', 'string', {pagetype}))
end
-- Show the "print" link if it exists.
local printPage = templatePage .. '/' .. formatMessagemessage('printSubpage', 'string')
local printTitle = mw.title.new(printPage)
if printTitle.exists then
local printLink = makeWikilink(printPage, formatMessagemessage('printLinkDisplay', 'string')) text = text .. '<br />' .. formatMessagemessage('printBlurb', 'string', {printLink}) .. (formatMessagemessage('displayPrintCategory', 'boolean') and makeCategoryLink(formatMessagemessage('printCategory', 'string')) or '')
end
end
local ret = ''
local subpage = currentTitle.subpageText
if formatMessagemessage('displayStrangeUsageCategory', 'boolean') and (subpage == formatMessagemessage('docSubpage', 'string') or subpage == formatMessagemessage('testcasesSubpage', 'string')) then local sort = (currentTitle.namespace == 0 and formatMessagemessage('strangeUsageCategoryMainspaceSort', 'string') or '') .. currentTitle.prefixedText -- Sort on namespace. ret = ret .. makeCategoryLink(formatMessagemessage('strangeUsageCategory', 'string'), sort)
end
return ret
-- Determines the template page. No namespace or interwiki prefixes are included.
local subpage = currentTitle.subpageText
if subpage == formatMessagemessage('sandboxSubpage', 'string') or subpage == formatMessagemessage('testcasesSubpage', 'string') then
return currentTitle.baseText
else