Actions

Module

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 "foo-message" had the value 'Foo $2 bar $1.',
+
-- 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 127: Line 128:
 
--]]
 
--]]
 
local env = p.getEnvironment(args)
 
local env = p.getEnvironment(args)
−
local root = mw.html.create()
+
local root = htmlBuilder.create()
 
root
 
root
−
:wikitext(p.protectionTemplate(env))
+
.wikitext(p.protectionTemplate(env))
−
:wikitext(p.sandboxNotice(args, 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')
+
.tag('div')
−
:attr('id', message('main-div-id'))
+
.attr('id', message('main-div-id'))
−
:addClass(message('main-div-classes'))
+
.addClass(message('main-div-classes'))
−
:newline()
+
.newline()
−
:wikitext(p._startBox(args, env))
+
.wikitext(p._startBox(args, env))
−
:wikitext(p._content(args, env))
+
.wikitext(p._content(args, env))
−
:tag('div')
+
.tag('div')
−
:css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
+
.css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
−
:newline()
+
.newline()
−
:done()
+
.done()
−
:done()
+
.done()
−
:wikitext(p._endBox(args, env))
+
.wikitext(p._endBox(args, env))
−
:wikitext(p.addTrackingCategories(env))
+
.newline()
 +
.wikitext(p.addTrackingCategories(env))
 
return tostring(root)
 
return tostring(root)
 
end
 
end
Line 168: Line 170:
 
--
 
--
 
-- 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 268: Line 269:
 
--]]
 
--]]
 
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 306: Line 302:
 
local templateTitle = env.templateTitle
 
local templateTitle = env.templateTitle
 
local sandboxTitle = env.sandboxTitle
 
local sandboxTitle = env.sandboxTitle
−
if templateTitle.exists and sandboxTitle.exists then
+
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)
 
−
else
 
−
return nil
 
−
end
 
 
end
 
end
  
Line 331: Line 323:
 
--  
 
--  
 
-- Messages:
 
-- Messages:
−
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'
+
-- 'sandbox-notice-image' --> '[[Image:Sandbox.png|50px|alt=|link=]]'
−
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
+
-- 'sandbox-notice-blurb' --> 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'
−
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
+
-- 'sandbox-notice-diff-blurb' --> 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'
−
-- '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-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 345: Line 334:
 
local sandboxTitle = env.sandboxTitle
 
local sandboxTitle = env.sandboxTitle
 
local templateTitle = env.templateTitle
 
local templateTitle = env.templateTitle
−
local subjectSpace = env.subjectSpace
+
if not (title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
−
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
 
 
return nil
 
return nil
 
end
 
end
Line 355: Line 343:
 
-- "This is the template sandbox for [[Template:Foo]] (diff)."
 
-- "This is the template sandbox for [[Template:Foo]] (diff)."
 
local text = ''
 
local text = ''
−
local pagetype
+
local frame = mw.getCurrentFrame()
−
if subjectSpace == 10 then
+
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed.
−
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 compareUrl then
+
if isPreviewing or not compareUrl then
 +
text = text .. message('sandbox-notice-blurb', {templateLink})
 +
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', {pagetype, templateLink, compareLink})
+
text = text .. message('sandbox-notice-diff-blurb', {templateLink, compareLink})
−
else
 
−
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
 
 
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 376: Line 358:
 
local testcasesTitle = env.testcasesTitle
 
local testcasesTitle = env.testcasesTitle
 
if testcasesTitle and testcasesTitle.exists then
 
if testcasesTitle and testcasesTitle.exists then
−
if testcasesTitle.namespace == mw.site.namespaces.Module.id then
+
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
−
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
+
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
−
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
+
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
−
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
−
local ret = '<div style="clear: both;"></div>'
+
return messageBox.main('ombox', omargs)
−
ret = ret .. messageBox.main('ombox', omargs)
 
−
return ret
 
 
end
 
end
  
Line 402: Line 374:
 
-- 'protection-template' --> 'pp-template'
 
-- 'protection-template' --> 'pp-template'
 
-- 'protection-template-args' --> {docusage = 'yes'}
 
-- 'protection-template-args' --> {docusage = 'yes'}
−
local protectionLevels, mProtectionBanner
 
 
local title = env.title
 
local title = env.title
−
protectionLevels = env.protectionLevels
+
local protectionTemplate = message('protection-template')
−
if not protectionLevels then
+
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
 
return nil
 
end
 
end
−
local editProt = protectionLevels.edit and protectionLevels.edit[1]
+
local frame = mw.getCurrentFrame()
−
local moveProt = protectionLevels.move and protectionLevels.move[1]
+
local function getProtectionLevel(protectionType, page)
−
if editProt then
+
-- Gets the protection level for page, or for the current page if page is not specified.
−
-- The page is edit-protected.
+
local level = frame:callParserFunction('PROTECTIONLEVEL', protectionType, page)
−
mProtectionBanner = require('Module:Protection banner')
+
if level ~= '' then
−
local reason = message('protection-reason-edit')
+
return level
−
return mProtectionBanner._main{reason, small = true}
+
else
−
elseif moveProt and moveProt ~= 'autoconfirmed' then
+
return nil -- The parser function returns the blank string if there is no match.
−
-- The page is move-protected but not edit-protected. Exclude move
+
end
−
-- protection with the level "autoconfirmed", as this is equivalent to
+
end
−
-- no move protection at all.
+
local prefixedTitle = title.prefixedText
−
mProtectionBanner = require('Module:Protection banner')
+
if getProtectionLevel('move', prefixedTitle) == 'sysop' or getProtectionLevel('edit', prefixedTitle) then
−
return mProtectionBanner._main{action = 'move', small = true}
+
-- The page is full-move protected, or full, template, or semi-protected.
−
else
+
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')}
−
return nil
 
 
end
 
end
 +
return nil
 
end
 
end
  
Line 442: Line 415:
 
-- 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 474: Line 446:
 
-- '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 subjectSpace = env.subjectSpace
+
local data = {}
 +
-- Get title objects.
 
local title = env.title
 
local title = env.title
 
local docTitle = env.docTitle
 
local docTitle = env.docTitle
Line 484: Line 456:
 
return nil
 
return nil
 
end
 
end
−
 
−
local data = {}
 
 
data.title = title
 
data.title = title
 
data.docTitle = docTitle
 
data.docTitle = docTitle
Line 496: Line 466:
 
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')
−
elseif subjectSpace == 828 then -- Module namespace
 
−
preload = message('module-preload')
 
 
else
 
else
 
preload = message('docpage-preload')
 
preload = message('docpage-preload')
Line 514: Line 482:
 
-- @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('%[', '&#91;') -- Replace square brackets with HTML entities.
 
−
s = s:gsub('%]', '&#93;')
 
−
return s
 
−
end
 
−
 
 
local ret
 
local ret
 
local docTitle = data.docTitle
 
local docTitle = data.docTitle
Line 531: Line 491:
 
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 = escapeBrackets(ret)
+
ret = ret:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.
 +
ret = ret:gsub('%]', '&#93;')
 
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 = 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 550: Line 508:
 
--
 
--
 
-- Messages:
 
-- Messages:
−
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
+
-- '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-linkclasses' --> 'mw-editsection plainlinks'
 
-- 'start-box-link-id' --> 'doc_editlinks'
 
-- 'start-box-link-id' --> 'doc_editlinks'
 
-- 'testcases-create-link-display' --> 'create'
 
-- 'testcases-create-link-display' --> 'create'
Line 610: Line 568:
 
-- 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 = mw.html.create('div')
+
local sbox = htmlBuilder.create('div')
 
sbox
 
sbox
−
:css('padding-bottom', '3px')
+
.css('padding-bottom', '3px')
−
:css('border-bottom', '1px solid #aaa')
+
.css('border-bottom', '1px solid #aaa')
−
:css('margin-bottom', '1ex')
+
.css('margin-bottom', '1ex')
−
:newline()
+
.newline()
−
:tag('span')
+
.tag('span')
−
:cssText(data.headingStyleText)
+
.cssText(data.headingStyleText)
−
:css('font-weight', data.headingFontWeight)
+
.css('font-weight', data.headingFontWeight)
−
:css('font-size', data.headingFontSize)
+
.css('font-size', data.headingFontSize)
−
:wikitext(data.heading)
+
.wikitext(data.heading)
 
local links = data.links
 
local links = data.links
 
if links then
 
if links then
−
sbox:tag('span')
+
sbox.tag('span')
−
:addClass(data.linksClass)
+
.addClass(data.linksClass)
−
:attr('id', data.linksId)
+
.attr('id', data.linksId)
−
:wikitext(links)
+
.wikitext(links)
 
end
 
end
 
return tostring(sbox)
 
return tostring(sbox)
Line 641: Line 599:
 
-- @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.prefixedText}
+
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
 
−
 
−
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 685: Line 631:
 
 
 
-- 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 717: Line 662:
 
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 '') -- "This documentation is transcluded from [[Foo]]."
+
text = text .. (p.makeDocPageBlurb(args, env) or '')
−
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
+
-- Add links to /sandbox and /testcases when appropriate.
−
-- We are in the user, template or module namespaces.
+
if subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10 then
−
-- Add sandbox and testcases links.
+
-- We are in the user, module or template namespaces.  
−
-- "Editors can experiment in this template's sandbox and testcases pages."
+
text = text .. p.makeEndBoxExperimentBlurb(args, env)
−
text = text .. (p.makeExperimentBlurb(args, env) or '')
 
 
text = text .. '<br />'
 
text = text .. '<br />'
 +
-- Show the categories text, but not if we have the content on the template page itself,
 +
-- or if the documentation page has been specified explicitly, since then it is unclear
 +
-- where to add the categories.
 
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."
 
−
-- 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 '') --"Subpages of this template"
+
-- Show the "subpages" link if we are not in the File namespace.
−
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.
+
if subjectSpace ~= 6 then
 +
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 790: Line 739:
 
end
 
end
  
−
function p.makeExperimentBlurb(args, env)
+
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."
Line 805: Line 754:
 
-- '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'
 +
-- '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 853: Line 802:
 
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 mirrorPreload = message('mirror-link-preload')
+
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}
−
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
 
−
if subjectSpace == 828 then
 
−
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
 
−
end
 
 
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 814:
 
local testcasesEditDisplay = message('testcases-edit-link-display')
 
local testcasesEditDisplay = message('testcases-edit-link-display')
 
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
 
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
−
-- for Modules, add testcases run link if exists
+
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
−
if subjectSpace == 828 and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
 
−
local testcasesRunLinkDisplay = message('testcases-run-link-display')
 
−
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
 
−
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
 
−
else
 
−
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
 
−
end
 
 
else
 
else
 
local testcasesPreload
 
local testcasesPreload
Line 899: Line 837:
  
 
function p.makeCategoriesBlurb(args, env)
 
function p.makeCategoriesBlurb(args, env)
−
--[[
+
-- Get the title object.
−
-- Generates the text "Please add categories to the /doc subpage."
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
-- Messages:
 
−
-- 'doc-link-display' --> '/doc'
 
−
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
 
−
--]]
 
 
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 docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
 
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
 
return message('add-categories-blurb', {docPathLink})
 
return message('add-categories-blurb', {docPathLink})
Line 916: Line 848:
  
 
function p.makeSubpagesBlurb(args, env)
 
function p.makeSubpagesBlurb(args, env)
−
--[[
+
-- Get the template title object
−
-- Generates the "Subpages of this template" link.
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
 
−
-- Messages:
 
−
-- 'template-pagetype' --> 'template'
 
−
-- 'module-pagetype' --> 'module'
 
−
-- 'default-pagetype' --> 'page'
 
−
-- 'subpages-link-display' --> 'Subpages of this $1'
 
−
--]]
 
 
local subjectSpace = env.subjectSpace
 
local subjectSpace = env.subjectSpace
 
local templateTitle = env.templateTitle
 
local templateTitle = env.templateTitle
Line 932: Line 854:
 
return nil
 
return nil
 
end
 
end
 +
-- Make the subpages blurb.
 
local pagetype
 
local pagetype
 
if subjectSpace == 10 then
 
if subjectSpace == 10 then
Line 940: Line 863:
 
pagetype = message('default-pagetype')
 
pagetype = message('default-pagetype')
 
end
 
end
−
local subpagesLink = makeWikilink(
+
return 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
  
 
function p.makePrintBlurb(args, env)
 
function p.makePrintBlurb(args, env)
−
--[=[
+
-- Get the /Print title object
−
-- 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
 
local printTitle = env.printTitle
 
if not printTitle then
 
if not printTitle then
 
return nil
 
return nil
 
end
 
end
 +
-- Make the print blurb.
 
local ret
 
local ret
 
if printTitle.exists then
 
if printTitle.exists then
Line 991: Line 902:
 
-- 'testcases-subpage' --> 'testcases'
 
-- 'testcases-subpage' --> 'testcases'
 
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
 
-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'
−
--  
+
-- 'strange-usage-category-mainspace-sort' --> 'Main:'
−
-- /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
+
local ret = ''
−
if not title or not subjectSpace then
 
−
return nil
 
−
end
 
 
local subpage = title.subpageText
 
local subpage = title.subpageText
−
local ret = ''
 
 
if message('display-strange-usage-category', nil, 'boolean')
 
if message('display-strange-usage-category', nil, 'boolean')
−
and (
+
and (subpage == message('doc-subpage') or subpage == message('testcases-subpage'))
−
subpage == message('doc-subpage')
 
−
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
 
−
)
 
 
then
 
then
−
ret = ret .. makeCategoryLink(message('strange-usage-category'))
+
-- Generate the strange usage category link. This category is sorted by namespace.
 +
local sort = (title.namespace == 0 and message('strange-usage-category-mainspace-sort') or '')
 +
.. title.prefixedText
 +
ret = ret .. makeCategoryLink(message('strange-usage-category'), sort)
 
end
 
end
 
return ret
 
return ret

Please note that all contributions to Unofficial Stationeers Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Unofficial Stationeers Wiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)
Retrieved from "https://stationeers-wiki.com/Module:Documentation"