Module:Documentation
Revision as of 13:34, 2 January 2014 by imported>Mr. Stradivarius (add some newlines to make the html slightly more readable)
Documentation for this module may be created at Module:Documentation/doc
-- This module implements {{documentation}}.
-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local htmlBuilder = require('Module:HtmlBuilder')
local messageBox = require('Module:Message box')
-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')
local p = {}
-- Constants.
local currentTitle = mw.title.getCurrentTitle()
local subjectSpace = mw.site.namespaces[currentTitle.namespace].subject.id -- The number of the current subject namespace.
-- Often-used functions.
local gsub = mw.ustring.gsub
----------------------------------------------------------------------------
-- Helper functions
----------------------------------------------------------------------------
local function formatMessage(cfgKey, expectType, valArray)
--[[
-- Formats a message from the cfg table.
-- The function raises an error if the value from the cfg table is not of the type expectType.
-- Values from valArray can be specified in the message by using $1 for [1], $2 for [2], etc.
-- For example, if the message cfg.fooMessage had the value 'Foo $2 bar $1.',
-- formatMessage('fooMessage', 'string', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
if expectType and type(msg) ~= expectType then
error('formatMessage: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
if not valArray then
return msg
end
local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error('formatMessage: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end
local ret = gsub(msg, '$([1-9][0-9]*)', getMessageVal)
return ret
end
local function makeWikilink(page, display)
if display then
return mw.ustring.format('[[%s|%s]]', page, display)
else
return mw.ustring.format('[[%s]]', page)
end
end
local function makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
return makeWikilink(catns .. '/' .. cat, sort)
end
local function makeUrlLink(url, display)
return mw.ustring.format('[%s %s]', url, display)
end
local function makeToolbar(...)
local ret = {}
local lim = select('#', ...)
if lim < 1 then
return nil
end
for i = 1, lim do
ret[#ret + 1] = select(i, ...)
end
return '<small style="font-style: normal;">(' .. table.concat(ret, ' | ') .. ')</small>'
end
----------------------------------------------------------------------------
-- Argument processing
----------------------------------------------------------------------------
local function makeInvokeFunc(funcName)
return function (frame)
local headingArg = formatMessage('headingArg', 'string')
local args = getArgs(frame, {
valueFunc = function (key, value)
if type(value) == 'string' then
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
if key == headingArg or value ~= '' then
return value
else
return nil
end
else
return value
end
end
})
return p[funcName](args)
end
end
----------------------------------------------------------------------------
-- Main functions
----------------------------------------------------------------------------
p.main = makeInvokeFunc('_main')
function p._main(args)
local root = htmlBuilder.create()
root
.wikitext(p.protectionTemplate())
.wikitext(p.sandboxNotice(args))
-- This div tag is from {{documentation/start box}}, but moving it here
-- so that we don't have to worry about unclosed tags.
.tag('div')
.attr('id', formatMessage('mainDivId', 'string'))
.addClass(formatMessage('mainDivClasses', 'string'))
.newline()
.wikitext(p._startBox(args))
.wikitext(p._content(args))
.tag('div')
.css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
.newline()
.done()
.done()
.wikitext(p._endBox(args))
.newline()
.wikitext(p.addTrackingCategories())
return tostring(root)
end
function p.sandboxNotice(args)
local sandboxNoticeTemplate = formatMessage('sandboxNoticeTemplate', 'string')
if not (sandboxNoticeTemplate and currentTitle.subpageText == formatMessage('sandboxSubpage', 'string')) then
return nil
end
local frame = mw.getCurrentFrame()
local notice = htmlBuilder.create()
notice
.tag('div')
.css('clear', 'both')
.done()
.wikitext(frame:expandTemplate{title = sandboxNoticeTemplate, args = {[formatMessage('sandboxNoticeLivepageParam')] = args[formatMessage('livepageArg', 'string')]}})
return tostring(notice)
end
function p.protectionTemplate()
local protectionTemplate = formatMessage('protectionTemplate', 'string')
if not (protectionTemplate and currentTitle.namespace == 10) then
-- Don't display the protection template if we are not in the template namespace.
return nil
end
local frame = mw.getCurrentFrame()
local function getProtectionLevel(protectionType)
-- Gets the protection level for the current page.
local level = frame:callParserFunction('PROTECTIONLEVEL', protectionType)
if level ~= '' then
return level
else
return nil -- The parser function returns the blank string if there is no match.
end
end
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 = formatMessage('protectionTemplateArgs', 'table')}
end
return nil
end
p.startBox = makeInvokeFunc('_startBox')
function p._startBox(args)
-- Arg processing from {{documentation}}.
local preload = args[formatMessage('preloadArg', 'string')] -- Allow custom preloads.
local heading = args[formatMessage('headingArg', 'string')] -- Blank values are not removed.
local headingStyle = args[formatMessage('headingStyleArg', 'string')]
local content = args[formatMessage('contentArg', 'string')]
local docspace = p.docspace()
local docname = args[1] -- Other docname, if fed.
local templatePage = p.templatePage()
-- Arg processing from {{documentation/start box2}}.
local docpage
if docname then
docpage = docname
else
local namespace = docspace or currentTitle.nsText
local pagename = templatePage or currentTitle.text
docpage = namespace .. ':' .. pagename .. '/' .. formatMessage('docSubpage', 'string')
end
local docTitle = mw.title.new(docpage)
local docExist = docTitle.exists
-- Output from {{documentation/start box}}.
-- First, check the heading parameter.
if heading == '' then
-- Heading is defined but blank, so do nothing.
return nil
end
-- Build the start box div.
local sbox = htmlBuilder.create('div')
sbox
.css('padding-bottom', '3px')
.css('border-bottom', '1px solid #aaa')
.css('margin-bottom', '1ex')
.newline()
-- Make the heading.
local hspan = sbox.tag('span')
if headingStyle then
hspan.cssText(headingStyle)
elseif subjectSpace == 10 then
-- We are in the template or template talk namespaces.
hspan
.css('font-weight', 'bold')
.css('fond-size', '125%')
else
hspan.css('font-size', '150%')
end
if heading then
-- "heading" has data.
hspan.wikitext(heading)
elseif subjectSpace == 10 then -- Template namespace
hspan.wikitext(formatMessage('documentationIconWikitext', 'string') .. ' ' .. formatMessage('templateNamespaceHeading', 'string'))
elseif subjectSpace == 828 then -- Module namespace
hspan.wikitext(formatMessage('documentationIconWikitext', 'string') .. ' ' .. formatMessage('moduleNamespaceHeading', 'string'))
elseif subjectSpace == 6 then -- File namespace
hspan.wikitext(formatMessage('fileNamespaceHeading', 'string'))
else
hspan.wikitext(formatMessage('otherNamespaceHeading', 'string'))
end
-- Add the [view][edit][history][purge] or [create] links.
-- Check for the content parameter first, as we don't need the links if the documentation
-- content is being entered directly onto the template page.
if not content then
local lspan = sbox.tag('span') -- lspan is short for "link span".
lspan
.addClass(formatMessage('startBoxLinkclasses', 'string'))
.attr('id', formatMessage('startBoxLinkId', 'string'))
if docExist then
local viewLink = makeWikilink(docpage, formatMessage('viewLinkDisplay', 'string'))
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, formatMessage('editLinkDisplay', 'string'))
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, formatMessage('historyLinkDisplay', 'string'))
local purgeLink = makeUrlLink(currentTitle:fullUrl{action = 'purge'}, formatMessage('purgeLinkDisplay', 'string'))
local text = '[%s] [%s] [%s] [%s]'
text = text:gsub('%[', '[') -- Replace square brackets with HTML entities.
text = text:gsub('%]', ']')
lspan.wikitext(mw.ustring.format(text, viewLink, editLink, historyLink, purgeLink))
else
if not preload then
if subjectSpace == 6 then -- File namespace
preload = formatMessage('fileDocpagePreload', 'string')
else
preload = formatMessage('docpagePreload', 'string')
end
end
lspan.wikitext(makeUrlLink(docTitle:fullUrl{action = 'edit', preload = preload}, formatMessage('createLinkDisplay', 'string')))
end
end
return tostring(sbox)
end
p.content = makeInvokeFunc('_content')
function p._content(args)
local content = args[formatMessage('contentArg', 'string')]
if not content then
local docpage = args[1]
if docpage and mw.title.new(docpage).exists then
local frame = mw.getCurrentFrame()
content = frame:preprocess('{{ ' .. docpage .. ' }}')
else
docpage = p.docspace() .. ':' .. p.templatePage() .. '/' .. formatMessage('docSubpage', 'string')
if mw.title.new(docpage).exists then
local frame = mw.getCurrentFrame()
content = frame:preprocess('{{ ' .. docpage .. ' }}')
end
end
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- of docs are interpreted correctly.
return '\n' .. (content or '') .. '\n'
end
p.endBox = makeInvokeFunc('_endBox')
function p._endBox(args)
-- Argument processing in {{documentation}}.
local content = args[formatMessage('contentArg', 'string')]
local linkBox = args[formatMessage('linkBoxArg', 'string')] -- So "link box=off" works.
local docspace = p.docspace()
local docname = args[1] -- Other docname, if fed.
local templatePage = p.templatePage()
-- Argument processing in {{documentation/end box2}}.
local docpageRoot = (docspace or currentTitle.nsText) .. ':' .. (templatePage or currentTitle.text)
local docpage
if docname then
docpage = docname
else
docpage = docpageRoot .. '/' .. formatMessage('docSubpage', 'string')
end
local docTitle = mw.title.new(docpage)
local docExist = docTitle.exists
local docnameFed = args[1] and true
local sandbox = docpageRoot .. '/' .. formatMessage('sandboxSubpage', 'string')
local testcases = docpageRoot .. '/' .. formatMessage('testcasesSubpage', 'string')
templatePage = currentTitle.nsText .. ':' .. templatePage
-- Output from {{documentation/end box}}
-- 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 == formatMessage('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[formatMessage('fmboxIdParam', 'string')] = formatMessage('fmboxId', 'string') -- Sets fmargs.id = 'documentation-meta-data'
fmargs[formatMessage('fmboxImageParam', 'string')] = formatMessage('fmboxImageNone', 'string') -- Sets fmargs.image = 'none'
fmargs[formatMessage('fmboxStyleParam', 'string')] = formatMessage('fmboxStyle', 'string') -- Sets fmargs.style = 'background-color: #ecfcf4'
fmargs[formatMessage('fmboxTextstyleParam', 'string')] = formatMessage('fmboxTextstyle', 'string') -- Sets fmargs.textstyle = 'font-style: italic;'
-- Assemble the fmbox text field.
local text = ''
if linkBox then
-- Use custom link box content if it is defined.
text = text .. linkBox
else
if docExist then
-- /doc exists; link to it.
local docLink = makeWikilink(docpage)
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, formatMessage('editLinkDisplay', 'string'))
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, formatMessage('historyLinkDisplay', 'string'))
text = text .. formatMessage('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 = formatMessage('modulePreload', 'string')}, formatMessage('createLinkDisplay', 'string'))
text = text .. formatMessage('createModuleDocBlurb', 'string', {createLink}) .. '<br />'
end
-- Add links to /sandbox and /testcases when appropriate.
if subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10 then
-- We are in the user, module or template namespaces.
local sandboxLinks, testcasesLinks
local pagePossessive = subjectSpace == 828 and formatMessage('modulePossessive', 'string') or formatMessage('templatePossessive', 'string')
local sandboxTitle = mw.title.new(sandbox)
if sandboxTitle.exists then
local sandboxLink = makeWikilink(sandbox, formatMessage('sandboxLinkDisplay', 'string'))
local sandboxEditLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit'}, formatMessage('sandboxEditLinkDisplay', 'string'))
local compareLink = makeUrlLink(mw.title.new('Special:ComparePages'):fullUrl{page1 = templatePage, page2 = sandbox}, formatMessage('compareLinkDisplay', 'string'))
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
local sandboxPreload = subjectSpace == 828 and formatMessage('moduleSandboxPreload', 'string') or formatMessage('templateSandboxPreload', 'string')
local sandboxCreateLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}, formatMessage('sandboxCreateLinkDisplay', 'string'))
local mirrorSummary = formatMessage('mirrorEditSummary', 'string', {makeWikilink(templatePage)})
local mirrorLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}, formatMessage('mirrorLinkDisplay', 'string'))
sandboxLinks = formatMessage('sandboxLinkDisplay', 'string') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
local testcaseTitle = mw.title.new(testcases)
if testcaseTitle.exists then
local testcasesLink = makeWikilink(testcases, formatMessage('testcasesLinkDisplay', 'string'))
local testcasesEditLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit'}, formatMessage('testcasesEditLinkDisplay', 'string'))
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
else
local testcasesPreload = subjectSpace == 828 and formatMessage('moduleTestcasesPreload', 'string') or formatMessage('templateTestcasesPreload', 'string')
local testcasesCreateLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit', preload = testcasesPreload}, formatMessage('testcasesCreateLinkDisplay', 'string'))
testcasesLinks = formatMessage('testcasesLinkDisplay', 'string') .. ' ' .. makeToolbar(testcasesCreateLink)
end
text = text .. formatMessage('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, formatMessage('docLinkDisplay', 'string'))
text = text .. formatMessage('addCategoriesBlurb', 'string', {docPathLink})
end
-- Show the "subpages" link.
if subjectSpace ~= 6 then -- Don't show the link in file space.
local pagetype
if subjectSpace == 10 then
pagetype = formatMessage('templatePagetype', 'string')
elseif subjectSpace == 828 then
pagetype = formatMessage('modulePagetype', 'string')
else
pagetype = formatMessage('defaultPagetype', 'string')
end
text = text .. ' ' .. makeWikilink('Special:PrefixIndex/' .. templatePage .. '/', formatMessage('subpagesLinkDisplay', 'string', {pagetype}))
end
-- Show the "print" link if it exists.
local printPage = templatePage .. '/' .. formatMessage('printSubpage', 'string')
local printTitle = mw.title.new(printPage)
if printTitle.exists then
local printLink = makeWikilink(printPage, formatMessage('printLinkDisplay', 'string'))
text = text .. '<br />' .. formatMessage('printBlurb', 'string', {printLink})
.. (formatMessage('displayPrintCategory', 'boolean') and makeCategoryLink(formatMessage('printCategory', 'string')) or '')
end
end
end
fmargs.text = text
-- Return the fmbox output.
return messageBox.main('fmbox', fmargs)
end
function p.addTrackingCategories()
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.
local ret = ''
local subpage = currentTitle.subpageText
if formatMessage('displayStrangeUsageCategory', 'boolean') and (subpage == formatMessage('docSubpage', 'string') or subpage == formatMessage('testcasesSubpage', 'string')) then
local sort = (currentTitle.namespace == 0 and formatMessage('strangeUsageCategoryMainspaceSort', 'string') or '') .. currentTitle.prefixedText -- Sort on namespace.
ret = ret .. makeCategoryLink(formatMessage('strangeUsageCategory', 'string'), sort)
end
return ret
end
function p.docspace()
-- Determines the namespace of the documentation.
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
-- Pages in the Article, File, MediaWiki or Category namespaces must have their
-- /doc, /sandbox and /testcases pages in talk space.
return mw.site.namespaces[subjectSpace].talk.name
else
return currentTitle.subjectNsText
end
end
function p.templatePage()
-- Determines the template page. No namespace or interwiki prefixes are included.
local subpage = currentTitle.subpageText
if subpage == formatMessage('sandboxSubpage', 'string') or subpage == formatMessage('testcasesSubpage', 'string') then
return currentTitle.baseText
else
return currentTitle.text
end
end
return p
