Module:Documentation

    From Nonbinary Wiki
    Revision as of 19:17, 1 January 2014 by m>Mr. Stradivarius (make the formatMessage error message more informative, at the risk of including long cfg messages in the error message)

    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')
    local libraryUtil = require('libraryUtil')
    
    -- 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
    local checkType = libraryUtil.checkType
    
    ----------------------------------------------------------------------------
    -- Helper functions
    ----------------------------------------------------------------------------
    
    local function formatMessage(msg, valArray)
    	--[[
    	-- Formats a message, usually from the cfg table.
    	-- Values from valArray can be specified in the message by using $1 for [1], $2 for [2], etc.
    	-- So formatMessage('Foo $2 bar $1.', {'baz', 'qux'}) will return "Foo qux bar baz."
    	--]]
    	checkType('formatMessage', 1, msg, 'string')
    	checkType('formatMessage', 2, valArray, 'table')
    
    	local function getMessageVal(match)
    		match = tonumber(match)
    		return valArray[match] or error('formatMessage: No value found for key $' .. match .. '. Message was "' .. msg .. '"', 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, ' &#124; ') .. ')</small>'
    end	
    
    ----------------------------------------------------------------------------
    -- Argument processing
    ----------------------------------------------------------------------------
    
    local function makeInvokeFunc(funcName)
    	return function (frame)
    		local headingArg = cfg.headingArg
    		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', cfg.mainDivId)
    			.addClass(cfg.mainDivClasses)
    			.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.
    				.done()
    			.done()
    		.wikitext(p._endBox(args))
    		.wikitext(p.addTrackingCategories())
    	return tostring(root)
    end
    
    function p.sandboxNotice(args)
    	local sandboxNoticeTemplate = cfg.sandboxNoticeTemplate
    	if not (sandboxNoticeTemplate and currentTitle.subpageText == cfg.sandboxSubpage) 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 = {[cfg.sandboxNoticeLivepageParam] = args[cfg.livepageArg]}})
    	return tostring(notice)
    end
    
    function p.protectionTemplate()
    	local protectionTemplate = cfg.protectionTemplate
    	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 = cfg.protectionTemplateArgs}
    	end
    	return nil
    end
    
    p.startBox = makeInvokeFunc('_startBox')
    
    function p._startBox(args)
    	-- Arg processing from {{documentation}}.
    	local preload = args[cfg.preloadArg] -- Allow custom preloads.
    	local heading = args[cfg.headingArg] -- Blank values are not removed.
    	local headingStyle = args[cfg.headingStyleArg]
    	local content = args[cfg.contentArg]
    	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 .. '/' .. cfg.docSubpage
    	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')
    
    	-- 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(cfg.documentationIconWikitext .. ' ' .. cfg.templateNamespaceHeading)
    	elseif subjectSpace == 828 then -- Module namespace
    		hspan.wikitext(cfg.documentationIconWikitext .. ' ' .. cfg.moduleNamespaceHeading)
    	elseif subjectSpace == 6 then -- File namespace
    		hspan.wikitext(cfg.fileNamespaceHeading)
    	else
    		hspan.wikitext(cfg.otherNamespaceHeading)
    	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(cfg.startBoxLinkclasses)
    			.attr('id', cfg.startBoxLinkId)
    		if docExist then
    			local viewLink = makeWikilink(docpage, cfg.viewLinkDisplay)
    			local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, cfg.editLinkDisplay)
    			local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, cfg.historyLinkDisplay)
    			local purgeLink = makeUrlLink(currentTitle:fullUrl{action = 'purge'}, cfg.purgeLinkDisplay)
    			local text = '[%s] [%s] [%s] [%s]'
    			text = text:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.
    			text = text:gsub('%]', '&#93;')
    			lspan.wikitext(mw.ustring.format(text, viewLink, editLink, historyLink, purgeLink))
    		else
    			if not preload then
    				if subjectSpace == 6 then -- File namespace
    					preload = cfg.fileDocpagePreload
    				else
    					preload = cfg.docpagePreload
    				end
    			end
    			lspan.wikitext(makeUrlLink(docTitle:fullUrl{action = 'edit', preload = preload}, cfg.createLinkDisplay))
    		end
    	end
    
    	return tostring(sbox)
    end
    
    p.content = makeInvokeFunc('_content')
    
    function p._content(args)
    	local content = args[cfg.contentArg]
    	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() .. '/' .. cfg.docSubpage
    			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[cfg.contentArg]
    	local linkBox = args[cfg.linkBoxArg] -- 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 .. '/' .. cfg.docSubpage
    	end
    	local docTitle = mw.title.new(docpage)
    	local docExist = docTitle.exists
    	local docnameFed = args[1] and true
    	local sandbox = docpageRoot .. '/' .. cfg.sandboxSubpage
    	local testcases = docpageRoot .. '/' .. cfg.testcasesSubpage
    	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 == cfg.linkBoxOff or not (docExist or subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10) then
    		return nil
    	end
    
    	-- Assemble the arguments for {{fmbox}}.
    	local fmargs = {}
    	fmargs[cfg.fmboxIdParam] = cfg.fmboxId -- Sets fmargs.id = 'documentation-meta-data'
    	fmargs[cfg.fmboxImageParam] = cfg.fmboxImageNone -- Sets fmargs.image = 'none'
    	fmargs[cfg.fmboxStyleParam] = cfg.fmboxStyle -- Sets fmargs.style = 'background-color: #ecfcf4'
    	fmargs[cfg.fmboxTextstyleParam] = cfg.fmboxTextstyle -- 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'}, cfg.editLinkDisplay)
    			local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, cfg.historyLinkDisplay)
    			text = text .. formatMessage(cfg.transcludedFromBlurb, {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 = cfg.modulePreload}, cfg.createLinkDisplay)
    			text = text .. formatMessage(cfg.createModuleDocBlurb, {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 cfg.modulePossessive or cfg.templatePossessive
    			local sandboxTitle = mw.title.new(sandbox)
    			if sandboxTitle.exists then
    				local sandboxLink = makeWikilink(sandbox, cfg.sandboxLinkDisplay)
    				local sandboxEditLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit'}, cfg.sandboxEditLinkDisplay)
    				local compareLink = makeUrlLink(mw.title.new('Special:ComparePages'):fullUrl{page1 = templatePage, page2 = sandbox}, cfg.compareLinkDisplay)
    				sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
    			else
    				local sandboxPreload = subjectSpace == 828 and cfg.moduleSandboxPreload or cfg.templateSandboxPreload
    				local sandboxCreateLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}, cfg.sandboxCreateLinkDisplay)
    				local mirrorSummary = formatMessage(cfg.mirrorEditSummary, {makeWikilink(templatePage)})
    				local mirrorLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}, cfg.mirrorLinkDisplay)
    				sandboxLinks = cfg.sandboxLinkDisplay .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
    			end
    			local testcaseTitle = mw.title.new(testcases)
    			if testcaseTitle.exists then
    				local testcasesLink = makeWikilink(testcases, cfg.testcasesLinkDisplay)
    				local testcasesEditLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit'}, cfg.testcasesEditLinkDisplay)
    				testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
    			else
    				local testcasesPreload = subjectSpace == 828 and cfg.moduleTestcasesPreload or cfg.templateTestcasesPreload
    				local testcasesCreateLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit', preload = testcasesPreload}, cfg.testcasesCreateLinkDisplay)
    				testcasesLinks = cfg.testcasesLinkDisplay .. ' ' .. makeToolbar(testcasesCreateLink)
    			end
    			text = text .. formatMessage(cfg.experimentBlurb, {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, cfg.docLinkDisplay)
    				text = text .. formatMessage(cfg.addCategoriesBlurb, {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 = cfg.templatePagetype
    				elseif subjectSpace == 828 then
    					pagetype = cfg.modulePagetype
    				else
    					pagetype = cfg.defaultPagetype
    				end
    				text = text .. ' ' .. makeWikilink('Special:PrefixIndex/' .. templatePage .. '/', formatMessage(cfg.subpagesLinkDisplay, {pagetype}))
    			end
    			-- Show the "print" link if it exists.
    			local printPage = templatePage .. '/' .. cfg.printSubpage
    			local printTitle = mw.title.new(printPage)
    			if printTitle.exists then
    				local printLink = makeWikilink(printPage, cfg.printLinkDisplay)
    				text = text .. '<br />' .. formatMessage(cfg.printBlurb, {printLink})
    					.. (cfg.displayPrintCategory and makeCategoryLink(cfg.printCategory) 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 cfg.displayStrangeUsageCategory and (subpage == cfg.docSubpage or subpage == cfg.testcasesSubpage) then
    		local sort = (currentTitle.namespace == 0 and cfg.strangeUsageCategoryMainspaceSort or '') .. currentTitle.prefixedText -- Sort on namespace.
    		ret = ret .. makeCategoryLink(cfg.strangeUsageCategory, 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 == cfg.sandboxSubpage or subpage == cfg.testcasesSubpage then
    		return currentTitle.baseText
    	else
    		return currentTitle.text
    	end
    end
    
    return p