The Lonsdale Battalion

Module:Documentation: Difference between revisions

Module Discussion

Module:Documentation (view source)

Revision as of 08:15, 20 January 2014

638 bytes removed ,  10 years ago
make 'string' the default message type in the message function to avoid having 'string' all over the place
(remove the err function, as it's not being used any more)
(make 'string' the default message type in the message function to avoid having 'string' all over the place)
Line 21:
----------------------------------------------------------------------------
 
local function message(cfgKey, expectTypevalArray, valArrayexpectType)
--[[
-- 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 default type for expectType is 'string'.
-- 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.',
-- message('fooMessage', 'string', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
if expectType and type(msg) ~= expectType thenor 'string'
if type(msg) ~= expectType then
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
Line 126 ⟶ 127:
-- so that we don't have to worry about unclosed tags.
.tag('div')
.attr('id', message('mainDivId', 'string'))
.addClass(message('mainDivClasses', 'string'))
.newline()
.wikitext(p._startBox(args, env))
Line 195 ⟶ 196:
title = mw.title.new(titleArg)
if not title then
error(message('titleArgError', 'string', {titleArg}))
end
else
Line 207 ⟶ 208:
local title = env.title
local subpage = title.subpageText
if subpage == message('sandboxSubpage', 'string') or subpage == message('testcasesSubpage', 'string') then
return title.basePageTitle
else
Line 222 ⟶ 223:
docpage = docname
else
docpage = env.docpageRoot .. '/' .. message('docSubpage', 'string')
end
return mw.title.new(docpage)
Line 229 ⟶ 230:
function envFuncs.sandboxTitle()
-- Title object for the /sandbox subpage.
return mw.title.new(env.docpageRoot .. '/' .. message('sandboxSubpage', 'string'))
end
function envFuncs.testcasesTitle()
-- Title object for the /testcases subpage.
return mw.title.new(env.docpageRoot .. '/' .. message('testcasesSubpage', 'string'))
end
function envFuncs.printTitle()
-- Title object for the /Print subpage.
return env.templateTitle:subPageTitle(message('printSubpage', 'string'))
end
 
Line 296 ⟶ 297:
local omargs = {} -- Args for {{ombox}}.
-- Get the image wikitext.
omargs.image = message('sandboxNoticeImage', 'string')
-- Get the text. We start with the opening blurb, which is something like
-- "This is the template sandbox for [[Template:Foo]] (diff)."
Line 306 ⟶ 307:
if isPreviewing or not compareUrl then
-- 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'
text = text .. message('sandboxNoticeBlurb', 'string', {templateLink})
else
-- 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'
local compareDisplay = message('sandboxNoticeCompareLinkDisplay', 'string')
local compareLink = makeUrlLink(compareUrl, compareDisplay)
text = text .. message('sandboxNoticeDiffBlurb', 'string', {templateLink, compareLink})
end
-- Get the test cases page blurb if the page exists.
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
local testcasesLinkDisplay = message('sandboxNoticeTestcasesLinkDisplay', 'string')
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
text = text .. '<br />' .. message('sandboxNoticeTestcasesBlurb', 'string', {testcasesLink})
end
-- Add the page to [[Category:Template sandboxes]].
text = text .. makeCategoryLink(message('sandboxCategory', 'string'))
omargs.text = text
return messageBox.main('ombox', omargs)
Line 328 ⟶ 329:
function p.protectionTemplate(env)
local title = env.title
local protectionTemplate = message('protectionTemplate', 'string')
if not (protectionTemplate and title.namespace == 10) then
-- Don't display the protection template if we are not in the template namespace.
Line 346 ⟶ 347:
if getProtectionLevel('move', prefixedTitle) == 'sysop' or getProtectionLevel('edit', prefixedTitle) then
-- The page is full-move protected, or full, template, or semi-protected.
return frame:expandTemplate{title = protectionTemplate, args = message('protectionTemplateArgs', nil, 'table')}
end
return nil
Line 389 ⟶ 390:
data.docTitle = docTitle
-- View, display, edit, and purge links if /doc exists.
data.viewLinkDisplay = message('viewLinkDisplay', 'string')
data.editLinkDisplay = message('editLinkDisplay', 'string')
data.historyLinkDisplay = message('historyLinkDisplay', 'string')
data.purgeLinkDisplay = message('purgeLinkDisplay', 'string')
-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if env.subjectSpace == 6 then -- File namespace
preload = message('fileDocpagePreload', 'string')
else
preload = message('docpagePreload', 'string')
end
end
data.preload = preload
data.createLinkDisplay = message('createLinkDisplay', 'string')
return data
end
Line 444 ⟶ 445:
data.heading = heading
elseif subjectSpace == 10 then -- Template namespace
data.heading = message('documentationIconWikitext', 'string') .. ' ' .. message('templateNamespaceHeading', 'string')
elseif subjectSpace == 828 then -- Module namespace
data.heading = message('documentationIconWikitext', 'string') .. ' ' .. message('moduleNamespaceHeading', 'string')
elseif subjectSpace == 6 then -- File namespace
data.heading = message('fileNamespaceHeading', 'string')
else
data.heading = message('otherNamespacesHeading', 'string')
end
Line 467 ⟶ 468:
-- [view][edit][history][purge] or [create] links.
if links then
data.linksClass = message('startBoxLinkclasses', 'string')
data.linksId = message('startBoxLinkId', 'string')
data.links = links
end
Line 548 ⟶ 549:
-- Assemble the arguments for {{fmbox}}.
local fmargs = {}
fmargs.id = message('fmboxId', 'string') -- Sets 'documentation-meta-data'
fmargs.image = message('fmboxImageNone', 'string') -- Sets 'none'
fmargs.style = message('fmboxStyle', 'string') -- Sets 'background-color: #ecfcf4'
fmargs.textstyle = message('fmboxTextstyle', 'string') -- 'font-style: italic;'
 
-- Assemble the fmbox text field.
Line 596 ⟶ 597:
local ret
if printTitle.exists then
local printLink = makeWikilink(printTitle.prefixedText, message('printLinkDisplay', 'string'))
ret = message('printBlurb', 'string', {printLink})
local displayPrintCategory = message('displayPrintCategory', nil, 'boolean')
if displayPrintCategory then
ret = ret .. makeCategoryLink(message('printCategory', 'string'))
end
end
Line 616 ⟶ 617:
local pagetype
if subjectSpace == 10 then
pagetype = message('templatePagetype', 'string')
elseif subjectSpace == 828 then
pagetype = message('modulePagetype', 'string')
else
pagetype = message('defaultPagetype', 'string')
end
return makeWikilink(
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
message('subpagesLinkDisplay', 'string', {pagetype})
)
end
Line 635 ⟶ 636:
end
-- Make the blurb.
local docPathLink = makeWikilink(docTitle.prefixedText, message('docLinkDisplay', 'string'))
return message('addCategoriesBlurb', 'string', {docPathLink})
end
 
Line 651 ⟶ 652:
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = message('editLinkDisplay', 'string')
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = message('historyLinkDisplay', 'string')
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcludedFromBlurb', 'string', {docLink})
.. ' '
.. makeToolbar(editLink, historyLink)
Line 662 ⟶ 663:
elseif env.subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('modulePreload', 'string')}
local createDisplay = message('createLinkDisplay', 'string')
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('createModuleDocBlurb', 'string', {createLink})
.. '<br />'
end
Line 686 ⟶ 687:
if sandboxTitle.exists then
local sandboxPage = sandboxTitle.prefixedText
local sandboxDisplay = message('sandboxLinkDisplay', 'string')
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
local sandboxEditDisplay = message('sandboxEditLinkDisplay', 'string')
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
local compareUrl = env.compareUrl
local compareLink
if compareUrl then
local compareDisplay = message('compareLinkDisplay', 'string')
compareLink = makeUrlLink(compareUrl, compareDisplay)
end
Line 701 ⟶ 702:
local sandboxPreload
if subjectSpace == 828 then
sandboxPreload = message('moduleSandboxPreload', 'string')
else
sandboxPreload = message('templateSandboxPreload', 'string')
end
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
local sandboxCreateDisplay = message('sandboxCreateLinkDisplay', 'string')
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local mirrorSummary = message('mirrorEditSummary', 'string', {makeWikilink(templatePage)})
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}
local mirrorDisplay = message('mirrorLinkDisplay', 'string')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
sandboxLinks = message('sandboxLinkDisplay', 'string') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
if testcasesTitle.exists then
local testcasesPage = testcasesTitle.prefixedText
local testcasesDisplay = message('testcasesLinkDisplay', 'string')
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
local testcasesEditDisplay = message('testcasesEditLinkDisplay', 'string')
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
Line 725 ⟶ 726:
local testcasesPreload
if subjectSpace == 828 then
testcasesPreload = message('moduleTestcasesPreload', 'string')
else
testcasesPreload = message('templateTestcasesPreload', 'string')
end
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
local testcasesCreateDisplay = message('testcasesCreateLinkDisplay', 'string')
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
testcasesLinks = message('testcasesLinkDisplay', 'string') .. ' ' .. makeToolbar(testcasesCreateLink)
end
local messageName
Line 740 ⟶ 741:
messageName = 'experimentBlurbTemplate'
end
return message(messageName, 'string', {sandboxLinks, testcasesLinks})
end
 
Line 752 ⟶ 753:
local ret = ''
local subpage = title.subpageText
if message('displayStrangeUsageCategory', nil, 'boolean') and (subpage == message('docSubpage', 'string') or subpage == message('testcasesSubpage', 'string')) then
local sort = (title.namespace == 0 and message('strangeUsageCategoryMainspaceSort', 'string') or '') .. title.prefixedText -- Sort on namespace.
ret = ret .. makeCategoryLink(message('strangeUsageCategory', 'string'), sort)
end
return ret
Retrieved from "https://thelonsdalebattalion.co.uk/wiki/Special:MobileDiff/29875"