Anonymous user
Module:Documentation: Difference between revisions
rename formatMessage --> message, as it is no longer just doing formatting; tweak the function's comment as well
(found it - fix misspelled message name) |
(rename formatMessage --> message, as it is no longer just doing formatting; tweak the function's comment as well) |
||
Line 22:
----------------------------------------------------------------------------
local function
--[[
--
-- 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.',
--
--]]
local msg = cfg[cfgKey]
if expectType and type(msg) ~= expectType then
error('
end
if not valArray then
Line 40 ⟶ 42:
local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error('
end
Line 82 ⟶ 84:
local function makeInvokeFunc(funcName)
return function (frame)
local headingArg =
local args = getArgs(frame, {
valueFunc = function (key, value)
Line 115 ⟶ 117:
-- so that we don't have to worry about unclosed tags.
.tag('div')
.attr('id',
.addClass(
.newline()
.wikitext(p._startBox(args))
Line 132 ⟶ 134:
function p.sandboxNotice(args)
local sandboxNoticeTemplate =
if not (sandboxNoticeTemplate and currentTitle.subpageText ==
return nil
end
Line 142 ⟶ 144:
.css('clear', 'both')
.done()
.wikitext(frame:expandTemplate{title = sandboxNoticeTemplate, args = {[
return tostring(notice)
end
function p.protectionTemplate()
local protectionTemplate =
if not (protectionTemplate and currentTitle.namespace == 10) then
-- Don't display the protection template if we are not in the template namespace.
Line 164 ⟶ 166:
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 =
end
return nil
Line 173 ⟶ 175:
function p._startBox(args)
-- Arg processing from {{documentation}}.
local preload = args[
local heading = args[
local headingStyle = args[
local content = args[
local docspace = p.docspace()
local docname = args[1] -- Other docname, if fed.
Line 188 ⟶ 190:
local namespace = docspace or currentTitle.nsText
local pagename = templatePage or currentTitle.text
docpage = namespace .. ':' .. pagename .. '/' ..
end
local docTitle = mw.title.new(docpage)
Line 225 ⟶ 227:
hspan.wikitext(heading)
elseif subjectSpace == 10 then -- Template namespace
hspan.wikitext(
elseif subjectSpace == 828 then -- Module namespace
hspan.wikitext(
elseif subjectSpace == 6 then -- File namespace
hspan.wikitext(
else
hspan.wikitext(
end
Line 240 ⟶ 242:
local lspan = sbox.tag('span') -- lspan is short for "link span".
lspan
.addClass(
.attr('id',
if docExist then
local viewLink = makeWikilink(docpage,
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'},
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'},
local purgeLink = makeUrlLink(currentTitle:fullUrl{action = 'purge'},
local text = '[%s] [%s] [%s] [%s]'
text = text:gsub('%[', '[') -- Replace square brackets with HTML entities.
Line 254 ⟶ 256:
if not preload then
if subjectSpace == 6 then -- File namespace
preload =
else
preload =
end
end
lspan.wikitext(makeUrlLink(docTitle:fullUrl{action = 'edit', preload = preload},
end
end
Line 269 ⟶ 271:
function p._content(args)
local content = args[
if not content then
local docpage = args[1]
Line 276 ⟶ 278:
content = frame:preprocess('{{ ' .. docpage .. ' }}')
else
docpage = p.docspace() .. ':' .. p.templatePage() .. '/' ..
if mw.title.new(docpage).exists then
local frame = mw.getCurrentFrame()
Line 292 ⟶ 294:
function p._endBox(args)
-- Argument processing in {{documentation}}.
local content = args[
local linkBox = args[
local docspace = p.docspace()
local docname = args[1] -- Other docname, if fed.
Line 304 ⟶ 306:
docpage = docname
else
docpage = docpageRoot .. '/' ..
end
local docTitle = mw.title.new(docpage)
local docExist = docTitle.exists
local docnameFed = args[1] and true
local sandbox = docpageRoot .. '/' ..
local testcases = docpageRoot .. '/' ..
templatePage = currentTitle.nsText .. ':' .. templatePage
Line 317 ⟶ 319:
-- 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 ==
return nil
end
Line 323 ⟶ 325:
-- Assemble the arguments for {{fmbox}}.
local fmargs = {}
fmargs[
fmargs[
fmargs[
fmargs[
-- Assemble the fmbox text field.
Line 337 ⟶ 339:
-- /doc exists; link to it.
local docLink = makeWikilink(docpage)
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'},
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'},
text = text ..
elseif subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload =
text = text ..
end
-- Add links to /sandbox and /testcases when appropriate.
Line 349 ⟶ 351:
-- We are in the user, module or template namespaces.
local sandboxLinks, testcasesLinks
local pagePossessive = subjectSpace == 828 and
local sandboxTitle = mw.title.new(sandbox)
if sandboxTitle.exists then
local sandboxLink = makeWikilink(sandbox,
local sandboxEditLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit'},
local compareLink = makeUrlLink(mw.title.new('Special:ComparePages'):fullUrl{page1 = templatePage, page2 = sandbox},
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
local sandboxPreload = subjectSpace == 828 and
local sandboxCreateLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload},
local mirrorSummary =
local mirrorLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary},
sandboxLinks =
end
local testcaseTitle = mw.title.new(testcases)
if testcaseTitle.exists then
local testcasesLink = makeWikilink(testcases,
local testcasesEditLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit'},
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
else
local testcasesPreload = subjectSpace == 828 and
local testcasesCreateLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit', preload = testcasesPreload},
testcasesLinks =
end
text = text ..
-- 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,
text = text ..
end
-- Show the "subpages" link.
Line 383 ⟶ 385:
local pagetype
if subjectSpace == 10 then
pagetype =
elseif subjectSpace == 828 then
pagetype =
else
pagetype =
end
text = text .. ' ' .. makeWikilink('Special:PrefixIndex/' .. templatePage .. '/',
end
-- Show the "print" link if it exists.
local printPage = templatePage .. '/' ..
local printTitle = mw.title.new(printPage)
if printTitle.exists then
local printLink = makeWikilink(printPage,
text = text .. '<br />' ..
.. (
end
end
Line 411 ⟶ 413:
local ret = ''
local subpage = currentTitle.subpageText
if
local sort = (currentTitle.namespace == 0 and
ret = ret .. makeCategoryLink(
end
return ret
Line 432 ⟶ 434:
-- Determines the template page. No namespace or interwiki prefixes are included.
local subpage = currentTitle.subpageText
if subpage ==
return currentTitle.baseText
else
|