Editing Documentation
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 3: | Line 3: | ||
-- 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') | local messageBox = require('Module:Message box') | ||
| Line 27: | Line 28: | ||
-- If the table valArray is present, strings such as $1, $2 etc. in the | -- 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. | -- message are substituted with values from the table keys [1], [2] etc. | ||
| − | -- For example, if the message | + | -- For example, if the message cfg.fooMessage had the value 'Foo $2 bar $1.', |
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz." | -- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz." | ||
--]] | --]] | ||
| Line 118: | Line 119: | ||
function p._main(args) | function p._main(args) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
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 | -- This div tag is from {{documentation/start box}}, but moving it here | ||
-- so that we don't have to worry about unclosed tags. | -- 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 tostring(root) | ||
end | end | ||
| Line 157: | Line 151: | ||
-- Returns a table with information about the environment, including title objects and other namespace- or | -- Returns a table with information about the environment, including title objects and other namespace- or | ||
-- path-related data. | -- path-related data. | ||
| − | |||
-- | -- | ||
-- Title objects include: | -- Title objects include: | ||
| Line 168: | Line 161: | ||
-- | -- | ||
-- Data includes: | -- Data includes: | ||
| − | |||
-- env.subjectSpace - the number of the title's subject namespace. | -- env.subjectSpace - the number of the title's subject namespace. | ||
-- env.docSpace - the number of the namespace the title puts its documentation in. | -- env.docSpace - the number of the namespace the title puts its documentation in. | ||
| − | -- env. | + | -- env.docpageRoot - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace. |
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template. | -- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template. | ||
-- | -- | ||
| Line 203: | Line 195: | ||
if titleArg then | if titleArg then | ||
title = mw.title.new(titleArg) | title = mw.title.new(titleArg) | ||
| + | if not title then | ||
| + | error(message('title-arg-error', {titleArg})) | ||
| + | end | ||
else | else | ||
title = mw.title.getCurrentTitle() | title = mw.title.getCurrentTitle() | ||
| Line 210: | Line 205: | ||
function envFuncs.templateTitle() | function envFuncs.templateTitle() | ||
| − | |||
-- The template (or module, etc.) title object. | -- The template (or module, etc.) title object. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local title = env.title | local title = env.title | ||
local subpage = title.subpageText | local subpage = title.subpageText | ||
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then | if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then | ||
| − | return | + | return title.basePageTitle |
else | else | ||
| − | return | + | return title |
end | end | ||
end | end | ||
function envFuncs.docTitle() | function envFuncs.docTitle() | ||
| − | |||
-- Title object of the /doc subpage. | -- Title object of the /doc subpage. | ||
| − | |||
| − | |||
| − | |||
local title = env.title | local title = env.title | ||
local docname = args[1] -- User-specified doc page. | local docname = args[1] -- User-specified doc page. | ||
| Line 238: | Line 223: | ||
docpage = docname | docpage = docname | ||
else | else | ||
| − | docpage = env. | + | docpage = env.docpageRoot .. '/' .. message('doc-subpage') |
end | end | ||
return mw.title.new(docpage) | return mw.title.new(docpage) | ||
| Line 244: | Line 229: | ||
function envFuncs.sandboxTitle() | function envFuncs.sandboxTitle() | ||
| − | |||
-- Title object for the /sandbox subpage. | -- Title object for the /sandbox subpage. | ||
| − | + | return mw.title.new(env.docpageRoot .. '/' .. message('sandbox-subpage')) | |
| − | |||
| − | |||
| − | return mw.title.new(env. | ||
end | end | ||
function envFuncs.testcasesTitle() | function envFuncs.testcasesTitle() | ||
| − | |||
-- Title object for the /testcases subpage. | -- Title object for the /testcases subpage. | ||
| − | + | return mw.title.new(env.docpageRoot .. '/' .. message('testcases-subpage')) | |
| − | |||
| − | |||
| − | return mw.title.new(env. | ||
end | end | ||
function envFuncs.printTitle() | function envFuncs.printTitle() | ||
| − | |||
-- Title object for the /Print subpage. | -- Title object for the /Print subpage. | ||
| − | |||
| − | |||
| − | |||
return env.templateTitle:subPageTitle(message('print-subpage')) | return env.templateTitle:subPageTitle(message('print-subpage')) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
end | end | ||
| Line 292: | Line 260: | ||
end | end | ||
| − | function envFuncs. | + | function envFuncs.docpageRoot() |
-- The base page of the /doc, /sandbox, and /testcases subpages. | -- The base page of the /doc, /sandbox, and /testcases subpages. | ||
-- For some namespaces this is the talk page, rather than the template page. | -- For some namespaces this is the talk page, rather than the template page. | ||
| Line 306: | Line 274: | ||
local templateTitle = env.templateTitle | local templateTitle = env.templateTitle | ||
local sandboxTitle = env.sandboxTitle | local sandboxTitle = env.sandboxTitle | ||
| − | + | local compareUrl = mw.uri.fullUrl( | |
| − | + | 'Special:ComparePages', | |
| − | + | {page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} | |
| − | + | ) | |
| − | + | return tostring(compareUrl) | |
| − | |||
| − | |||
| − | |||
| − | |||
end | end | ||
| Line 325: | Line 289: | ||
function p.sandboxNotice(args, env) | function p.sandboxNotice(args, env) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local title = env.title | local title = env.title | ||
local sandboxTitle = env.sandboxTitle | local sandboxTitle = env.sandboxTitle | ||
local templateTitle = env.templateTitle | local templateTitle = env.templateTitle | ||
| − | + | if not (title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then | |
| − | if not ( | ||
return nil | return nil | ||
end | end | ||
| − | -- | + | local omargs = {} -- Args for {{ombox}}. |
| − | + | -- Get the image wikitext. | |
omargs.image = message('sandbox-notice-image') | omargs.image = message('sandbox-notice-image') | ||
-- Get the text. We start with the opening blurb, which is something like | -- Get the text. We start with the opening blurb, which is something like | ||
-- "This is the template sandbox for [[Template:Foo]] (diff)." | -- "This is the template sandbox for [[Template:Foo]] (diff)." | ||
local text = '' | local text = '' | ||
| − | local | + | local frame = mw.getCurrentFrame() |
| − | + | local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local templateLink = makeWikilink(templateTitle.prefixedText) | local templateLink = makeWikilink(templateTitle.prefixedText) | ||
local compareUrl = env.compareUrl | local compareUrl = env.compareUrl | ||
| − | if compareUrl then | + | if isPreviewing or not compareUrl then |
| + | -- 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.' | ||
| + | text = text .. message('sandbox-notice-blurb', {templateLink}) | ||
| + | else | ||
| + | -- 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).' | ||
local compareDisplay = message('sandbox-notice-compare-link-display') | local compareDisplay = message('sandbox-notice-compare-link-display') | ||
local compareLink = makeUrlLink(compareUrl, compareDisplay) | local compareLink = makeUrlLink(compareUrl, compareDisplay) | ||
| − | text = text .. message('sandbox-notice-diff-blurb', { | + | text = text .. message('sandbox-notice-diff-blurb', {templateLink, compareLink}) |
| − | |||
| − | |||
end | end | ||
| − | -- Get the test cases page blurb if the page exists. | + | -- Get the test cases page blurb if the page exists. |
| − | |||
local testcasesTitle = env.testcasesTitle | local testcasesTitle = env.testcasesTitle | ||
if testcasesTitle and testcasesTitle.exists then | 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 | end | ||
| − | -- Add the | + | -- Add the page to [[Category:Template sandboxes]]. |
text = text .. makeCategoryLink(message('sandbox-category')) | text = text .. makeCategoryLink(message('sandbox-category')) | ||
omargs.text = text | omargs.text = text | ||
| − | + | return messageBox.main('ombox', omargs) | |
| − | |||
| − | |||
end | end | ||
function p.protectionTemplate(env) | function p.protectionTemplate(env) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local title = env.title | local title = env.title | ||
| − | + | local protectionTemplate = message('protection-template') | |
| − | if not | + | if not (protectionTemplate and title.namespace == 10) then |
| + | -- Don't display the protection template if we are not in the template namespace. | ||
return nil | return nil | ||
end | end | ||
| − | local | + | local frame = mw.getCurrentFrame() |
| − | local | + | 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 | |
| − | return | + | else |
| − | + | return nil -- The parser function returns the blank string if there is no match. | |
| − | -- The page is move | + | 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 | end | ||
| + | return nil | ||
end | end | ||
| Line 433: | Line 359: | ||
function p._startBox(args, env) | function p._startBox(args, env) | ||
| − | -- | + | -- Generate [view][edit][history][purge] or [create] links. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local links | local links | ||
local content = args.content | local content = args.content | ||
| Line 463: | Line 380: | ||
function p.makeStartBoxLinksData(args, env) | function p.makeStartBoxLinksData(args, env) | ||
| − | + | local data = {} | |
| − | + | -- Get title objects. | |
| − | -- | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local title = env.title | local title = env.title | ||
local docTitle = env.docTitle | local docTitle = env.docTitle | ||
| Line 484: | Line 387: | ||
return nil | return nil | ||
end | end | ||
| − | |||
| − | |||
data.title = title | data.title = title | ||
data.docTitle = docTitle | data.docTitle = docTitle | ||
| Line 496: | Line 397: | ||
local preload = args.preload | local preload = args.preload | ||
if not preload then | if not preload then | ||
| − | if subjectSpace == 6 then -- File namespace | + | if env.subjectSpace == 6 then -- File namespace |
preload = message('file-docpage-preload') | preload = message('file-docpage-preload') | ||
| − | |||
| − | |||
else | else | ||
preload = message('docpage-preload') | preload = message('docpage-preload') | ||
| Line 510: | Line 409: | ||
function p.renderStartBoxLinks(data) | function p.renderStartBoxLinks(data) | ||
| − | -- | + | -- Render the [view][edit][history][purge] or [create] links. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local ret | local ret | ||
local docTitle = data.docTitle | local docTitle = data.docTitle | ||
| Line 531: | Line 419: | ||
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay) | local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay) | ||
ret = '[%s] [%s] [%s] [%s]' | ret = '[%s] [%s] [%s] [%s]' | ||
| − | ret = | + | ret = ret:gsub('%[', '[') -- Replace square brackets with HTML entities. |
| + | ret = ret:gsub('%]', ']') | ||
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink) | ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink) | ||
else | else | ||
| − | + | ret = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) | |
| − | |||
| − | |||
| − | |||
end | end | ||
| − | |||
end | end | ||
function p.makeStartBoxData(args, env, links) | function p.makeStartBoxData(args, env, links) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local subjectSpace = env.subjectSpace | local subjectSpace = env.subjectSpace | ||
if not subjectSpace then | if not subjectSpace then | ||
| Line 597: | Line 466: | ||
end | end | ||
| − | -- | + | -- [view][edit][history][purge] or [create] links. |
if links then | if links then | ||
data.linksClass = message('start-box-linkclasses') | data.linksClass = message('start-box-linkclasses') | ||
| Line 609: | Line 478: | ||
function p.renderStartBox(data) | function p.renderStartBox(data) | ||
-- Renders the start box html. | -- Renders the start box html. | ||
| − | + | local sbox = htmlBuilder.create('div') | |
| − | local sbox = | ||
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) | ||
| Line 638: | Line 506: | ||
function p._content(args, env) | function p._content(args, env) | ||
| − | |||
| − | |||
| − | |||
| − | |||
local docTitle = env.docTitle | local docTitle = env.docTitle | ||
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 | ||
-- of docs are interpreted correctly. | -- of docs are interpreted correctly. | ||
return '\n' .. (content or '') .. '\n' | return '\n' .. (content or '') .. '\n' | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
end | end | ||
| Line 671: | Line 524: | ||
function p._endBox(args, env) | function p._endBox(args, env) | ||
| − | |||
-- This function generates the end box (also known as the link box). | -- This function generates the end box (also known as the link box). | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
-- Get environment data. | -- Get environment data. | ||
| − | |||
local subjectSpace = env.subjectSpace | local subjectSpace = env.subjectSpace | ||
local docTitle = env.docTitle | local docTitle = env.docTitle | ||
| Line 695: | Line 536: | ||
-- 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 | ||
-- user, module or template namespaces. | -- user, module or template namespaces. | ||
| − | |||
if linkBox == 'off' | if linkBox == 'off' | ||
or not ( | or not ( | ||
| Line 710: | Line 550: | ||
local fmargs = {} | local fmargs = {} | ||
fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data' | fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data' | ||
| − | fmargs.image = 'none' | + | fmargs.image = message('fmbox-image-none') -- Sets 'none' |
fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4' | fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4' | ||
fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;' | fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;' | ||
| Line 717: | Line 557: | ||
local text = '' | local text = '' | ||
if linkBox then | if linkBox then | ||
| + | -- Use custom link box content if it is defined. | ||
text = text .. linkBox | text = text .. linkBox | ||
else | else | ||
| − | text = text .. (p.makeDocPageBlurb(args, env) or '') -- | + | text = text .. (p.makeDocPageBlurb(args, env) or '') |
| − | if subjectSpace == 2 or subjectSpace == | + | -- Add links to /sandbox and /testcases when appropriate. |
| − | -- We are in the user, template | + | if subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10 then |
| − | + | -- We are in the user, module or template namespaces. | |
| − | + | text = text .. p.makeEndBoxExperimentBlurb(args, env) | |
| − | text = text .. | ||
text = text .. '<br />' | text = text .. '<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 | |
| − | |||
text = text .. (p.makeCategoriesBlurb(args, env) or '') | text = text .. (p.makeCategoriesBlurb(args, env) or '') | ||
end | end | ||
| − | text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --" | + | -- Show the "subpages" link. |
| − | local printBlurb = p.makePrintBlurb(args, env) | + | if subjectSpace ~= 6 then -- Don't show the link in file space. |
| + | text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') | ||
| + | end | ||
| + | -- Show the "print" link if it exists. | ||
| + | local printBlurb = p.makePrintBlurb(args, env) | ||
if printBlurb then | if printBlurb then | ||
text = text .. '<br />' .. printBlurb | text = text .. '<br />' .. printBlurb | ||
| Line 741: | Line 584: | ||
fmargs.text = text | fmargs.text = text | ||
| + | -- Return the fmbox output. | ||
return messageBox.main('fmbox', fmargs) | return messageBox.main('fmbox', fmargs) | ||
| + | end | ||
| + | |||
| + | function p.makePrintBlurb(args, env) | ||
| + | -- Get the /Print title object | ||
| + | local printTitle = env.printTitle | ||
| + | if not printTitle then | ||
| + | return nil | ||
| + | end | ||
| + | -- Make the print blurb. | ||
| + | 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 | ||
| + | |||
| + | function p.makeSubpagesBlurb(args, env) | ||
| + | -- Get the template title object | ||
| + | local subjectSpace = env.subjectSpace | ||
| + | local templateTitle = env.templateTitle | ||
| + | if not subjectSpace or not templateTitle then | ||
| + | return nil | ||
| + | end | ||
| + | -- Make the subpages blurb. | ||
| + | local pagetype | ||
| + | if subjectSpace == 10 then | ||
| + | pagetype = message('template-pagetype') | ||
| + | elseif subjectSpace == 828 then | ||
| + | pagetype = message('module-pagetype') | ||
| + | else | ||
| + | pagetype = message('default-pagetype') | ||
| + | end | ||
| + | return makeWikilink( | ||
| + | 'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/', | ||
| + | message('subpages-link-display', {pagetype}) | ||
| + | ) | ||
| + | end | ||
| + | |||
| + | function p.makeCategoriesBlurb(args, env) | ||
| + | -- Get the title object. | ||
| + | local docTitle = env.docTitle | ||
| + | if not docTitle then | ||
| + | return nil | ||
| + | end | ||
| + | -- Make the blurb. | ||
| + | local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display')) | ||
| + | return message('add-categories-blurb', {docPathLink}) | ||
end | end | ||
function p.makeDocPageBlurb(args, env) | function p.makeDocPageBlurb(args, env) | ||
| − | -- | + | -- Get the title object. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local docTitle = env.docTitle | local docTitle = env.docTitle | ||
if not docTitle then | if not docTitle then | ||
return nil | return nil | ||
end | end | ||
| + | -- Make the blurb. | ||
local ret | local ret | ||
if docTitle.exists then | if docTitle.exists then | ||
| Line 790: | Line 672: | ||
end | end | ||
| − | function p. | + | function p.makeEndBoxExperimentBlurb(args, env) |
| − | |||
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages." | -- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages." | ||
| − | -- | + | -- Get environment data. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local subjectSpace = env.subjectSpace | local subjectSpace = env.subjectSpace | ||
local templateTitle = env.templateTitle | local templateTitle = env.templateTitle | ||
| Line 853: | Line 710: | ||
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 869: | Line 722: | ||
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 891: | Line 737: | ||
local messageName | local messageName | ||
if subjectSpace == 828 then | if subjectSpace == 828 then | ||
| − | messageName = ' | + | messageName = 'experimentBlurbModule' |
else | else | ||
| − | messageName = ' | + | messageName = 'experimentBlurbTemplate' |
end | end | ||
return message(messageName, {sandboxLinks, testcasesLinks}) | return message(messageName, {sandboxLinks, testcasesLinks}) | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
end | end | ||
| Line 982: | Line 749: | ||
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. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local title = env.title | local title = env.title | ||
| − | local | + | local ret = '' |
| − | |||
| − | |||
| − | |||
local subpage = title.subpageText | local subpage = title.subpageText | ||
| − | + | if message('display-strange-usage-category', nil, 'boolean') and (subpage == message('doc-subpage') or subpage == message('testcases-subpage')) then | |
| − | if message('display-strange-usage-category', nil, 'boolean') | + | local sort = (title.namespace == 0 and message('strange-usage-category-mainspace-sort') or '') .. title.prefixedText -- Sort on namespace. |
| − | + | ret = ret .. makeCategoryLink(message('strange-usage-category'), sort) | |
| − | |||
| − | |||
| − | ) | ||
| − | |||
| − | ret = ret .. makeCategoryLink(message('strange-usage-category')) | ||
end | end | ||
return ret | return ret | ||