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 11: Line 12:
  
 
-- Often-used functions.
 
-- Often-used functions.
−
local ugsub = mw.ustring.gsub
+
local gsub = mw.ustring.gsub
  
 
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
Line 20: Line 21:
 
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
  
−
local function message(cfgKey, valArray, expectType)
+
local function message(cfgKey, expectType, valArray)
 
--[[
 
--[[
 
-- Gets a message from the cfg table and formats it if appropriate.
 
-- Gets a message from the cfg table and formats it if appropriate.
 
-- The function raises an error if the value from the cfg table is not
 
-- The function raises an error if the value from the cfg table is not
−
-- of the type expectType. The default type for expectType is 'string'.
+
-- of the type expectType.
 
-- 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('fooMessage', 'string', {'baz', 'qux'}) would return "Foo qux bar baz."
 
--]]
 
--]]
 
local msg = cfg[cfgKey]
 
local msg = cfg[cfgKey]
−
expectType = expectType or 'string'
+
if expectType and type(msg) ~= expectType then
−
if type(msg) ~= expectType then
 
 
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
 
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
 
end
 
end
Line 44: Line 44:
 
end
 
end
  
−
local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
+
local ret = gsub(msg, '$([1-9][0-9]*)', getMessageVal)
 
return ret
 
return ret
 
end
 
end
Line 86: Line 86:
  
 
p.makeToolbar = makeToolbar
 
p.makeToolbar = makeToolbar
 +
 +
local function err(msg)
 +
return string.format(
 +
'<strong class="error">[[Module:Documentation]] error: %s</strong>%s',
 +
msg,
 +
makeCategoryLink('Documentation template invocations with errors')
 +
)
 +
end
 +
 +
p.err = err
  
 
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
Line 93: Line 103:
 
local function makeInvokeFunc(funcName)
 
local function makeInvokeFunc(funcName)
 
return function (frame)
 
return function (frame)
 +
local headingArg = message('headingArg', 'string')
 
local args = getArgs(frame, {
 
local args = getArgs(frame, {
 
valueFunc = function (key, value)
 
valueFunc = function (key, value)
 
if type(value) == 'string' then
 
if type(value) == 'string' then
 
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
 
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
−
if key == 'heading' or value ~= '' then
+
if key == headingArg or value ~= '' then
 
return value
 
return value
 
else
 
else
Line 118: Line 129:
  
 
function p._main(args)
 
function p._main(args)
−
--[[
 
−
-- This function defines logic flow for the module.
 
−
-- @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 = 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('mainDivId', 'string'))
−
:addClass(message('main-div-classes'))
+
.addClass(message('mainDivClasses', 'string'))
−
: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 154: Line 158:
  
 
function p.getEnvironment(args)
 
function p.getEnvironment(args)
−
--[[
+
-- Returns a table with information about the environment, including the title to use, the subject namespace, etc.
−
-- Returns a table with information about the environment, including title objects and other namespace- or
+
-- This is called from p._main using pcall in case we get any errors from exceeding the expensive function count
−
-- path-related data.
+
-- limit, or other perils unknown.
−
-- @args - table of arguments passed by the user
 
−
--
 
−
-- Title objects include:
 
−
-- env.title - the page we are making documentation for (usually the current title)
 
−
-- env.templateTitle - the template (or module, file, etc.)
 
−
-- env.docTitle - the /doc subpage.
 
−
-- env.sandboxTitle - the /sandbox subpage.
 
−
-- env.testcasesTitle - the /testcases subpage.
 
−
-- env.printTitle - the print version of the template, located at the /Print subpage.
 
 
--
 
--
 
-- Data includes:
 
-- Data includes:
−
-- env.protectionLevels - the protection levels table of the title object.
+
-- env.title - the title object of the page we are making documentation for (usually the current title)
 
-- 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 name of the namespace the title puts its documentation in.
−
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
+
-- env.templatePage - the name of the template page with no namespace or interwiki prefixes.
−
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
 
−
--
 
−
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
 
−
-- 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 a nil value is called, we call that function in the envFuncs table and memoize it
−
-- returned by that function is memoized in the env table so that we don't call any of the functions
+
-- in the env table so we don't have to call any of the functions more than once.
−
-- more than once. (Nils won't be memoized.)
 
 
setmetatable(env, {
 
setmetatable(env, {
 
__index = function (t, key)
 
__index = function (t, key)
 
local envFunc = envFuncs[key]
 
local envFunc = envFuncs[key]
 
if envFunc then
 
if envFunc then
−
local success, val = pcall(envFunc)
+
local val = envFunc()
−
if success then
+
env[key] = val
−
env[key] = val -- Memoise the value.
+
return val
−
return val
+
else
−
end
+
return nil
 
end
 
end
−
return nil
 
 
end
 
end
 
})
 
})
  
 +
-- Get the title.
 
function envFuncs.title()
 
function envFuncs.title()
−
-- The title object for the current page, or a test page passed with args.page.
 
 
local title
 
local title
−
local titleArg = args.page
+
local titleArg = args[message('titleArg', 'string')]
 
if titleArg then
 
if titleArg then
 
title = mw.title.new(titleArg)
 
title = mw.title.new(titleArg)
 +
if not title then
 +
error(message('titleArgError', 'string', {titleArg}))
 +
end
 
else
 
else
 
title = mw.title.getCurrentTitle()
 
title = mw.title.getCurrentTitle()
Line 209: Line 199:
 
end
 
end
  
−
function envFuncs.templateTitle()
+
-- Get the subject namespace number.
−
--[[
+
function envFuncs.subjectSpace()
−
-- The template (or module, etc.) title object.
+
return mw.site.namespaces[env.title.namespace].subject.id
−
-- Messages:
+
end
−
-- 'sandbox-subpage' --> 'sandbox'
+
−
-- 'testcases-subpage' --> 'testcases'
+
-- Get the name of the documentation namespace.
−
--]]
+
function envFuncs.docspace()
 
local subjectSpace = env.subjectSpace
 
local subjectSpace = env.subjectSpace
 +
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
 +
-- Pages in the Article, File, MediaWiki or Category namespaces must have their
 +
-- /doc, /sandbox and /testcases pages in talk space.
 +
return mw.site.namespaces[subjectSpace].talk.name
 +
else
 +
return env.title.subjectNsText
 +
end
 +
end
 +
 +
-- Get the template page with no namespace or interwiki prefixes.
 +
function envFuncs.templatePage()
 
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('sandboxSubpage', 'string') or subpage == message('testcasesSubpage', 'string') then
−
return mw.title.makeTitle(subjectSpace, title.baseText)
+
return title.baseText
 
else
 
else
−
return mw.title.makeTitle(subjectSpace, title.text)
+
return title.text
 
end
 
end
 
end
 
end
  
 
function envFuncs.docTitle()
 
function envFuncs.docTitle()
−
--[[
 
−
-- Title object of the /doc subpage.
 
−
-- Messages:
 
−
-- 'doc-subpage' --> 'doc'
 
−
--]]
 
 
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 234:
 
docpage = docname
 
docpage = docname
 
else
 
else
−
docpage = env.docpageBase .. '/' .. message('doc-subpage')
+
docpage = env.docpageRoot .. '/' .. message('docSubpage', 'string')
 
end
 
end
 
return mw.title.new(docpage)
 
return mw.title.new(docpage)
 +
end
 +
 +
function envFuncs.docpageRoot()
 +
local title = env.title
 +
return (env.docspace or title.nsText) .. ':' .. (env.templatePage or title.text)
 
end
 
end
 
 
 
function envFuncs.sandboxTitle()
 
function envFuncs.sandboxTitle()
−
--[[
+
local titleArg = env.docpageRoot .. '/' .. message('sandboxSubpage', 'string')
−
-- Title object for the /sandbox subpage.
+
local title = mw.title.new(titleArg)
−
-- Messages:
+
if not title then
−
-- 'sandbox-subpage' --> 'sandbox'
+
error(message('titleArgError', 'string', {titleArg}))
−
--]]
+
end
−
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
+
return title
 
end
 
end
 
 
 
function envFuncs.testcasesTitle()
 
function envFuncs.testcasesTitle()
−
--[[
+
local titleArg = env.docpageRoot .. '/' .. message('testcasesSubpage', 'string')
−
-- Title object for the /testcases subpage.
+
local title = mw.title.new(titleArg)
−
-- Messages:
+
if not title then
−
-- 'testcases-subpage' --> 'testcases'
+
error(message('titleArgError', 'string', {titleArg}))
−
--]]
+
end
−
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
+
return title
 
end
 
end
 
 
−
function envFuncs.printTitle()
+
function env:grab(key)
−
--[[
+
local success, val = pcall(function() return self[key] end)
−
-- Title object for the /Print subpage.
+
return success, val
−
-- Messages:
 
−
-- 'print-subpage' --> 'Print'
 
−
--]]
 
−
return env.templateTitle:subPageTitle(message('print-subpage'))
 
−
end
 
−
 
 
−
function envFuncs.protectionLevels()
 
−
-- The protection levels table of the title object.
 
−
return env.title.protectionLevels
 
−
end
 
−
 
 
−
function envFuncs.subjectSpace()
 
−
-- The subject namespace number.
 
−
return mw.site.namespaces[env.title.namespace].subject.id
 
−
end
 
−
 
 
−
function envFuncs.docSpace()
 
−
-- 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
 
−
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
 
−
return subjectSpace + 1
 
−
else
 
−
return subjectSpace
 
−
end
 
−
end
 
−
 
 
−
function envFuncs.docpageBase()
 
−
-- The base page of the /doc, /sandbox, and /testcases subpages.
 
−
-- For some namespaces this is the talk page, rather than the template page.
 
−
local templateTitle = env.templateTitle
 
−
local docSpace = env.docSpace
 
−
local docSpaceText = mw.site.namespaces[docSpace].name
 
−
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
 
−
return docSpaceText .. ':' .. templateTitle.text
 
 
end
 
end
−
 
−
function envFuncs.compareUrl()
 
−
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
 
−
local templateTitle = env.templateTitle
 
−
local sandboxTitle = env.sandboxTitle
 
−
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
 
  
 
return env
 
return env
Line 325: Line 275:
  
 
function p.sandboxNotice(args, env)
 
function p.sandboxNotice(args, env)
−
--[=[
+
local sandboxNoticeTemplate = message('sandboxNoticeTemplate', 'string')
−
-- Generates a sandbox notice for display above sandbox pages.
+
if not (sandboxNoticeTemplate and env.title.subpageText == message('sandboxSubpage', 'string')) then
−
-- @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.svg|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
 
return nil
 
end
 
end
−
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
+
local frame = mw.getCurrentFrame()
−
local omargs = {}
+
local notice = htmlBuilder.create()
−
omargs.image = message('sandbox-notice-image')
+
notice
−
-- Get the text. We start with the opening blurb, which is something like
+
.tag('div')
−
-- "This is the template sandbox for [[Template:Foo]] (diff)."
+
.css('clear', 'both')
−
local text = ''
+
.done()
−
local pagetype
+
.wikitext(frame:expandTemplate{title = sandboxNoticeTemplate, args = {[message('sandboxNoticeLivepageParam')] = args[message('livepageArg', 'string')]}})
−
if subjectSpace == 10 then
+
return tostring(notice)
−
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 compareUrl then
 
−
local compareDisplay = message('sandbox-notice-compare-link-display')
 
−
local compareLink = makeUrlLink(compareUrl, compareDisplay)
 
−
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
 
−
else
 
−
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
 
−
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
 
−
if testcasesTitle.namespace == mw.site.namespaces.Module.id then
 
−
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
 
−
-- Add the sandbox to the sandbox category.
 
−
text = text .. makeCategoryLink(message('sandbox-category'))
 
−
omargs.text = text
 
−
local ret = '<div style="clear: both;"></div>'
 
−
ret = ret .. messageBox.main('ombox', omargs)
 
−
return ret
 
 
end
 
end
  
 
function p.protectionTemplate(env)
 
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 protectionLevels, mProtectionBanner
 
 
local title = env.title
 
local title = env.title
−
protectionLevels = env.protectionLevels
+
local protectionTemplate = message('protectionTemplate', 'string')
−
if not protectionLevels then
+
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 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('protectionTemplateArgs', 'table')}
−
return nil
 
 
end
 
end
 +
return nil
 
end
 
end
  
Line 433: Line 321:
  
 
function p._startBox(args, env)
 
function p._startBox(args, env)
−
--[[
+
-- Generate [view][edit][history][purge] or [create] links.
−
-- This function generates the start box.
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
--
 
−
-- The actual work is done by p.makeStartBoxLinksData and p.renderStartBoxLinks which make
 
−
-- the [view] [edit] [history] [purge] links, and by p.makeStartBoxData and p.renderStartBox
 
−
-- which generate the box HTML.
 
−
--]]
 
−
env = env or p.getEnvironment(args)
 
 
local links
 
local links
−
local content = args.content
+
local content = args[message('contentArg', 'string')]
 
if not content then
 
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)
−
if linksData then
+
links = p.renderStartBoxLinks(linksData)
−
links = p.renderStartBoxLinks(linksData)
 
−
end
 
 
end
 
end
 
-- Generate the start box html.
 
-- Generate the start box html.
 
local data = p.makeStartBoxData(args, env, links)
 
local data = p.makeStartBoxData(args, env, links)
−
if data then
+
if type(data) == 'table' then
 
return p.renderStartBox(data)
 
return p.renderStartBox(data)
 +
elseif type(data) == 'string' then
 +
-- data is an error message.
 +
return data
 
else
 
else
 
-- User specified no heading.
 
-- User specified no heading.
Line 463: Line 343:
  
 
function p.makeStartBoxLinksData(args, env)
 
function p.makeStartBoxLinksData(args, env)
−
--[[
+
local data = {}
−
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
+
-- Get title objects.
−
-- @args - a table of arguments passed by the user
+
local titleSuccess, title = env:grab('title')
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
+
if titleSuccess then
−
--
+
data.title = title
−
-- Messages:
+
else
−
-- 'view-link-display' --> 'view'
+
return err(title)
−
-- 'edit-link-display' --> 'edit'
+
end
−
-- 'history-link-display' --> 'history'
+
local docTitleSuccess, docTitle = env:grab('docTitle')
−
-- 'purge-link-display' --> 'purge'
+
if docTitleSuccess then
−
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
+
data.docTitle = docTitle
−
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
+
else
−
-- 'docpage-preload' --> 'Template:Documentation/preload'
+
return err(docTitle)
−
-- 'create-link-display' --> 'create'
 
−
--]]
 
−
local subjectSpace = env.subjectSpace
 
−
local title = env.title
 
−
local docTitle = env.docTitle
 
−
if not title or not docTitle then
 
−
return nil
 
 
end
 
end
−
 
−
local data = {}
 
−
data.title = title
 
−
data.docTitle = docTitle
 
 
-- View, display, edit, and purge links if /doc exists.
 
-- View, display, edit, and purge links if /doc exists.
−
data.viewLinkDisplay = message('view-link-display')
+
data.viewLinkDisplay = message('viewLinkDisplay', 'string')
−
data.editLinkDisplay = message('edit-link-display')
+
data.editLinkDisplay = message('editLinkDisplay', 'string')
−
data.historyLinkDisplay = message('history-link-display')
+
data.historyLinkDisplay = message('historyLinkDisplay', 'string')
−
data.purgeLinkDisplay = message('purge-link-display')
+
data.purgeLinkDisplay = message('purgeLinkDisplay', 'string')
 
-- Create link if /doc doesn't exist.
 
-- Create link if /doc doesn't exist.
−
local preload = args.preload
+
local preload = args[message('preloadArg', 'string')]
 
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('fileDocpagePreload', 'string')
−
elseif subjectSpace == 828 then -- Module namespace
 
−
preload = message('module-preload')
 
 
else
 
else
−
preload = message('docpage-preload')
+
preload = message('docpagePreload', 'string')
 
end
 
end
 
end
 
end
 
data.preload = preload
 
data.preload = preload
−
data.createLinkDisplay = message('create-link-display')
+
data.createLinkDisplay = message('createLinkDisplay', 'string')
 
return data
 
return data
 
end
 
end
  
 
function p.renderStartBoxLinks(data)
 
function p.renderStartBoxLinks(data)
−
--[[
+
-- Render the [view][edit][history][purge] or [create] links.
−
-- Generates the [view][edit][history][purge] or [create] links from the data table.
 
−
-- @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
 
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(docpage, 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)
 
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
 
 
end
 
end
  
 
function p.makeStartBoxData(args, env, links)
 
function p.makeStartBoxData(args, env, links)
−
--[=[
 
−
-- Does initial processing of data to pass to the start-box render function, p.renderStartBox.
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
-- @links - a string containing the [view][edit][history][purge] links - could be nil if there's an error.
 
−
--
 
−
-- Messages:
 
−
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
 
−
-- 'template-namespace-heading' --> 'Template documentation'
 
−
-- 'module-namespace-heading' --> 'Module documentation'
 
−
-- 'file-namespace-heading' --> 'Summary'
 
−
-- 'other-namespaces-heading' --> 'Documentation'
 
−
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
 
−
-- 'start-box-link-id' --> 'doc_editlinks'
 
−
-- 'testcases-create-link-display' --> 'create'
 
−
--]=]
 
 
local subjectSpace = env.subjectSpace
 
local subjectSpace = env.subjectSpace
−
if not subjectSpace then
 
−
-- Default to an "other namespaces" namespace, so that we get at least some output
 
−
-- if an error occurs.
 
−
subjectSpace = 2
 
−
end
 
 
local data = {}
 
local data = {}
 
 
 
-- Heading
 
-- Heading
−
local heading = args.heading -- Blank values are not removed.
+
local heading = args[message('headingArg', 'string')] -- Blank values are not removed.
 
if heading == '' then
 
if heading == '' then
 
-- Don't display the start box if the heading arg is defined but blank.
 
-- Don't display the start box if the heading arg is defined but blank.
Line 576: Line 408:
 
data.heading = heading
 
data.heading = heading
 
elseif subjectSpace == 10 then -- Template namespace
 
elseif subjectSpace == 10 then -- Template namespace
−
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
+
data.heading = message('documentationIconWikitext', 'string') .. ' ' .. message('templateNamespaceHeading', 'string')
 
elseif subjectSpace == 828 then -- Module namespace
 
elseif subjectSpace == 828 then -- Module namespace
−
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
+
data.heading = message('documentationIconWikitext', 'string') .. ' ' .. message('moduleNamespaceHeading', 'string')
 
elseif subjectSpace == 6 then -- File namespace
 
elseif subjectSpace == 6 then -- File namespace
−
data.heading = message('file-namespace-heading')
+
data.heading = message('fileNamespaceHeading', 'string')
 
else
 
else
−
data.heading = message('other-namespaces-heading')
+
data.heading = message('otherNamespacesHeading', 'string')
 
end
 
end
 
 
 
-- Heading CSS
 
-- Heading CSS
−
local headingStyle = args['heading-style']
+
local headingStyle = args[message('headingStyleArg', 'string')]
 
if headingStyle then
 
if headingStyle then
 
data.headingStyleText = headingStyle
 
data.headingStyleText = headingStyle
Line 597: Line 429:
 
end
 
end
 
 
−
-- Data for the [view][edit][history][purge] or [create] links.
+
-- [view][edit][history][purge] or [create] links.
 
if links then
 
if links then
−
data.linksClass = message('start-box-linkclasses')
+
data.linksClass = message('startBoxLinkclasses', 'string')
−
data.linksId = message('start-box-link-id')
+
data.linksId = message('startBoxLinkId', 'string')
 
data.links = links
 
data.links = links
 
end
 
end
Line 609: Line 441:
 
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.
+
local sbox = htmlBuilder.create('div')
−
local sbox = mw.html.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 638: Line 469:
  
 
function p._content(args, env)
 
function p._content(args, env)
−
-- Displays the documentation contents
+
local content = args[message('contentArg', 'string')]
−
-- @args - a table of arguments passed by the user
+
if not content then
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
+
local docpage = args[1]
−
env = env or p.getEnvironment(args)
+
if docpage and mw.title.new(docpage).exists then
−
local docTitle = env.docTitle
+
local frame = mw.getCurrentFrame()
−
local content = args.content
+
content = frame:preprocess('{{ ' .. docpage .. ' }}')
−
if not content and docTitle and docTitle.exists then
+
else
−
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
+
docpage = env.docspace .. ':' .. env.templatePage .. '/' .. message('docSubpage', 'string')
 +
if mw.title.new(docpage).exists then
 +
local frame = mw.getCurrentFrame()
 +
content = frame:preprocess('{{ ' .. docpage .. ' }}')
 +
end
 +
end
 
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 671: Line 495:
  
 
function p._endBox(args, env)
 
function p._endBox(args, env)
−
--[=[
+
local title = env.title
−
-- This function generates the end box (also known as the link box).
 
−
-- @args - a table of arguments passed by the user
 
−
-- @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.
 
−
env = env or p.getEnvironment(args)
 
 
local subjectSpace = env.subjectSpace
 
local subjectSpace = env.subjectSpace
−
local docTitle = env.docTitle
+
 
−
if not subjectSpace or not docTitle then
+
-- Argument processing in {{documentation}}.
−
return nil
+
local content = args[message('contentArg', 'string')]
 +
local linkBox = args[message('linkBoxArg', 'string')] -- So "link box=off" works.
 +
local docspace = env.docspace
 +
local docname = args[1] -- Other docname, if fed.
 +
local templatePage = env.templatePage
 +
 
 +
-- Argument processing in {{documentation/end box2}}.
 +
local docpageRoot = (docspace or title.nsText) .. ':' .. (templatePage or title.text)
 +
local docpage
 +
if docname then
 +
docpage = docname
 +
else
 +
docpage = docpageRoot .. '/' .. message('docSubpage', 'string')
 
end
 
end
−
+
local docTitle = mw.title.new(docpage)
−
-- Check whether we should output the end box at all. Add the end
+
local docExist = docTitle.exists
−
-- box by default if the documentation exists or if we are in the
+
local docnameFed = args[1] and true
−
-- user, module or template namespaces.
+
local sandbox = docpageRoot .. '/' .. message('sandboxSubpage', 'string')
−
local linkBox = args['link box']
+
local testcases = docpageRoot .. '/' .. message('testcasesSubpage', 'string')
−
if linkBox == 'off'
+
templatePage = title.nsText .. ':' .. templatePage
−
or not (
+
 
−
docTitle.exists
+
-- Output from {{documentation/end box}}
−
or subjectSpace == 2
+
−
or subjectSpace == 828
+
-- First, check whether we should output the end box at all. Add the end box by default if the documentation
−
or subjectSpace == 10
+
-- exists or if we are in the user, module or template namespaces.
−
)
+
if linkBox == message('linkBoxOff', 'string') or not (docExist or subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10) then
−
then
 
 
return nil
 
return nil
 
end
 
end
Line 709: Line 530:
 
-- Assemble the arguments for {{fmbox}}.
 
-- Assemble the arguments for {{fmbox}}.
 
local fmargs = {}
 
local fmargs = {}
−
fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data'
+
fmargs[message('fmboxIdParam', 'string')] = message('fmboxId', 'string') -- Sets fmargs.id = 'documentation-meta-data'
−
fmargs.image = 'none'
+
fmargs[message('fmboxImageParam', 'string')] = message('fmboxImageNone', 'string') -- Sets fmargs.image = 'none'
−
fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4'
+
fmargs[message('fmboxStyleParam', 'string')] = message('fmboxStyle', 'string') -- Sets fmargs.style = 'background-color: #ecfcf4'
−
fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;'
+
fmargs[message('fmboxTextstyleParam', 'string')] = message('fmboxTextstyle', 'string') -- Sets fmargs.textstyle = 'font-style: italic;'
  
 
-- Assemble the fmbox text field.
 
-- Assemble the fmbox text field.
 
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]]."
+
if docExist then
−
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
+
-- /doc exists; link to it.
−
-- We are in the user, template or module namespaces.
+
local docLink = makeWikilink(docpage)
−
-- Add sandbox and testcases links.
+
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, message('editLinkDisplay', 'string'))
−
-- "Editors can experiment in this template's sandbox and testcases pages."
+
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, message('historyLinkDisplay', 'string'))
−
text = text .. (p.makeExperimentBlurb(args, env) or '')
+
text = text .. message('transcludedFromBlurb', 'string', {docLink}) .. ' ' .. makeToolbar(editLink, historyLink) .. '<br />'
 +
elseif subjectSpace == 828 then
 +
-- /doc does not exist; ask to create it.
 +
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = message('modulePreload', 'string')}, message('createLinkDisplay', 'string'))
 +
text = text .. message('createModuleDocBlurb', 'string', {createLink}) .. '<br />'
 +
end
 +
-- Add links to /sandbox and /testcases when appropriate.
 +
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 .. '<br />'
 
text = text .. '<br />'
−
if not args.content and not args[1] then
+
-- Show the categories text, but not if "content" fed or "docname fed" since then it is unclear where to add the categories.
−
-- "Please add categories to the /doc subpage."
+
if not content and not docnameFed then
−
-- Don't show this message with inline docs or with an explicitly specified doc page,
+
local docPathLink = makeWikilink(docpage, message('docLinkDisplay', 'string'))
−
-- as then it is unclear where to add the categories.
+
text = text .. message('addCategoriesBlurb', 'string', {docPathLink})
−
text = text .. (p.makeCategoriesBlurb(args, env) or '')
 
 
end
 
end
−
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
+
-- Show the "subpages" link.
−
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.
+
if subjectSpace ~= 6 then -- Don't show the link in file space.
−
if printBlurb then
+
local pagetype
−
text = text .. '<br />' .. printBlurb
+
if subjectSpace == 10 then
 +
pagetype = message('templatePagetype', 'string')
 +
elseif subjectSpace == 828 then
 +
pagetype = message('modulePagetype', 'string')
 +
else
 +
pagetype = message('defaultPagetype', 'string')
 +
end
 +
text = text .. ' ' .. makeWikilink('Special:PrefixIndex/' .. templatePage .. '/', message('subpagesLinkDisplay', 'string', {pagetype}))
 +
end
 +
-- Show the "print" link if it exists.
 +
local printPage = templatePage .. '/' .. message('printSubpage', 'string')
 +
local printTitle = mw.title.new(printPage)
 +
if printTitle.exists then
 +
local printLink = makeWikilink(printPage, message('printLinkDisplay', 'string'))
 +
text = text .. '<br />' .. message('printBlurb', 'string', {printLink})
 +
.. (message('displayPrintCategory', 'boolean') and makeCategoryLink(message('printCategory', 'string')) or '')
 
end
 
end
 
end
 
end
Line 741: Line 586:
 
fmargs.text = text
 
fmargs.text = text
  
 +
-- Return the fmbox output.
 
return messageBox.main('fmbox', fmargs)
 
return messageBox.main('fmbox', fmargs)
 
end
 
end
  
−
function p.makeDocPageBlurb(args, env)
+
function p.makeEndBoxExperimentBlurb(args, env)
−
--[=[
 
−
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
--
 
−
-- Messages:
 
−
-- 'edit-link-display' --> 'edit'
 
−
-- 'history-link-display' --> 'history'
 
−
-- 'transcluded-from-blurb' -->
 
−
-- 'The above [[Wikipedia:Template documentation|documentation]]
 
−
-- is [[Wikipedia:Transclusion|transcluded]] from $1.'
 
−
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
 
−
-- 'create-link-display' --> 'create'
 
−
-- 'create-module-doc-blurb' -->
 
−
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
 
−
--]=]
 
−
local docTitle = env.docTitle
 
−
if not docTitle then
 
−
return nil
 
−
end
 
−
local ret
 
−
if docTitle.exists then
 
−
-- /doc exists; link to it.
 
−
local docLink = makeWikilink(docTitle.prefixedText)
 
−
local editUrl = docTitle:fullUrl{action = 'edit'}
 
−
local editDisplay = message('edit-link-display')
 
−
local editLink = makeUrlLink(editUrl, editDisplay)
 
−
local historyUrl = docTitle:fullUrl{action = 'history'}
 
−
local historyDisplay = message('history-link-display')
 
−
local historyLink = makeUrlLink(historyUrl, historyDisplay)
 
−
ret = message('transcluded-from-blurb', {docLink})
 
−
.. ' '
 
−
.. makeToolbar(editLink, historyLink)
 
−
.. '<br />'
 
−
elseif env.subjectSpace == 828 then
 
−
-- /doc does not exist; ask to create it.
 
−
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
 
−
local createDisplay = message('create-link-display')
 
−
local createLink = makeUrlLink(createUrl, createDisplay)
 
−
ret = message('create-module-doc-blurb', {createLink})
 
−
.. '<br />'
 
−
end
 
−
return ret
 
−
end
 
−
 
 
−
function p.makeExperimentBlurb(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."
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
--
 
−
-- Messages:
 
−
-- 'sandbox-link-display' --> 'sandbox'
 
−
-- 'sandbox-edit-link-display' --> 'edit'
 
−
-- 'compare-link-display' --> 'diff'
 
−
-- 'module-sandbox-preload' --> 'Template:Documentation/preload-module-sandbox'
 
−
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
 
−
-- 'sandbox-create-link-display' --> 'create'
 
−
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
 
−
-- 'mirror-link-display' --> 'mirror'
 
−
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'
 
−
-- 'sandbox-link-display' --> 'sandbox'
 
−
-- 'testcases-link-display' --> 'testcases'
 
−
-- 'testcases-edit-link-display'--> 'edit'
 
−
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
 
−
-- 'testcases-create-link-display' --> 'create'
 
−
-- 'testcases-link-display' --> 'testcases'
 
−
-- 'testcases-edit-link-display' --> 'edit'
 
−
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
 
−
-- 'template-testcases-preload' --> 'Template:Documentation/preload-testcases'
 
−
-- 'experiment-blurb-module' --> 'Editors can experiment in this module's $1 and $2 pages.'
 
−
-- 'experiment-blurb-template' --> 'Editors can experiment in this template's $1 and $2 pages.'
 
−
--]]
 
 
local subjectSpace = env.subjectSpace
 
local subjectSpace = env.subjectSpace
−
local templateTitle = env.templateTitle
+
local templatePage = env.templatePage
−
local sandboxTitle = env.sandboxTitle
+
-- Get title objects.
−
local testcasesTitle = env.testcasesTitle
+
local sandboxSuccess, sandboxTitle = env:grab('sandboxTitle')
−
local templatePage = templateTitle.prefixedText
+
if not sandboxSuccess then
−
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
+
return err(sandboxTitle)
−
return nil
+
end
 +
local testcasesSuccess, testcasesTitle = env:grab('testcasesTitle')
 +
if not testcasesSuccess then
 +
return err(testcasesTitle)
 
end
 
end
 
-- Make links.
 
-- Make links.
 
local sandboxLinks, testcasesLinks
 
local sandboxLinks, testcasesLinks
 
if sandboxTitle.exists then
 
if sandboxTitle.exists then
−
local sandboxPage = sandboxTitle.prefixedText
+
local sandboxLink = makeWikilink(sandboxTitle.prefixedText, message('sandboxLinkDisplay', 'string'))
−
local sandboxDisplay = message('sandbox-link-display')
+
local sandboxEditLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit'}, message('sandboxEditLinkDisplay', 'string'))
−
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
+
local compareLink = makeUrlLink(mw.title.new('Special:ComparePages'):fullUrl{page1 = templatePage, page2 = sandbox}, message('compareLinkDisplay', 'string'))
−
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
 
−
local sandboxEditDisplay = message('sandbox-edit-link-display')
 
−
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
 
−
local compareUrl = env.compareUrl
 
−
local compareLink
 
−
if compareUrl then
 
−
local compareDisplay = message('compare-link-display')
 
−
compareLink = makeUrlLink(compareUrl, compareDisplay)
 
−
end
 
 
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
 
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
 
else
 
else
−
local sandboxPreload
+
local sandboxPreload = subjectSpace == 828 and message('moduleSandboxPreload', 'string') or message('templateSandboxPreload', 'string')
−
if subjectSpace == 828 then
+
local sandboxCreateLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}, message('sandboxCreateLinkDisplay', 'string'))
−
sandboxPreload = message('module-sandbox-preload')
+
local mirrorSummary = message('mirrorEditSummary', 'string', {makeWikilink(templatePage)})
−
else
+
local mirrorLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}, message('mirrorLinkDisplay', 'string'))
−
sandboxPreload = message('template-sandbox-preload')
+
sandboxLinks = message('sandboxLinkDisplay', 'string') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
−
end
 
−
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
 
−
local sandboxCreateDisplay = message('sandbox-create-link-display')
 
−
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
 
−
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
 
−
local mirrorPreload = message('mirror-link-preload')
 
−
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 mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
 
−
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
 
 
end
 
end
 
if testcasesTitle.exists then
 
if testcasesTitle.exists then
−
local testcasesPage = testcasesTitle.prefixedText
+
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, message('testcasesLinkDisplay', 'string'))
−
local testcasesDisplay = message('testcases-link-display')
+
local testcasesEditLink = makeUrlLink(testcasesTitle:fullUrl{action = 'edit'}, message('testcasesEditLinkDisplay', 'string'))
−
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
+
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
−
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
 
−
local testcasesEditDisplay = message('testcases-edit-link-display')
 
−
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
 
−
-- for Modules, add testcases run link if exists
 
−
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
 
−
local testcasesPreload
 
−
if subjectSpace == 828 then
 
−
testcasesPreload = message('module-testcases-preload')
 
−
else
 
−
testcasesPreload = message('template-testcases-preload')
 
−
end
 
−
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
 
−
local testcasesCreateDisplay = message('testcases-create-link-display')
 
−
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
 
−
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
 
−
end
 
−
local messageName
 
−
if subjectSpace == 828 then
 
−
messageName = 'experiment-blurb-module'
 
−
else
 
−
messageName = 'experiment-blurb-template'
 
−
end
 
−
return message(messageName, {sandboxLinks, testcasesLinks})
 
−
end
 
−
 
 
−
function p.makeCategoriesBlurb(args, env)
 
−
--[[
 
−
-- 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
 
−
if not docTitle then
 
−
return nil
 
−
end
 
−
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
 
−
return message('add-categories-blurb', {docPathLink})
 
−
end
 
−
 
 
−
function p.makeSubpagesBlurb(args, env)
 
−
--[[
 
−
-- 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 templateTitle = env.templateTitle
 
−
if not subjectSpace or not templateTitle then
 
−
return nil
 
−
end
 
−
local pagetype
 
−
if subjectSpace == 10 then
 
−
pagetype = message('template-pagetype')
 
−
elseif subjectSpace == 828 then
 
−
pagetype = message('module-pagetype')
 
 
else
 
else
−
pagetype = message('default-pagetype')
+
local testcasesPreload = subjectSpace == 828 and message('moduleTestcasesPreload', 'string') or message('templateTestcasesPreload', 'string')
−
end
+
local testcasesCreateLink = makeUrlLink(testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}, message('testcasesCreateLinkDisplay', 'string'))
−
local subpagesLink = makeWikilink(
+
testcasesLinks = message('testcasesLinkDisplay', 'string') .. ' ' .. makeToolbar(testcasesCreateLink)
−
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
 
−
message('subpages-link-display', {pagetype})
 
−
)
 
−
return message('subpages-blurb', {subpagesLink})
 
−
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
 
end
−
return ret
+
return message(subjectSpace == 828 and 'experimentBlurbModule' or 'experimentBlurbTemplate', 'string', {sandboxLinks, testcasesLinks})
 
end
 
end
  
Line 982: Line 634:
  
 
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
 
−
 
−
-- Messages:
 
−
-- 'display-strange-usage-category' --> true
 
−
-- 'doc-subpage' --> 'doc'
 
−
-- 'testcases-subpage' --> 'testcases'
 
−
-- '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
+
local ret = ''
−
if not title or not subjectSpace then
 
−
return nil
 
−
end
 
 
local subpage = title.subpageText
 
local subpage = title.subpageText
−
local ret = ''
+
if message('displayStrangeUsageCategory', 'boolean') and (subpage == message('docSubpage', 'string') or subpage == message('testcasesSubpage', 'string')) then
−
if message('display-strange-usage-category', nil, 'boolean')
+
local sort = (title.namespace == 0 and message('strangeUsageCategoryMainspaceSort', 'string') or '') .. title.prefixedText -- Sort on namespace.
−
and (
+
ret = ret .. makeCategoryLink(message('strangeUsageCategory', 'string'), sort)
−
subpage == message('doc-subpage')
 
−
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
 
−
)
 
−
then
 
−
ret = ret .. makeCategoryLink(message('strange-usage-category'))
 
 
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"