Difference between revisions of "Module:Documentation"
Jump to navigation
Jump to search
m |
m |
||
Line 8: | Line 8: | ||
local contentParam = args['content'] | local contentParam = args['content'] | ||
local linkBoxParam = args['link box'] | local linkBoxParam = args['link box'] | ||
− | local docPageName, docPageTitle | + | local currentTitle, docPageName, docPageTitle |
if not contentParam then | if not contentParam then | ||
− | docPageName = args[1] or ((args['page'] or | + | currentTitle = mw.title.getCurrentTitle() |
+ | docPageName = args[1] or ((args['page'] or currentTitle.fullText) .. '/doc') | ||
docPageTitle = mw.title.new(docPageName) -- Expensive | docPageTitle = mw.title.new(docPageName) -- Expensive | ||
end | end | ||
Line 50: | Line 51: | ||
local editLink = '[' .. docPageTitle:fullUrl{action = 'edit'} .. ' edit]' | local editLink = '[' .. docPageTitle:fullUrl{action = 'edit'} .. ' edit]' | ||
local historyLink = '[' .. docPageTitle:fullUrl{action = 'history'} .. ' history]' | local historyLink = '[' .. docPageTitle:fullUrl{action = 'history'} .. ' history]' | ||
− | local purgeLink = '[' .. | + | local purgeLink = '[' .. currentTitle:fullUrl{action = 'purge'} .. ' purge]' |
actionsSpan:wikitext(mw.ustring.format(escapeBrackets('[%s] [%s] [%s] [%s]'), viewLink, editLink, historyLink, purgeLink)) | actionsSpan:wikitext(mw.ustring.format(escapeBrackets('[%s] [%s] [%s] [%s]'), viewLink, editLink, historyLink, purgeLink)) | ||
else | else |
Revision as of 05:19, 10 May 2017
local p = {}
local HtmlBuilder = require('Module:HtmlBuilder') local makeInvokeFunc = require('Module:Arguments').makeInvokeFunc
function p._main(frame, args)
local headingParam = args['heading'] local contentParam = args['content'] local linkBoxParam = args['link box'] local currentTitle, docPageName, docPageTitle if not contentParam then currentTitle = mw.title.getCurrentTitle() docPageName = args[1] or ((args['page'] or currentTitle.fullText) .. '/doc') docPageTitle = mw.title.new(docPageName) -- Expensive end
local root = HtmlBuilder.create()
local startBox = root:tag('div') startBox:cssText('clear: both; margin: 1em 0 0 0; border: 1px solid #aaa; background-color: #ecfcf4; padding: 12px')
-- Add heading if non-empty if headingParam ~= then local headingDiv = startBox:tag('div') headingDiv:cssText('padding-bottom: 3px; border-bottom: 1px solid #aaa; margin-bottom: 1ex')
local headingSpan = headingDiv:tag('span') headingSpan:cssText('font-weight: bold; font-size: 125%') if headingParam then headingSpan:wikitext(headingParam) else headingSpan:wikitext(' Documentation') end
-- Add action links if doc is not on template page if not contentParam then local actionsSpan = headingDiv:tag('span') actionsSpan:addClass('plainlinks') actionsSpan:cssText('font-size: small; font-weight: 400; margin-left: 1em; vertical-align: baseline; line-height: 1em; display: inline-block')
local function escapeBrackets(s) -- Replace brackets with HTML entities s = s:gsub('%[', '[') s = s:gsub('%]', ']') return s end
if docPageTitle.exists then format = '[%s] [%s] [%s] [%s]' local viewLink = 'view' local editLink = '[' .. docPageTitle:fullUrl{action = 'edit'} .. ' edit]' local historyLink = '[' .. docPageTitle:fullUrl{action = 'history'} .. ' history]' local purgeLink = '[' .. currentTitle:fullUrl{action = 'purge'} .. ' purge]' actionsSpan:wikitext(mw.ustring.format(escapeBrackets('[%s] [%s] [%s] [%s]'), viewLink, editLink, historyLink, purgeLink)) else local createLink = '[' .. docPageTitle:fullUrl{action = 'edit'} .. ' create]' actionsSpan:wikitext(mw.ustring.format(escapeBrackets('[%s]'), createLink)) end end end
-- Transclude doc contents local content = contentParam if not content and docPageTitle.exists then content = frame:expandTemplate{title = ':' .. docPageName} end if content then -- Add line breaks so headings at start and end are interpreted correctly startBox:wikitext('\n' .. content .. '\n') end
-- Prevent floating items from sticking out of doc box local clear = startBox:tag('div') clear:css('clear', 'both')
if not contentParam and linkBoxParam ~= 'off' and docPageTitle.exists then local endBox = root:tag('div') endBox:addClass('plainlinks') endBox:cssText('clear: both; width: 100%; border: 1px solid #aaa; margin: .2em 0; background-color: #ecfcf4')
local endBoxNode = endBox:tag('div') endBoxNode:cssText('border: none; width: 100%; padding: .25em .9em; font-style: italic') if linkBoxParam then endBoxNode:wikitext(linkBoxParam) else endBoxNode:wikitext('The above documentation is transcluded from ', docPageName, '. ')
local editUrl = docPageTitle:fullUrl{action = 'edit'} local historyUrl = docPageTitle:fullUrl{action = 'history'} local actionsNode = endBoxNode:tag('small') actionsNode:cssText('font-style: normal') actionsNode:wikitext('([', editUrl, ' edit] | [', historyUrl, ' history])') end end
return tostring(root)
end
p.main = makeInvokeFunc(p._main, {passFrameParam = true, inherited = true})
return p