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">%s %s</strong>%s',
 +
message('errorPrefix', 'string'),
 +
msg,
 +
makeCategoryLink(message('errorCategory', 'string'))
 +
)
 +
end
 +
 +
p.err = err
  
 
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
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 157: Line 161:
 
-- Returns a table with information about the environment, including title objects and other namespace- or
 
-- Returns a table with information about the environment, including title objects and other namespace- or
 
-- path-related data.
 
-- path-related data.
−
-- @args - table of arguments passed by the user
 
 
--
 
--
 
-- Title objects include:
 
-- Title objects include:
Line 168: 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.
−
-- env.docpageBase - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
+
-- env.docpageRoot - the text of the base page of the /doc, /sandbox and /testcases pages, with namespace.
−
-- env.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
+
-- env.compareLink - a URL link 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
 
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
Line 203: Line 205:
 
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 210: Line 215:
  
 
function envFuncs.templateTitle()
 
function envFuncs.templateTitle()
−
--[[
 
 
-- The template (or module, etc.) title object.
 
-- The template (or module, etc.) title object.
−
-- Messages:
 
−
-- 'sandbox-subpage' --> 'sandbox'
 
−
-- 'testcases-subpage' --> 'testcases'
 
−
--]]
 
−
local subjectSpace = env.subjectSpace
 
 
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.basePageTitle
 
else
 
else
−
return mw.title.makeTitle(subjectSpace, title.text)
+
return title
 
end
 
end
 
end
 
end
  
 
function envFuncs.docTitle()
 
function envFuncs.docTitle()
−
--[[
 
 
-- Title object of the /doc subpage.
 
-- 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 233:
 
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)
Line 244: Line 239:
 
 
 
function envFuncs.sandboxTitle()
 
function envFuncs.sandboxTitle()
−
--[[
 
 
-- Title object for the /sandbox subpage.
 
-- Title object for the /sandbox subpage.
−
-- Messages:
+
return mw.title.new(env.docpageRoot .. '/' .. message('sandboxSubpage', 'string'))
−
-- 'sandbox-subpage' --> 'sandbox'
 
−
--]]
 
−
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
 
 
end
 
end
 
 
 
function envFuncs.testcasesTitle()
 
function envFuncs.testcasesTitle()
−
--[[
 
 
-- Title object for the /testcases subpage.
 
-- Title object for the /testcases subpage.
−
-- Messages:
+
return mw.title.new(env.docpageRoot .. '/' .. message('testcasesSubpage', 'string'))
−
-- 'testcases-subpage' --> 'testcases'
 
−
--]]
 
−
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
 
 
end
 
end
 
 
 
function envFuncs.printTitle()
 
function envFuncs.printTitle()
−
--[[
 
 
-- Title object for the /Print subpage.
 
-- Title object for the /Print subpage.
−
-- Messages:
+
return env.templateTitle:subPageTitle(message('printSubpage', 'string'))
−
-- '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
 
end
  
Line 292: Line 270:
 
end
 
end
  
−
function envFuncs.docpageBase()
+
function envFuncs.docpageRoot()
 
-- The base page of the /doc, /sandbox, and /testcases subpages.
 
-- The base page of the /doc, /sandbox, and /testcases subpages.
 
-- For some namespaces this is the talk page, rather than the template page.
 
-- For some namespaces this is the talk page, rather than the template page.
Line 302: Line 280:
 
end
 
end
 
 
−
function envFuncs.compareUrl()
+
function envFuncs.compareLink()
 
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
 
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
 
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}
+
)
−
)
+
compareUrl = tostring(compareUrl)
−
return tostring(compareUrl)
+
local compareDisplay = message('compareLinkDisplay', 'string')
−
else
+
return makeUrlLink(compareUrl, compareDisplay)
−
return nil
 
−
end
 
 
end
 
end
  
Line 325: Line 301:
  
 
function p.sandboxNotice(args, env)
 
function p.sandboxNotice(args, env)
−
--[=[
 
−
-- Generates a sandbox notice for display above sandbox pages.
 
−
-- @args - a table of arguments passed by the user
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
--
 
−
-- Messages:
 
−
-- 'sandbox-notice-image' --> '[[Image:Sandbox.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 title = env.title
 
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
−
-- Build the table of arguments to pass to {{ombox}}. We need just two fields, "image" and "text".
+
local omargs = {} -- Args for {{ombox}}.
−
local omargs = {}
+
-- Get the image wikitext.
−
omargs.image = message('sandbox-notice-image')
+
omargs.image = message('sandboxNoticeImage', 'string')
 
-- Get the text. We start with the opening blurb, which is something like
 
-- Get the text. We start with the opening blurb, which is something like
 
-- "This is the template sandbox for [[Template:Foo]] (diff)."
 
-- "This is the template sandbox for [[Template:Foo]] (diff)."
 
local text = ''
 
local text = ''
−
local 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
+
if isPreviewing then
−
if compareUrl then
+
-- 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1.'
−
local compareDisplay = message('sandbox-notice-compare-link-display')
+
text = text .. message('sandboxNoticeBlurb', 'string', {templateLink})
−
local compareLink = makeUrlLink(compareUrl, compareDisplay)
 
−
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
 
 
else
 
else
−
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
+
-- 'This is the [[Wikipedia:Template test cases|template sandbox]] page for $1 ($2).'
 +
text = text .. message('sandboxNoticeDiffBlurb', 'string', {templateLink, env.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.
−
-- "See also the companion subpage for [[Template:Foo/testcases|test cases]]."
 
 
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('sandboxNoticeTestcasesLinkDisplay', 'string')
−
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('sandboxNoticeTestcasesBlurb', 'string', {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 page to [[Category:Template sandboxes]].
−
text = text .. makeCategoryLink(message('sandbox-category'))
+
text = text .. makeCategoryLink(message('sandboxCategory', 'string'))
 
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
  
 
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 368:
  
 
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.content
Line 448: Line 374:
 
-- 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
+
if type(linksData) == 'table' then
 
links = p.renderStartBoxLinks(linksData)
 
links = p.renderStartBoxLinks(linksData)
 +
else
 +
-- linksData is nil or an error message.
 +
return linksData
 
end
 
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 395:
  
 
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
 
−
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
−
--
 
−
-- Messages:
 
−
-- 'view-link-display' --> 'view'
 
−
-- 'edit-link-display' --> 'edit'
 
−
-- 'history-link-display' --> 'history'
 
−
-- 'purge-link-display' --> 'purge'
 
−
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
 
−
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
 
−
-- 'docpage-preload' --> 'Template:Documentation/preload'
 
−
-- 'create-link-display' --> 'create'
 
−
--]]
 
−
local subjectSpace = env.subjectSpace
 
 
local title = env.title
 
local title = env.title
 
local docTitle = env.docTitle
 
local docTitle = env.docTitle
Line 484: Line 402:
 
return nil
 
return nil
 
end
 
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 = 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.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('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
Line 531: Line 434:
 
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
 
if not subjectSpace then
−
-- Default to an "other namespaces" namespace, so that we get at least some output
+
return nil
−
-- if an error occurs.
 
−
subjectSpace = 2
 
 
end
 
end
 
local data = {}
 
local data = {}
Line 576: Line 458:
 
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
 
 
Line 597: Line 479:
 
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 491:
 
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 519:
  
 
function p._content(args, env)
 
function p._content(args, env)
−
-- Displays the documentation contents
+
-- Get the /doc title object
−
-- @args - a table of arguments passed by the user
 
−
-- @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
 +
if not docTitle then
 +
return nil
 +
end
 +
-- Get the documentation content.
 
local content = args.content
 
local content = args.content
−
if not content and docTitle and docTitle.exists then
+
if not content 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 671: Line 542:
  
 
function p._endBox(args, env)
 
function p._endBox(args, env)
−
--[=[
 
 
-- This function generates the end box (also known as the link box).
 
-- This function generates the end box (also known as the link box).
−
-- @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.
 
-- 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 695: Line 554:
 
-- box by default if the documentation exists or if we are in the
 
-- box by default if the documentation exists or if we are in the
 
-- user, module or template namespaces.
 
-- user, module or template namespaces.
−
local linkBox = args['link box']
 
 
if linkBox == 'off'
 
if linkBox == 'off'
 
or not (
 
or not (
Line 709: Line 567:
 
-- Assemble the arguments for {{fmbox}}.
 
-- Assemble the arguments for {{fmbox}}.
 
local fmargs = {}
 
local fmargs = {}
−
fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data'
+
fmargs.id = message('fmboxId', 'string') -- Sets 'documentation-meta-data'
−
fmargs.image = 'none'
+
fmargs.image = message('fmboxImageNone', 'string') -- Sets 'none'
−
fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4'
+
fmargs.style = message('fmboxStyle', 'string') -- Sets 'background-color: #ecfcf4'
−
fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;'
+
fmargs.textstyle = message('fmboxTextstyle', 'string') -- '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]]."
+
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 />'
−
if not args.content and not args[1] then
+
-- Show the categories text, but not if "content" fed or "docname fed"
−
-- "Please add categories to the /doc subpage."
+
-- since then it is unclear where to add the categories.
−
-- Don't show this message with inline docs or with an explicitly specified doc page,
+
if not content and not docnameFed then
−
-- 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.
−
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.
 +
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '')
 +
end
 +
-- Show the "print" link if it exists.
 +
local printBlurb = p.makePrintBlurb(args, env)
 
if printBlurb then
 
if printBlurb then
 
text = text .. '<br />' .. printBlurb
 
text = text .. '<br />' .. printBlurb
Line 741: Line 602:
 
fmargs.text = text
 
fmargs.text = text
  
 +
-- Return the fmbox output.
 
return messageBox.main('fmbox', fmargs)
 
return messageBox.main('fmbox', fmargs)
 +
end
 +
 +
function p.makePrintBlurb(args, env)
 +
-- Get the /Print title object
 +
local printTitle = env.printTitle
 +
if not printTitle then
 +
return nil
 +
end
 +
-- Make the print blurb.
 +
local ret
 +
if printTitle.exists then
 +
local printLink = makeWikilink(printTitle.prefixedText, message('printLinkDisplay', 'string'))
 +
ret = message('printBlurb', 'string', {printLink})
 +
local displayPrintCategory = message('displayPrintCategory', 'boolean')
 +
if displayPrintCategory then
 +
ret = ret .. makeCategoryLink(message('printCategory', 'string'))
 +
end
 +
end
 +
return ret
 +
end
 +
 +
function p.makeSubpagesBlurb(args, env)
 +
-- Get the template title object
 +
local subjectSpace = env.subjectSpace
 +
local templateTitle = env.templateTitle
 +
if not subjectSpace or not templateTitle then
 +
return nil
 +
end
 +
-- Make the subpages blurb.
 +
local pagetype
 +
if subjectSpace == 10 then
 +
pagetype = message('templatePagetype', 'string')
 +
elseif subjectSpace == 828 then
 +
pagetype = message('modulePagetype', 'string')
 +
else
 +
pagetype = message('defaultPagetype', 'string')
 +
end
 +
return makeWikilink(
 +
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
 +
message('subpagesLinkDisplay', 'string', {pagetype})
 +
)
 +
end
 +
 +
function p.makeCategoriesBlurb(args, env)
 +
-- Get the title object.
 +
local docTitle = env.docTitle
 +
if not docTitle then
 +
return nil
 +
end
 +
-- Make the blurb.
 +
local docPathLink = makeWikilink(docTitle.prefixedText, message('docLinkDisplay', 'string'))
 +
return message('addCategoriesBlurb', 'string', {docPathLink})
 
end
 
end
  
 
function p.makeDocPageBlurb(args, env)
 
function p.makeDocPageBlurb(args, env)
−
--[=[
+
-- Get the title object.
−
-- 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
 
local docTitle = env.docTitle
 
if not docTitle then
 
if not docTitle then
 
return nil
 
return nil
 
end
 
end
 +
-- Make the blurb.
 
local ret
 
local ret
 
if docTitle.exists then
 
if docTitle.exists then
Line 770: Line 670:
 
local docLink = makeWikilink(docTitle.prefixedText)
 
local docLink = makeWikilink(docTitle.prefixedText)
 
local editUrl = docTitle:fullUrl{action = 'edit'}
 
local editUrl = docTitle:fullUrl{action = 'edit'}
−
local editDisplay = message('edit-link-display')
+
local editDisplay = message('editLinkDisplay', 'string')
 
local editLink = makeUrlLink(editUrl, editDisplay)
 
local editLink = makeUrlLink(editUrl, editDisplay)
 
local historyUrl = docTitle:fullUrl{action = 'history'}
 
local historyUrl = docTitle:fullUrl{action = 'history'}
−
local historyDisplay = message('history-link-display')
+
local historyDisplay = message('historyLinkDisplay', 'string')
 
local historyLink = makeUrlLink(historyUrl, historyDisplay)
 
local historyLink = makeUrlLink(historyUrl, historyDisplay)
−
ret = message('transcluded-from-blurb', {docLink})
+
ret = message('transcludedFromBlurb', 'string', {docLink})
 
.. ' '
 
.. ' '
 
.. makeToolbar(editLink, historyLink)
 
.. makeToolbar(editLink, historyLink)
Line 781: Line 681:
 
elseif env.subjectSpace == 828 then
 
elseif env.subjectSpace == 828 then
 
-- /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('modulePreload', 'string')}
−
local createDisplay = message('create-link-display')
+
local createDisplay = message('createLinkDisplay', 'string')
 
local createLink = makeUrlLink(createUrl, createDisplay)
 
local createLink = makeUrlLink(createUrl, createDisplay)
−
ret = message('create-module-doc-blurb', {createLink})
+
ret = message('createModuleDocBlurb', 'string', {createLink})
 
.. '<br />'
 
.. '<br />'
 
end
 
end
Line 790: Line 690:
 
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."
−
-- @args - a table of arguments passed by the user
+
-- Get environment data.
−
-- @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 templateTitle = env.templateTitle
Line 830: Line 705:
 
if sandboxTitle.exists then
 
if sandboxTitle.exists then
 
local sandboxPage = sandboxTitle.prefixedText
 
local sandboxPage = sandboxTitle.prefixedText
−
local sandboxDisplay = message('sandbox-link-display')
+
local sandboxDisplay = message('sandboxLinkDisplay', 'string')
 
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
 
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
 
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
 
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
−
local sandboxEditDisplay = message('sandbox-edit-link-display')
+
local sandboxEditDisplay = message('sandboxEditLinkDisplay', 'string')
 
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
 
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
−
local compareUrl = env.compareUrl
+
local compareLink = env.compareLink
−
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
 
if subjectSpace == 828 then
 
if subjectSpace == 828 then
−
sandboxPreload = message('module-sandbox-preload')
+
sandboxPreload = message('moduleSandboxPreload', 'string')
 
else
 
else
−
sandboxPreload = message('template-sandbox-preload')
+
sandboxPreload = message('templateSandboxPreload', 'string')
 
end
 
end
 
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
 
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
−
local sandboxCreateDisplay = message('sandbox-create-link-display')
+
local sandboxCreateDisplay = message('sandboxCreateLinkDisplay', 'string')
 
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
 
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
−
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
+
local mirrorSummary = message('mirrorEditSummary', 'string', {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}
+
local mirrorDisplay = message('mirrorLinkDisplay', 'string')
−
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)
 
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
−
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
+
sandboxLinks = message('sandboxLinkDisplay', 'string') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
 
end
 
end
 
if testcasesTitle.exists then
 
if testcasesTitle.exists then
 
local testcasesPage = testcasesTitle.prefixedText
 
local testcasesPage = testcasesTitle.prefixedText
−
local testcasesDisplay = message('testcases-link-display')
+
local testcasesDisplay = message('testcasesLinkDisplay', 'string')
 
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
 
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
 
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
 
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
−
local testcasesEditDisplay = message('testcases-edit-link-display')
+
local testcasesEditDisplay = message('testcasesEditLinkDisplay', 'string')
 
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
 
if subjectSpace == 828 then
 
if subjectSpace == 828 then
−
testcasesPreload = message('module-testcases-preload')
+
testcasesPreload = message('moduleTestcasesPreload', 'string')
 
else
 
else
−
testcasesPreload = message('template-testcases-preload')
+
testcasesPreload = message('templateTestcasesPreload', 'string')
 
end
 
end
 
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
 
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
−
local testcasesCreateDisplay = message('testcases-create-link-display')
+
local testcasesCreateDisplay = message('testcasesCreateLinkDisplay', 'string')
 
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
 
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
−
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
+
testcasesLinks = message('testcasesLinkDisplay', 'string') .. ' ' .. makeToolbar(testcasesCreateLink)
 
end
 
end
 
local messageName
 
local messageName
 
if subjectSpace == 828 then
 
if subjectSpace == 828 then
−
messageName = 'experiment-blurb-module'
+
messageName = 'experimentBlurbModule'
 
else
 
else
−
messageName = 'experiment-blurb-template'
+
messageName = 'experimentBlurbTemplate'
−
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
 
end
−
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
+
return message(messageName, 'string', {sandboxLinks, testcasesLinks})
−
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
 
−
pagetype = message('default-pagetype')
 
−
end
 
−
local subpagesLink = makeWikilink(
 
−
'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
 
−
return ret
 
 
end
 
end
  
Line 982: Line 762:
  
 
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"