330
edits
Difference between revisions of "Module:Documentation"
Jump to navigation
Jump to search
m
171 revisions imported
en>Mr. Stradivarius (don't check that we are not in the file namespace before adding the subpage blurb, as we already know we're either in the user, template or module namespace) |
m (171 revisions imported) |
||
| (79 intermediate revisions by 36 users not shown) | |||
| Line 3: | Line 3: | ||
-- Get required modules. | -- Get required modules. | ||
local getArgs = require('Module:Arguments').getArgs | local getArgs = require('Module:Arguments').getArgs | ||
local messageBox = require('Module:Message box') | 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 i18n = mw.loadData('Module:Documentation/i18n') | |||
local p = {} | local p = {} | ||
| Line 28: | Line 27: | ||
-- 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 "foo-message" 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 34: | Line 33: | ||
expectType = expectType or 'string' | expectType = expectType or 'string' | ||
if type(msg) ~= expectType then | if type(msg) ~= expectType then | ||
error(' | error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-type', cfgKey, expectType, type(msg)), 2) | ||
end | end | ||
if not valArray then | if not valArray then | ||
| Line 42: | Line 41: | ||
local function getMessageVal(match) | local function getMessageVal(match) | ||
match = tonumber(match) | match = tonumber(match) | ||
return valArray[match] or error(' | return valArray[match] or error(require('Module:TNT').format('I18n/Documentation', 'cfg-error-msg-empty', '$' .. match, cfgKey), 4) | ||
end | end | ||
| Line 110: | Line 109: | ||
return p[funcName](args) | return p[funcName](args) | ||
end | end | ||
end | |||
---------------------------------------------------------------------------- | |||
-- Load TemplateStyles | |||
---------------------------------------------------------------------------- | |||
p.main = function(frame) | |||
local parent = frame.getParent(frame) | |||
local output = p._main(parent.args) | |||
return frame:extensionTag{ name='templatestyles', args = { src= message('templatestyles-scr') } } .. output | |||
end | end | ||
| Line 115: | Line 124: | ||
-- Main function | -- Main function | ||
---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ||
function p._main(args) | function p._main(args) | ||
| Line 128: | Line 135: | ||
--]] | --]] | ||
local env = p.getEnvironment(args) | local env = p.getEnvironment(args) | ||
local root = | local root = mw.html.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-class')) | |||
:wikitext(p._startBox(args, env)) | |||
:wikitext(p._content(args, env)) | |||
:done() | |||
:wikitext(p._endBox(args, env)) | |||
:wikitext(p.addTrackingCategories(env)) | |||
return tostring(root) | return tostring(root) | ||
end | end | ||
| Line 170: | Line 171: | ||
-- | -- | ||
-- Data includes: | -- Data includes: | ||
-- env.protectionLevels - the protection levels table of the title object. | |||
-- 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. | ||
| Line 269: | Line 271: | ||
--]] | --]] | ||
return env.templateTitle:subPageTitle(message('print-subpage')) | return env.templateTitle:subPageTitle(message('print-subpage')) | ||
end | |||
function envFuncs.protectionLevels() | |||
-- The protection levels table of the title object. | |||
return env.title.protectionLevels | |||
end | end | ||
| Line 302: | Line 309: | ||
local templateTitle = env.templateTitle | local templateTitle = env.templateTitle | ||
local sandboxTitle = env.sandboxTitle | local sandboxTitle = env.sandboxTitle | ||
local compareUrl = mw.uri.fullUrl( | if templateTitle.exists and sandboxTitle.exists then | ||
local compareUrl = mw.uri.fullUrl( | |||
'Special:ComparePages', | |||
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText} | |||
) | |||
return tostring(compareUrl) | |||
else | |||
return nil | |||
end | |||
end | end | ||
| Line 323: | Line 334: | ||
-- | -- | ||
-- Messages: | -- Messages: | ||
-- 'sandbox-notice-image' --> '[[Image:Sandbox. | -- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]' | ||
-- 'sandbox-notice-blurb' --> 'This is the [[Wikipedia:Template test cases|template sandbox]] page | -- 'sandbox-notice-blurb' --> 'This is the $1 for $2.' | ||
-- 'sandbox-notice- | -- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).' | ||
-- 'sandbox-notice-pagetype-template' --> '[[w:Wikipedia:Template test cases|template sandbox]] page' | |||
-- 'sandbox-notice-pagetype-module' --> '[[w:Wikipedia:Template test cases|module sandbox]] page' | |||
-- 'sandbox-notice-pagetype-other' --> 'sandbox page' | |||
-- 'sandbox-notice-compare-link-display' --> 'diff' | -- 'sandbox-notice-compare-link-display' --> 'diff' | ||
-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.' | -- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.' | ||
| Line 334: | Line 348: | ||
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 | local subjectSpace = env.subjectSpace | ||
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then | |||
return nil | return nil | ||
end | end | ||
| Line 345: | Line 360: | ||
local frame = mw.getCurrentFrame() | local frame = mw.getCurrentFrame() | ||
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed. | 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 templateLink = makeWikilink(templateTitle.prefixedText) | ||
local compareUrl = env.compareUrl | local compareUrl = env.compareUrl | ||
if isPreviewing or not compareUrl then | if isPreviewing or not compareUrl then | ||
text = text .. message('sandbox-notice-blurb', {templateLink}) | text = text .. message('sandbox-notice-blurb', {pagetype, templateLink}) | ||
else | else | ||
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', {templateLink, compareLink}) | text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink}) | ||
end | end | ||
-- Get the test cases page blurb if the page exists. This is something like | -- Get the test cases page blurb if the page exists. This is something like | ||
| Line 358: | Line 381: | ||
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') | if testcasesTitle.contentModel == "Scribunto" then | ||
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay) | local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display') | ||
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display') | |||
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay) | |||
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay) | |||
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink}) | |||
else | |||
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 | end | ||
-- Add the sandbox to the sandbox category. | -- Add the sandbox to the sandbox category. | ||
text = text .. makeCategoryLink(message('sandbox-category')) | text = text .. makeCategoryLink(message('sandbox-category')) | ||
omargs.text = text | omargs.text = text | ||
omargs.class = message('sandbox-class') | |||
local ret = '<div style="clear: both;"></div>' | |||
ret = ret .. messageBox.main('ombox', omargs) | |||
return ret | |||
end | end | ||
| Line 375: | Line 409: | ||
-- 'protection-template-args' --> {docusage = 'yes'} | -- 'protection-template-args' --> {docusage = 'yes'} | ||
local title = env.title | local title = env.title | ||
local protectionLevels | |||
local protectionTemplate = message('protection-template') | local protectionTemplate = message('protection-template') | ||
local namespace = title.namespace | local namespace = title.namespace | ||
| Line 381: | Line 416: | ||
return nil | return nil | ||
end | end | ||
protectionLevels = env.protectionLevels | |||
if not protectionLevels then | |||
return nil | |||
end | end | ||
local | local editLevels = protectionLevels.edit | ||
if | local moveLevels = protectionLevels.move | ||
if moveLevels and moveLevels[1] == 'sysop' or editLevels and editLevels[1] then | |||
-- The page is full-move protected, or full, template, or semi-protected. | -- The page is full-move protected, or full, template, or semi-protected. | ||
local frame = mw.getCurrentFrame() | |||
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')} | return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')} | ||
else | |||
return nil | |||
end | end | ||
end | end | ||
| Line 415: | Line 447: | ||
-- which generate the box HTML. | -- which generate the box HTML. | ||
--]] | --]] | ||
env = env or p.getEnvironment(args) | |||
local links | local links | ||
local content = args.content | local content = args.content | ||
| Line 446: | Line 479: | ||
-- 'purge-link-display' --> 'purge' | -- 'purge-link-display' --> 'purge' | ||
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace' | -- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace' | ||
-- 'module-preload' --> 'Template:Documentation/preload-module-doc' | |||
-- 'docpage-preload' --> 'Template:Documentation/preload' | -- 'docpage-preload' --> 'Template:Documentation/preload' | ||
-- 'create-link-display' --> 'create' | -- 'create-link-display' --> 'create' | ||
--]] | --]] | ||
local | local subjectSpace = env.subjectSpace | ||
local title = env.title | local title = env.title | ||
local docTitle = env.docTitle | local docTitle = env.docTitle | ||
| Line 456: | Line 489: | ||
return nil | return nil | ||
end | end | ||
if docTitle.isRedirect then | |||
docTitle = docTitle.redirectTarget | |||
end | |||
local data = {} | |||
data.title = title | data.title = title | ||
data.docTitle = docTitle | data.docTitle = docTitle | ||
-- View, display, edit, and purge links if /doc exists. | -- View, display, edit, and purge links if /doc exists. | ||
data.viewLinkDisplay = | data.viewLinkDisplay = i18n['view-link-display'] | ||
data.editLinkDisplay = | data.editLinkDisplay = i18n['edit-link-display'] | ||
data.historyLinkDisplay = | data.historyLinkDisplay = i18n['history-link-display'] | ||
data.purgeLinkDisplay = | data.purgeLinkDisplay = i18n['purge-link-display'] | ||
-- Create link if /doc doesn't exist. | -- Create link if /doc doesn't exist. | ||
local preload = args.preload | local preload = args.preload | ||
if not preload then | if not preload then | ||
if | if subjectSpace == 6 then -- File namespace | ||
preload = message('file-docpage-preload') | preload = message('file-docpage-preload') | ||
elseif subjectSpace == 828 then -- Module namespace | |||
preload = message('module-preload') | |||
else | else | ||
preload = message('docpage-preload') | preload = message('docpage-preload') | ||
| Line 473: | Line 513: | ||
end | end | ||
data.preload = preload | data.preload = preload | ||
data.createLinkDisplay = | data.createLinkDisplay = i18n['create-link-display'] | ||
return data | return data | ||
end | end | ||
| Line 482: | Line 522: | ||
-- @data - a table of data generated by p.makeStartBoxLinksData | -- @data - a table of data generated by p.makeStartBoxLinksData | ||
--]] | --]] | ||
local function escapeBrackets(s) | |||
-- Escapes square brackets with HTML entities. | |||
s = s:gsub('%[', '[') -- Replace square brackets with HTML entities. | |||
s = s:gsub('%]', ']') | |||
return s | |||
end | |||
local ret | local ret | ||
local docTitle = data.docTitle | local docTitle = data.docTitle | ||
| Line 491: | Line 539: | ||
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 = escapeBrackets(ret) | ||
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink) | ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink) | ||
else | else | ||
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay) | |||
ret = '[%s]' | |||
ret = escapeBrackets(ret) | |||
ret = mw.ustring.format(ret, createLink) | |||
end | end | ||
return ret | return ret | ||
| Line 508: | Line 558: | ||
-- | -- | ||
-- Messages: | -- Messages: | ||
-- 'documentation-icon-wikitext' --> '[[File:Template- | -- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|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 plainlinks' | -- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks' | ||
-- 'start-box-link-id' --> 'doc_editlinks' | -- 'start-box-link-id' --> 'doc_editlinks' | ||
-- 'testcases-create-link-display' --> 'create' | -- 'testcases-create-link-display' --> 'create' | ||
| Line 534: | Line 584: | ||
data.heading = heading | data.heading = heading | ||
elseif subjectSpace == 10 then -- Template namespace | elseif subjectSpace == 10 then -- Template namespace | ||
data.heading = | data.heading = i18n['template-namespace-heading'] | ||
elseif subjectSpace == 828 then -- Module namespace | elseif subjectSpace == 828 then -- Module namespace | ||
data.heading = | data.heading = i18n['module-namespace-heading'] | ||
elseif subjectSpace == 6 then -- File namespace | elseif subjectSpace == 6 then -- File namespace | ||
data.heading = | data.heading = i18n['file-namespace-heading'] | ||
else | else | ||
data.heading = | data.heading = i18n['other-namespaces-heading'] | ||
end | end | ||
| Line 568: | Line 606: | ||
-- 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 = mw.html.create('div') | ||
sbox | sbox | ||
:addClass(message('header-div-class')) | |||
:tag('div') | |||
:addClass(message('heading-div-class')) | |||
:wikitext(data.heading) | |||
local links = data.links | local links = data.links | ||
if links then | if links then | ||
sbox | sbox | ||
:tag('div') | |||
:addClass(data.linksClass) | |||
:attr('id', data.linksId) | |||
:wikitext(links) | |||
end | end | ||
return tostring(sbox) | return tostring(sbox) | ||
| Line 599: | Line 633: | ||
-- @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 | ||
env = env or p.getEnvironment(args) | |||
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 | ||
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle} | |||
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. | ||
local cbox = mw.html.create('div') | |||
cbox | |||
:addClass(message('content-div-class')) | |||
:wikitext('\n' .. (content or '') .. '\n') | |||
return tostring(cbox) | |||
end | |||
p.contentTitle = makeInvokeFunc('_contentTitle') | |||
function p._contentTitle(args, env) | |||
env = env or p.getEnvironment(args) | |||
local docTitle = env.docTitle | |||
if not args.content and docTitle and docTitle.exists then | |||
return docTitle.prefixedText | |||
else | |||
return '' | |||
end | |||
end | end | ||
| Line 621: | Line 671: | ||
-- @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 | ||
--]=] | --]=] | ||
-- Get environment data. | -- Get environment data. | ||
env = env or p.getEnvironment(args) | |||
local subjectSpace = env.subjectSpace | local subjectSpace = env.subjectSpace | ||
local docTitle = env.docTitle | local docTitle = env.docTitle | ||
| Line 652: | Line 696: | ||
end | end | ||
-- Assemble the | -- Assemble the footer text field. | ||
local text = '' | local text = '' | ||
if linkBox then | if linkBox then | ||
text = text .. linkBox | text = text .. linkBox | ||
else | else | ||
text = text .. (p.makeDocPageBlurb(args, env) or '') | text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]." | ||
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then | |||
if subjectSpace == 2 or subjectSpace == | -- We are in the user, template or module namespaces. | ||
-- We are in the user, module | -- Add sandbox and testcases links. | ||
text = text .. p.makeExperimentBlurb(args, env) | -- "Editors can experiment in this template's sandbox and testcases pages." | ||
text = text .. (p.makeExperimentBlurb(args, env) or '') | |||
text = text .. '<br />' | 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." | ||
-- or | -- Don't show this message with inline docs or with an explicitly specified doc page, | ||
-- as then it is unclear where to add the categories. | |||
text = text .. (p.makeCategoriesBlurb(args, env) or '') | text = text .. (p.makeCategoriesBlurb(args, env) or '') | ||
end | end | ||
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') | text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template" | ||
local printBlurb = p.makePrintBlurb(args, env) | local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates. | ||
if printBlurb then | if printBlurb then | ||
text = text .. '<br />' .. printBlurb | text = text .. '<br />' .. printBlurb | ||
| Line 684: | Line 721: | ||
end | end | ||
end | end | ||
local ebox = mw.html.create('div') | |||
ebox | |||
:addClass(message('footer-div-class')) | |||
:wikitext(text) | |||
return tostring(ebox) | |||
end | end | ||
| Line 699: | Line 739: | ||
-- 'history-link-display' --> 'history' | -- 'history-link-display' --> 'history' | ||
-- 'transcluded-from-blurb' --> | -- 'transcluded-from-blurb' --> | ||
-- 'The above [[Wikipedia:Template documentation|documentation]] | -- 'The above [[w:Wikipedia:Template documentation|documentation]] | ||
-- is [[Wikipedia:Transclusion|transcluded]] from $1.' | -- is [[w: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' | ||
-- 'create-module-doc-blurb' --> | -- 'create-module-doc-blurb' --> | ||
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].' | -- 'You might want to $1 a documentation page for this [[w:Wikipedia:Lua|Scribunto module]].' | ||
--]=] | --]=] | ||
local docTitle = env.docTitle | local docTitle = env.docTitle | ||
if not docTitle then | if not docTitle or args.content then | ||
return nil | return nil | ||
end | end | ||
| Line 715: | Line 755: | ||
local docLink = makeWikilink(docTitle.prefixedText) | local docLink = makeWikilink(docTitle.prefixedText) | ||
local editUrl = docTitle:fullUrl{action = 'edit'} | local editUrl = docTitle:fullUrl{action = 'edit'} | ||
local editDisplay = | local editDisplay = i18n['edit-link-display'] | ||
local editLink = makeUrlLink(editUrl, editDisplay) | local editLink = makeUrlLink(editUrl, editDisplay) | ||
local historyUrl = docTitle:fullUrl{action = 'history'} | local historyUrl = docTitle:fullUrl{action = 'history'} | ||
local historyDisplay = | local historyDisplay = i18n['history-link-display'] | ||
local historyLink = makeUrlLink(historyUrl, historyDisplay) | local historyLink = makeUrlLink(historyUrl, historyDisplay) | ||
ret = message('transcluded-from-blurb', {docLink}) | ret = message('transcluded-from-blurb', {docLink}) | ||
| Line 727: | Line 767: | ||
-- /doc does not exist; ask to create it. | -- /doc does not exist; ask to create it. | ||
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')} | local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')} | ||
local createDisplay = | local createDisplay = i18n['create-link-display'] | ||
local createLink = makeUrlLink(createUrl, createDisplay) | local createLink = makeUrlLink(createUrl, createDisplay) | ||
ret = message('create-module-doc-blurb', {createLink}) | ret = message('create-module-doc-blurb', {createLink}) | ||
| Line 750: | Line 790: | ||
-- 'mirror-edit-summary' --> 'Create sandbox version of $1' | -- 'mirror-edit-summary' --> 'Create sandbox version of $1' | ||
-- 'mirror-link-display' --> 'mirror' | -- 'mirror-link-display' --> 'mirror' | ||
-- 'mirror-link-preload' --> 'Template:Documentation/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' | ||
-- '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 798: | Line 838: | ||
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 mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = | local mirrorPreload = message('mirror-link-preload') | ||
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, 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 874: | Line 915: | ||
pagetype = message('default-pagetype') | pagetype = message('default-pagetype') | ||
end | end | ||
local subpagesLink = makeWikilink( | |||
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/', | 'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/', | ||
message('subpages-link-display', {pagetype}) | message('subpages-link-display', {pagetype}) | ||
) | ) | ||
return message('subpages-blurb', {subpagesLink}) | |||
end | end | ||
| Line 924: | Line 966: | ||
-- 'testcases-subpage' --> 'testcases' | -- 'testcases-subpage' --> 'testcases' | ||
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage' | -- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage' | ||
-- | |||
-- /testcases pages in the module namespace are not categorised, as they may have | |||
-- {{documentation}} transcluded automatically. | |||
--]] | --]] | ||
local title = env.title | local title = env.title | ||
local subjectSpace = env.subjectSpace | |||
if not title or not subjectSpace then | |||
return nil | |||
end | |||
local subpage = title.subpageText | local subpage = title.subpageText | ||
local ret = '' | local ret = '' | ||
if message('display-strange-usage-category', nil, 'boolean') | if message('display-strange-usage-category', nil, 'boolean') | ||
and (subpage == message('doc-subpage') or subpage == message('testcases-subpage')) | and ( | ||
subpage == message('doc-subpage') | |||
or subjectSpace ~= 828 and subpage == message('testcases-subpage') | |||
) | |||
then | then | ||
ret = ret .. makeCategoryLink(message('strange-usage-category')) | ret = ret .. makeCategoryLink(message('strange-usage-category')) | ||