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