Editing Module:Documentation
Jump to navigation
Jump to search
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.
Latest revision | Your text | ||
Line 1: | Line 1: | ||
-- This module implements {{documentation}}. | -- This module implements {{documentation}}. | ||
-- Get required modules. | -- Get required modules. | ||
local getArgs = require('Module:Arguments').getArgs | local getArgs = require('Module:Arguments').getArgs | ||
local htmlBuilder = require('Module:HtmlBuilder') | |||
local messageBox = require('Module:Message box') | |||
-- Get the config table. | -- Get the config table. | ||
local cfg = mw.loadData('Module:Documentation/config') | local cfg = mw.loadData('Module:Documentation/config') | ||
local p = {} | local p = {} | ||
-- Often-used functions. | -- Often-used functions. | ||
local ugsub = mw.ustring.gsub | local ugsub = mw.ustring.gsub | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
-- Helper functions | -- Helper functions | ||
Line 18: | Line 20: | ||
-- table for testing purposes. | -- table for testing purposes. | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
local function message(cfgKey, valArray, expectType) | local function message(cfgKey, valArray, expectType) | ||
--[[ | --[[ | ||
Line 37: | Line 39: | ||
return msg | return msg | ||
end | end | ||
local function getMessageVal(match) | local function getMessageVal(match) | ||
match = tonumber(match) | match = tonumber(match) | ||
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4) | return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4) | ||
end | end | ||
local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal) | |||
return ret | |||
end | end | ||
p.message = message | p.message = message | ||
local function makeWikilink(page, display) | local function makeWikilink(page, display) | ||
if display then | if display then | ||
Line 55: | Line 58: | ||
end | end | ||
end | end | ||
p.makeWikilink = makeWikilink | p.makeWikilink = makeWikilink | ||
local function makeCategoryLink(cat, sort) | local function makeCategoryLink(cat, sort) | ||
local catns = mw.site.namespaces[14].name | local catns = mw.site.namespaces[14].name | ||
return makeWikilink(catns .. ':' .. cat, sort) | return makeWikilink(catns .. ':' .. cat, sort) | ||
end | end | ||
p.makeCategoryLink = makeCategoryLink | p.makeCategoryLink = makeCategoryLink | ||
local function makeUrlLink(url, display) | local function makeUrlLink(url, display) | ||
return mw.ustring.format('[%s %s]', url, display) | return mw.ustring.format('[%s %s]', url, display) | ||
end | end | ||
p.makeUrlLink = makeUrlLink | p.makeUrlLink = makeUrlLink | ||
local function makeToolbar(...) | local function makeToolbar(...) | ||
local ret = {} | local ret = {} | ||
Line 80: | Line 83: | ||
ret[#ret + 1] = select(i, ...) | ret[#ret + 1] = select(i, ...) | ||
end | end | ||
return '<small style="font-style: normal;">(' .. table.concat(ret, ' | ') .. ')</small>' | |||
return '< | |||
end | end | ||
p.makeToolbar = makeToolbar | p.makeToolbar = makeToolbar | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
-- Argument processing | -- Argument processing | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
local function makeInvokeFunc(funcName) | local function makeInvokeFunc(funcName) | ||
return function (frame) | return function (frame) | ||
Line 110: | Line 111: | ||
end | end | ||
end | end | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
-- | -- Main function | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
p.main = makeInvokeFunc('_main') | p.main = makeInvokeFunc('_main') | ||
function p._main(args) | function p._main(args) | ||
--[[ | --[[ | ||
-- This function defines logic flow for the module. | -- This function defines logic flow for the module. | ||
-- @args - table of arguments passed by the user | -- @args - table of arguments passed by the user | ||
-- | |||
-- Messages: | |||
-- 'main-div-id' --> 'template-documentation' | |||
-- 'main-div-classes' --> 'template-documentation iezoomfix' | |||
--]] | --]] | ||
local env = p.getEnvironment(args) | local env = p.getEnvironment(args) | ||
local root = | local root = htmlBuilder.create() | ||
root | root | ||
.wikitext(p.protectionTemplate(env)) | |||
.wikitext(p.sandboxNotice(args, env)) | |||
-- 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', message('main-div-id')) | |||
.addClass(message('main-div-classes')) | |||
.newline() | |||
.wikitext(p._startBox(args, env)) | |||
.wikitext(p._content(args, env)) | |||
.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, env)) | |||
.newline() | |||
.wikitext(p.addTrackingCategories(env)) | |||
return tostring(root) | |||
return | |||
end | end | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
-- Environment settings | -- Environment settings | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
function p.getEnvironment(args) | function p.getEnvironment(args) | ||
--[[ | --[[ | ||
-- Returns a table with information about the environment, including title | -- Returns a table with information about the environment, including title objects and other namespace- or | ||
-- path-related data. | |||
-- @args - table of arguments passed by the user | -- @args - table of arguments passed by the user | ||
-- | -- | ||
Line 177: | Line 167: | ||
-- env.sandboxTitle - the /sandbox subpage. | -- env.sandboxTitle - the /sandbox subpage. | ||
-- env.testcasesTitle - the /testcases subpage. | -- env.testcasesTitle - the /testcases subpage. | ||
-- env.printTitle - the print version of the template, located at the /Print subpage. | |||
-- | -- | ||
-- Data includes: | -- Data includes: | ||
Line 187: | Line 178: | ||
-- returned will be nil. | -- returned will be nil. | ||
--]] | --]] | ||
local env, envFuncs = {}, {} | local env, envFuncs = {}, {} | ||
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value | -- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value | ||
-- returned by that function is memoized in the env table so that we don't call any of the functions | -- returned by that function is memoized in the env table so that we don't call any of the functions | ||
Line 206: | Line 197: | ||
end | end | ||
}) | }) | ||
function envFuncs.title() | function envFuncs.title() | ||
-- The title object for the current page, or a test page passed with args.page. | -- The title object for the current page, or a test page passed with args.page. | ||
Line 218: | Line 209: | ||
return title | return title | ||
end | end | ||
function envFuncs.templateTitle() | function envFuncs.templateTitle() | ||
--[[ | --[[ | ||
Line 235: | Line 226: | ||
end | end | ||
end | end | ||
function envFuncs.docTitle() | function envFuncs.docTitle() | ||
--[[ | --[[ | ||
Line 252: | Line 243: | ||
return mw.title.new(docpage) | return mw.title.new(docpage) | ||
end | end | ||
function envFuncs.sandboxTitle() | function envFuncs.sandboxTitle() | ||
--[[ | --[[ | ||
Line 261: | Line 252: | ||
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage')) | return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage')) | ||
end | end | ||
function envFuncs.testcasesTitle() | function envFuncs.testcasesTitle() | ||
--[[ | --[[ | ||
Line 270: | Line 261: | ||
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage')) | return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage')) | ||
end | end | ||
function envFuncs.printTitle() | |||
--[[ | |||
-- Title object for the /Print subpage. | |||
-- Messages: | |||
-- 'print-subpage' --> 'Print' | |||
--]] | |||
return env.templateTitle:subPageTitle(message('print-subpage')) | |||
end | |||
function envFuncs.subjectSpace() | function envFuncs.subjectSpace() | ||
-- The subject namespace number. | -- The subject namespace number. | ||
return mw.site.namespaces[env.title.namespace].subject.id | return mw.site.namespaces[env.title.namespace].subject.id | ||
end | end | ||
function envFuncs.docSpace() | function envFuncs.docSpace() | ||
-- The documentation namespace number. For most namespaces this is the | -- The documentation namespace number. For most namespaces this is the same as the | ||
-- | -- subject namespace. However, pages in the Article, File, MediaWiki or Category | ||
-- | -- namespaces must have their /doc, /sandbox and /testcases pages in talk space. | ||
local subjectSpace = env.subjectSpace | local subjectSpace = env.subjectSpace | ||
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then | if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then | ||
Line 289: | Line 287: | ||
end | end | ||
end | end | ||
function envFuncs.docpageBase() | function envFuncs.docpageBase() | ||
-- The base page of the /doc, /sandbox, and /testcases subpages. | -- The base page of the /doc, /sandbox, and /testcases subpages. | ||
Line 299: | Line 297: | ||
return docSpaceText .. ':' .. templateTitle.text | return docSpaceText .. ':' .. templateTitle.text | ||
end | end | ||
function envFuncs.compareUrl() | function envFuncs.compareUrl() | ||
-- Diff link between the sandbox and the main template using [[Special:ComparePages]]. | -- Diff link between the sandbox and the main template using [[Special:ComparePages]]. | ||
Line 307: | Line 305: | ||
local compareUrl = mw.uri.fullUrl( | local compareUrl = mw.uri.fullUrl( | ||
'Special:ComparePages', | 'Special:ComparePages', | ||
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} | {page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} | ||
) | ) | ||
return tostring(compareUrl) | return tostring(compareUrl) | ||
Line 314: | Line 312: | ||
end | end | ||
end | end | ||
return env | return env | ||
end | end | ||
---------------------------------------------------------------------------- | |||
-- Auxiliary templates | |||
---------------------------------------------------------------------------- | |||
function p.sandboxNotice(args, env) | |||
--[=[ | |||
-- Generates a sandbox notice for display above sandbox pages. | |||
-- @args - a table of arguments passed by the user | |||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment | |||
-- | |||
-- Messages: | |||
-- 'sandbox-notice-image' --> '[[Image:Sandbox.png|50px|alt=|link=]]' | |||
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.' | |||
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).' | |||
-- 'sandbox-notice-pagetype-template' --> '[[Wikipedia:Template test cases|template sandbox]] page' | |||
-- 'sandbox-notice-pagetype-module' --> '[[Wikipedia:Template test cases|module sandbox]] page' | |||
-- 'sandbox-notice-pagetype-other' --> 'sandbox page' | |||
-- 'sandbox-notice-compare-link-display' --> 'diff' | |||
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.' | |||
-- 'sandbox-notice-testcases-link-display' --> 'test cases' | |||
-- 'sandbox-category' --> 'Template sandboxes' | |||
--]=] | |||
local title = env.title | |||
local sandboxTitle = env.sandboxTitle | |||
local templateTitle = env.templateTitle | |||
local subjectSpace = env.subjectSpace | |||
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then | |||
return nil | |||
end | |||
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text". | |||
local omargs = {} | |||
omargs.image = message('sandbox-notice-image') | |||
-- Get the text. We start with the opening blurb, which is something like | |||
-- "This is the template sandbox for [[Template:Foo]] (diff)." | |||
local text = '' | |||
local frame = mw.getCurrentFrame() | |||
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed. | |||
local pagetype | |||
if subjectSpace == 10 then | |||
pagetype = message('sandbox-notice-pagetype-template') | |||
elseif subjectSpace == 828 then | |||
pagetype = message('sandbox-notice-pagetype-module') | |||
else | |||
pagetype = message('sandbox-notice-pagetype-other') | |||
end | |||
local templateLink = makeWikilink(templateTitle.prefixedText) | |||
local compareUrl = env.compareUrl | |||
if isPreviewing or not compareUrl then | |||
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink}) | |||
else | |||
local compareDisplay = message('sandbox-notice-compare-link-display') | |||
local compareLink = makeUrlLink(compareUrl, compareDisplay) | |||
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink}) | |||
end | |||
-- Get the test cases page blurb if the page exists. This is something like | |||
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]." | |||
local testcasesTitle = env.testcasesTitle | |||
if testcasesTitle and testcasesTitle.exists then | |||
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') | |||
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay) | |||
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink}) | |||
end | |||
-- Add the sandbox to the sandbox category. | |||
text = text .. makeCategoryLink(message('sandbox-category')) | |||
omargs.text = text | |||
return messageBox.main('ombox', omargs) | |||
end | |||
function p.protectionTemplate(env) | |||
-- Generates the padlock icon in the top right. | |||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment | |||
-- Messages: | |||
-- 'protection-template' --> 'pp-template' | |||
-- 'protection-template-args' --> {docusage = 'yes'} | |||
local title = env.title | |||
local protectionTemplate = message('protection-template') | |||
local namespace = title.namespace | |||
if not (protectionTemplate and (namespace == 10 or namespace == 828)) then | |||
-- Don't display the protection template if we are not in the template or module namespaces. | |||
return nil | |||
end | |||
local frame = mw.getCurrentFrame() | |||
local function getProtectionLevel(protectionType, page) | |||
-- Gets the protection level for page, or for the current page if page is not specified. | |||
local level = frame:callParserFunction('PROTECTIONLEVEL', protectionType, page) | |||
if level ~= '' then | |||
return level | |||
else | |||
return nil -- The parser function returns the blank string if there is no match. | |||
end | |||
end | |||
local prefixedTitle = title.prefixedText | |||
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('protection-template-args', nil, 'table')} | |||
end | |||
return nil | |||
end | |||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
-- Start box | -- Start box | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
p.startBox = makeInvokeFunc('_startBox') | p.startBox = makeInvokeFunc('_startBox') | ||
function p._startBox(args, env) | function p._startBox(args, env) | ||
--[[ | --[[ | ||
Line 337: | Line 434: | ||
local links | local links | ||
local content = args.content | local content = args.content | ||
if not content | if not content then | ||
-- No need to include the links if the documentation is on the template page itself. | -- No need to include the links if the documentation is on the template page itself. | ||
local linksData = p.makeStartBoxLinksData(args, env) | local linksData = p.makeStartBoxLinksData(args, env) | ||
Line 353: | Line 450: | ||
end | end | ||
end | end | ||
function p.makeStartBoxLinksData(args, env) | function p.makeStartBoxLinksData(args, env) | ||
--[[ | --[[ | ||
Line 365: | Line 462: | ||
-- 'history-link-display' --> 'history' | -- 'history-link-display' --> 'history' | ||
-- 'purge-link-display' --> 'purge' | -- 'purge-link-display' --> 'purge' | ||
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace' | |||
-- 'module-preload' --> 'Template:Documentation/preload-module-doc' | -- 'module-preload' --> 'Template:Documentation/preload-module-doc' | ||
-- 'docpage-preload' --> 'Template:Documentation/preload' | -- 'docpage-preload' --> 'Template:Documentation/preload' | ||
Line 375: | Line 473: | ||
return nil | return nil | ||
end | end | ||
local data = {} | local data = {} | ||
data.title = title | data.title = title | ||
Line 390: | Line 485: | ||
local preload = args.preload | local preload = args.preload | ||
if not preload then | if not preload then | ||
if subjectSpace == 828 then -- Module namespace | if subjectSpace == 6 then -- File namespace | ||
preload = message('file-docpage-preload') | |||
elseif subjectSpace == 828 then -- Module namespace | |||
preload = message('module-preload') | preload = message('module-preload') | ||
else | else | ||
Line 400: | Line 497: | ||
return data | return data | ||
end | end | ||
function p.renderStartBoxLinks(data) | function p.renderStartBoxLinks(data) | ||
--[[ | --[[ | ||
-- Generates the [view][edit][history][purge] or [create | -- Generates the [view][edit][history][purge] or [create] links from the data table. | ||
-- @data - a table of data generated by p.makeStartBoxLinksData | -- @data - a table of data generated by p.makeStartBoxLinksData | ||
--]] | --]] | ||
local function escapeBrackets(s) | local function escapeBrackets(s) | ||
-- Escapes square brackets with HTML entities. | -- Escapes square brackets with HTML entities. | ||
Line 413: | Line 510: | ||
return s | return s | ||
end | end | ||
local ret | local ret | ||
local docTitle = data.docTitle | local docTitle = data.docTitle | ||
local title = data.title | local title = data.title | ||
if docTitle.exists then | if docTitle.exists then | ||
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay) | local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay) | ||
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay) | local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay) | ||
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay) | local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay) | ||
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay) | |||
ret = '[%s] [%s] [%s] [%s]' | ret = '[%s] [%s] [%s] [%s]' | ||
ret = escapeBrackets(ret) | ret = escapeBrackets(ret) | ||
Line 427: | Line 524: | ||
else | else | ||
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) | local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) | ||
ret = ' | ret = '[%s]' | ||
ret = escapeBrackets(ret) | ret = escapeBrackets(ret) | ||
ret = mw.ustring.format(ret, createLink | ret = mw.ustring.format(ret, createLink) | ||
end | end | ||
return ret | return ret | ||
end | end | ||
function p.makeStartBoxData(args, env, links) | function p.makeStartBoxData(args, env, links) | ||
--[=[ | --[=[ | ||
Line 442: | Line 539: | ||
-- | -- | ||
-- Messages: | -- Messages: | ||
-- 'documentation-icon-wikitext' --> '[[File: | -- 'documentation-icon-wikitext' --> '[[File:Template-info.png|50px|link=|alt=Documentation icon]]' | ||
-- 'template-namespace-heading' --> 'Template documentation' | -- 'template-namespace-heading' --> 'Template documentation' | ||
-- 'module-namespace-heading' --> 'Module documentation' | -- 'module-namespace-heading' --> 'Module documentation' | ||
-- 'file-namespace-heading' --> 'Summary' | -- 'file-namespace-heading' --> 'Summary' | ||
-- 'other-namespaces-heading' --> 'Documentation' | -- 'other-namespaces-heading' --> 'Documentation' | ||
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks' | |||
-- 'start-box-link-id' --> 'doc_editlinks' | |||
-- 'testcases-create-link-display' --> 'create' | -- 'testcases-create-link-display' --> 'create' | ||
--]=] | --]=] | ||
Line 456: | Line 555: | ||
end | end | ||
local data = {} | local data = {} | ||
-- Heading | -- Heading | ||
local heading = args.heading -- Blank values are not removed. | local heading = args.heading -- Blank values are not removed. | ||
Line 474: | Line 573: | ||
data.heading = message('other-namespaces-heading') | data.heading = message('other-namespaces-heading') | ||
end | end | ||
-- Heading CSS | -- Heading CSS | ||
local headingStyle = args['heading-style'] | local headingStyle = args['heading-style'] | ||
if headingStyle then | if headingStyle then | ||
data.headingStyleText = headingStyle | data.headingStyleText = headingStyle | ||
elseif subjectSpace == 10 then | |||
-- We are in the template or template talk namespaces. | |||
data.headingFontWeight = 'bold' | |||
data.headingFontSize = '125%' | |||
else | else | ||
data.headingFontSize = '150%' | |||
data. | |||
end | end | ||
-- Data for the [view][edit][history][purge] or [create] links. | -- Data for the [view][edit][history][purge] or [create] links. | ||
if links then | if links then | ||
data.linksClass = message('start-box-linkclasses') | |||
data. | data.linksId = message('start-box-link-id') | ||
data.links = links | data.links = links | ||
end | end | ||
return data | return data | ||
end | end | ||
function p.renderStartBox(data) | function p.renderStartBox(data) | ||
-- Renders the start box html. | -- Renders the start box html. | ||
-- @data - a table of data generated by p.makeStartBoxData. | -- @data - a table of data generated by p.makeStartBoxData. | ||
local sbox = | local sbox = htmlBuilder.create('div') | ||
sbox | sbox | ||
-- ' | .css('padding-bottom', '3px') | ||
.css('border-bottom', '1px solid #aaa') | |||
.css('margin-bottom', '1ex') | |||
.newline() | |||
.tag('span') | |||
.cssText(data.headingStyleText) | |||
.css('font-weight', data.headingFontWeight) | |||
.css('font-size', data.headingFontSize) | |||
.wikitext(data.heading) | |||
local links = data.links | local links = data.links | ||
if links then | if links then | ||
sbox | sbox.tag('span') | ||
.addClass(data.linksClass) | |||
.attr('id', data.linksId) | |||
.wikitext(links) | |||
end | end | ||
return tostring(sbox) | return tostring(sbox) | ||
end | end | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
-- Documentation content | -- Documentation content | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
p.content = makeInvokeFunc('_content') | p.content = makeInvokeFunc('_content') | ||
function p._content(args, env) | function p._content(args, env) | ||
-- Displays the documentation contents | -- Displays the documentation contents | ||
Line 531: | Line 634: | ||
local content = args.content | local content = args.content | ||
if not content and docTitle and docTitle.exists then | if not content and docTitle and docTitle.exists then | ||
local frame = mw.getCurrentFrame() | |||
content = frame:preprocess('{{ ' .. docTitle.prefixedText .. ' }}') | |||
end | end | ||
-- The line breaks below are necessary so that "=== Headings ===" at the start and end | -- The line breaks below are necessary so that "=== Headings ===" at the start and end | ||
Line 541: | Line 641: | ||
return '\n' .. (content or '') .. '\n' | return '\n' .. (content or '') .. '\n' | ||
end | end | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
-- End box | -- End box | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
p.endBox = makeInvokeFunc('_endBox') | p.endBox = makeInvokeFunc('_endBox') | ||
function p._endBox(args, env) | function p._endBox(args, env) | ||
--[=[ | --[=[ | ||
Line 566: | Line 654: | ||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment | -- @env - environment table containing title objects, etc., generated with p.getEnvironment | ||
-- | -- | ||
-- Messages: | |||
-- 'fmbox-id' --> 'documentation-meta-data' | |||
-- 'fmbox-style' --> 'background-color: #ecfcf4' | |||
-- 'fmbox-textstyle' --> 'font-style: italic' | |||
-- | |||
-- The HTML is generated by the {{fmbox}} template, courtesy of [[Module:Message box]]. | |||
--]=] | --]=] | ||
-- Get environment data. | -- Get environment data. | ||
env = env or p.getEnvironment(args) | env = env or p.getEnvironment(args) | ||
Line 575: | Line 669: | ||
return nil | return nil | ||
end | end | ||
-- Check whether we should output the end box at all. Add the end | -- 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 | -- box by default if the documentation exists or if we are in the | ||
Line 590: | Line 684: | ||
return nil | return nil | ||
end | end | ||
-- Assemble the | -- Assemble the arguments for {{fmbox}}. | ||
local fmargs = {} | |||
fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data' | |||
fmargs.image = 'none' | |||
fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4' | |||
fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;' | |||
-- Assemble the fmbox text field. | |||
local text = '' | local text = '' | ||
if linkBox then | if linkBox then | ||
Line 601: | Line 702: | ||
-- Add sandbox and testcases links. | -- Add sandbox and testcases links. | ||
-- "Editors can experiment in this template's sandbox and testcases pages." | -- "Editors can experiment in this template's sandbox and testcases pages." | ||
text = text .. | text = text .. p.makeExperimentBlurb(args, env) | ||
text = text .. '<br />' | |||
if not args.content and not args[1] then | if not args.content and not args[1] then | ||
-- "Please add categories to the /doc subpage." | -- "Please add categories to the /doc subpage." | ||
Line 609: | Line 711: | ||
end | end | ||
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template" | text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template" | ||
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates. | |||
if printBlurb then | |||
text = text .. '<br />' .. printBlurb | |||
end | |||
end | end | ||
end | end | ||
fmargs.text = text | |||
return messageBox.main('fmbox', fmargs) | |||
end | end | ||
function p.makeDocPageBlurb(args, env) | function p.makeDocPageBlurb(args, env) | ||
--[=[ | --[=[ | ||
Line 635: | Line 733: | ||
-- 'transcluded-from-blurb' --> | -- 'transcluded-from-blurb' --> | ||
-- 'The above [[Wikipedia:Template documentation|documentation]] | -- 'The above [[Wikipedia:Template documentation|documentation]] | ||
-- is [[ | -- is [[Wikipedia:Transclusion|transcluded]] from $1.' | ||
-- 'module-preload' --> 'Template:Documentation/preload-module-doc' | -- 'module-preload' --> 'Template:Documentation/preload-module-doc' | ||
-- 'create-link-display' --> 'create' | -- 'create-link-display' --> 'create' | ||
Line 669: | Line 767: | ||
return ret | return ret | ||
end | end | ||
function p.makeExperimentBlurb(args, env) | function p.makeExperimentBlurb(args, env) | ||
--[[ | --[[ | ||
Line 685: | Line 783: | ||
-- 'mirror-edit-summary' --> 'Create sandbox version of $1' | -- 'mirror-edit-summary' --> 'Create sandbox version of $1' | ||
-- 'mirror-link-display' --> 'mirror' | -- 'mirror-link-display' --> 'mirror' | ||
-- 'sandbox-link-display' --> 'sandbox' | -- 'sandbox-link-display' --> 'sandbox' | ||
-- 'testcases-link-display' --> 'testcases' | -- 'testcases-link-display' --> 'testcases' | ||
-- 'testcases-edit-link-display'--> 'edit' | -- 'testcases-edit-link-display'--> 'edit' | ||
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases' | |||
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' | -- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox' | ||
-- 'testcases-create-link-display' --> 'create' | -- 'testcases-create-link-display' --> 'create' | ||
Line 733: | Line 831: | ||
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay) | local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay) | ||
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)}) | local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)}) | ||
local | local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary} | ||
local mirrorDisplay = message('mirror-link-display') | local mirrorDisplay = message('mirror-link-display') | ||
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay) | local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay) | ||
Line 749: | Line 843: | ||
local testcasesEditDisplay = message('testcases-edit-link-display') | local testcasesEditDisplay = message('testcases-edit-link-display') | ||
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay) | local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay) | ||
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink) | |||
else | else | ||
local testcasesPreload | local testcasesPreload | ||
Line 777: | Line 864: | ||
return message(messageName, {sandboxLinks, testcasesLinks}) | return message(messageName, {sandboxLinks, testcasesLinks}) | ||
end | end | ||
function p.makeCategoriesBlurb(args, env) | function p.makeCategoriesBlurb(args, env) | ||
--[[ | --[[ | ||
Line 794: | Line 881: | ||
return message('add-categories-blurb', {docPathLink}) | return message('add-categories-blurb', {docPathLink}) | ||
end | end | ||
function p.makeSubpagesBlurb(args, env) | function p.makeSubpagesBlurb(args, env) | ||
--[[ | --[[ | ||
Line 800: | Line 887: | ||
-- @args - a table of arguments passed by the user | -- @args - a table of arguments passed by the user | ||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment | -- @env - environment table containing title objects, etc., generated with p.getEnvironment | ||
-- Messages: | -- Messages: | ||
-- 'template-pagetype' --> 'template' | -- 'template-pagetype' --> 'template' | ||
Line 826: | Line 913: | ||
return message('subpages-blurb', {subpagesLink}) | return message('subpages-blurb', {subpagesLink}) | ||
end | end | ||
function p.makePrintBlurb(args, env) | |||
--[=[ | |||
-- Generates the blurb displayed when there is a print version of the template available. | |||
-- @args - a table of arguments passed by the user | |||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment | |||
-- | |||
-- Messages: | |||
-- 'print-link-display' --> '/Print' | |||
-- 'print-blurb' --> 'A [[Help:Books/for experts#Improving the book layout|print version]]' | |||
-- .. ' of this template exists at $1.' | |||
-- .. ' If you make a change to this template, please update the print version as well.' | |||
-- 'display-print-category' --> true | |||
-- 'print-category' --> 'Templates with print versions' | |||
--]=] | |||
local printTitle = env.printTitle | |||
if not printTitle then | |||
return nil | |||
end | |||
local ret | |||
if printTitle.exists then | |||
local printLink = makeWikilink(printTitle.prefixedText, message('print-link-display')) | |||
ret = message('print-blurb', {printLink}) | |||
local displayPrintCategory = message('display-print-category', nil, 'boolean') | |||
if displayPrintCategory then | |||
ret = ret .. makeCategoryLink(message('print-category')) | |||
end | |||
end | |||
return ret | |||
end | |||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
-- Tracking categories | -- Tracking categories | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
function p.addTrackingCategories(env) | function p.addTrackingCategories(env) | ||
--[[ | --[[ | ||
-- Check if {{documentation}} is transcluded on a /doc or /testcases page. | -- Check if {{documentation}} is transcluded on a /doc or /testcases page. | ||
-- @env - environment table containing title objects, etc., generated with p.getEnvironment | -- @env - environment table containing title objects, etc., generated with p.getEnvironment | ||
-- Messages: | -- Messages: | ||
-- 'display-strange-usage-category' --> true | -- 'display-strange-usage-category' --> true | ||
Line 862: | Line 979: | ||
return ret | return ret | ||
end | end | ||
return p | return p |