Changes

Jump to navigation Jump to search

Module:Documentation (view source)

Revision as of 23:41, 14 March 2022

336 bytes removed ,  23:41, 14 March 2022
m
1 revision imported
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')
      
-- Get the config table.
 
-- Get the config table.
Line 45: Line 43:  
end
 
end
   −
local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
+
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
−
return ret
   
end
 
end
   Line 83: Line 80:  
ret[#ret + 1] = select(i, ...)
 
ret[#ret + 1] = select(i, ...)
 
end
 
end
−
return '<small style="font-style: normal;">(' .. table.concat(ret, ' &#124; ') .. ')</small>'
+
-- 'documentation-toolbar'
 +
return '<span class="' .. message('toolbar-class') .. '">('
 +
.. table.concat(ret, ' &#124; ') .. ')</span>'
 
end
 
end
   Line 113: Line 112:     
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
−
-- Main function
+
-- Entry points
 
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
 +
 +
function p.nonexistent(frame)
 +
if mw.title.getCurrentTitle().subpageText == 'testcases' then
 +
return frame:expandTemplate{title = 'module test cases notice'}
 +
else
 +
return p.main(frame)
 +
end
 +
end
    
p.main = makeInvokeFunc('_main')
 
p.main = makeInvokeFunc('_main')
Line 122: Line 129:  
-- This function defines logic flow for the module.
 
-- This function defines logic flow for the module.
 
-- @args - table of arguments passed by the user
 
-- @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 = htmlBuilder.create()
+
local root = mw.html.create()
 
root
 
root
−
.wikitext(p.protectionTemplate(env))
+
:wikitext(p._getModuleWikitext(args, env))
−
.wikitext(p.sandboxNotice(args, env))
+
:wikitext(p.protectionTemplate(env))
−
-- This div tag is from {{documentation/start box}}, but moving it here
+
:wikitext(p.sandboxNotice(args, env))
−
-- so that we don't have to worry about unclosed tags.
+
:tag('div')
−
.tag('div')
+
-- 'documentation-container'
−
.attr('id', message('main-div-id'))
+
:addClass(message('container'))
−
.addClass(message('main-div-classes'))
+
:attr('role', 'complementary')
−
.newline()
+
:attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil)
−
.wikitext(p._startBox(args, env))
+
:attr('aria-label', args.heading == '' and 'Documentation' or nil)
−
.wikitext(p._content(args, env))
+
:newline()
−
.tag('div')
+
:tag('div')
−
.css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
+
-- 'documentation'
−
.newline()
+
:addClass(message('main-div-classes'))
−
.done()
+
:newline()
−
.done()
+
:wikitext(p._startBox(args, env))
−
.wikitext(p._endBox(args, env))
+
:wikitext(p._content(args, env))
−
.newline()
+
:tag('div')
−
.wikitext(p.addTrackingCategories(env))
+
-- 'documentation-clear'
−
return tostring(root)
+
:addClass(message('clear'))
 +
:done()
 +
:newline()
 +
:done()
 +
:wikitext(p._endBox(args, env))
 +
:done()
 +
:wikitext(p.addTrackingCategories(env))
 +
-- 'Module:Documentation/styles.css'
 +
return mw.getCurrentFrame():extensionTag (
 +
'templatestyles', '', {src=cfg['templatestyles']
 +
}) .. tostring(root)
 
end
 
end
   Line 157: Line 170:  
function p.getEnvironment(args)
 
function p.getEnvironment(args)
 
--[[
 
--[[
−
-- 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
−
-- path-related data.
+
-- objects and other namespace- or path-related data.
 
-- @args - table of arguments passed by the user
 
-- @args - table of arguments passed by the user
 
--
 
--
Line 167: Line 180:  
-- env.sandboxTitle - the /sandbox subpage.
 
-- env.sandboxTitle - the /sandbox subpage.
 
-- env.testcasesTitle - the /testcases 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.subjectSpace - the number of the title's subject namespace.
 
-- env.subjectSpace - the number of the title's subject namespace.
 
-- env.docSpace - the number of the namespace the title puts its documentation in.
 
-- env.docSpace - the number of the namespace the title puts its documentation in.
Line 261: Line 274:  
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
 
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
 
end
 
end
−
+
 
−
function envFuncs.printTitle()
+
function envFuncs.protectionLevels()
−
--[[
+
-- The protection levels table of the title object.
−
-- Title object for the /Print subpage.
+
return env.title.protectionLevels
−
-- Messages:
  −
-- 'print-subpage' --> 'Print'
  −
--]]
  −
return env.templateTitle:subPageTitle(message('print-subpage'))
   
end
 
end
   Line 277: Line 286:     
function envFuncs.docSpace()
 
function envFuncs.docSpace()
−
-- The documentation namespace number. For most namespaces this is the same as the
+
-- The documentation namespace number. For most namespaces this is the
−
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
+
-- same as the subject namespace. However, pages in the Article, File,
−
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
+
-- MediaWiki or Category namespaces must have their /doc, /sandbox and
 +
-- /testcases pages in talk space.
 
local subjectSpace = env.subjectSpace
 
local subjectSpace = env.subjectSpace
 
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
 
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
Line 305: Line 315:  
local compareUrl = mw.uri.fullUrl(
 
local compareUrl = mw.uri.fullUrl(
 
'Special:ComparePages',
 
'Special:ComparePages',
−
{page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
+
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
 
)
 
)
 
return tostring(compareUrl)
 
return tostring(compareUrl)
Line 319: Line 329:  
-- Auxiliary templates
 
-- Auxiliary templates
 
----------------------------------------------------------------------------
 
----------------------------------------------------------------------------
 +
 +
p.getModuleWikitext = makeInvokeFunc('_getModuleWikitext')
 +
 +
function p._getModuleWikitext(args, env)
 +
local currentTitle = mw.title.getCurrentTitle()
 +
if currentTitle.contentModel ~= 'Scribunto' then return end
 +
pcall(require, currentTitle.prefixedText) -- if it fails, we don't care
 +
local moduleWikitext =  package.loaded["Module:Module wikitext"]
 +
if moduleWikitext then
 +
return moduleWikitext.main()
 +
end
 +
end
    
function p.sandboxNotice(args, env)
 
function p.sandboxNotice(args, env)
Line 327: Line 349:  
--  
 
--  
 
-- Messages:
 
-- Messages:
−
-- 'sandbox-notice-image' --> '[[Image:Sandbox.png|50px|alt=|link=]]'
+
-- 'sandbox-notice-image' --> '[[Image:Sandbox.svg|50px|alt=|link=]]'
 
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
 
-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'
 
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
 
-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'
Line 342: Line 364:  
local templateTitle = env.templateTitle
 
local templateTitle = env.templateTitle
 
local subjectSpace = env.subjectSpace
 
local subjectSpace = env.subjectSpace
−
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
+
if not (subjectSpace and title and sandboxTitle and templateTitle
 +
and mw.title.equals(title, sandboxTitle)) then
 
return nil
 
return nil
 
end
 
end
Line 351: Line 374:  
-- "This is the template sandbox for [[Template:Foo]] (diff)."
 
-- "This is the template sandbox for [[Template:Foo]] (diff)."
 
local text = ''
 
local text = ''
−
local frame = mw.getCurrentFrame()
  −
local isPreviewing = frame:preprocess('{{REVISIONID}}') == '' -- True if the page is being previewed.
   
local pagetype
 
local pagetype
 
if subjectSpace == 10 then
 
if subjectSpace == 10 then
Line 363: Line 384:  
local templateLink = makeWikilink(templateTitle.prefixedText)
 
local templateLink = makeWikilink(templateTitle.prefixedText)
 
local compareUrl = env.compareUrl
 
local compareUrl = env.compareUrl
−
if isPreviewing or not compareUrl then
+
if compareUrl then
−
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
  −
else
   
local compareDisplay = message('sandbox-notice-compare-link-display')
 
local compareDisplay = message('sandbox-notice-compare-link-display')
 
local compareLink = makeUrlLink(compareUrl, compareDisplay)
 
local compareLink = makeUrlLink(compareUrl, compareDisplay)
 
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
 
text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})
 +
else
 +
text = text .. message('sandbox-notice-blurb', {pagetype, templateLink})
 
end
 
end
 
-- Get the test cases page blurb if the page exists. This is something like
 
-- Get the test cases page blurb if the page exists. This is something like
Line 374: Line 395:  
local testcasesTitle = env.testcasesTitle
 
local testcasesTitle = env.testcasesTitle
 
if testcasesTitle and testcasesTitle.exists then
 
if testcasesTitle and testcasesTitle.exists then
−
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
+
if testcasesTitle.contentModel == "Scribunto" then
−
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
+
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
−
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
+
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
 +
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
 +
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
 +
text = text .. '<br />' .. message('sandbox-notice-testcases-run-blurb', {testcasesLink, testcasesRunLink})
 +
else
 +
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
 +
local testcasesLink = makeWikilink(testcasesTitle.prefixedText, testcasesLinkDisplay)
 +
text = text .. '<br />' .. message('sandbox-notice-testcases-blurb', {testcasesLink})
 +
end
 
end
 
end
 
-- Add the sandbox to the sandbox category.
 
-- Add the sandbox to the sandbox category.
−
text = text .. makeCategoryLink(message('sandbox-category'))
+
omargs.text = text .. makeCategoryLink(message('sandbox-category'))
−
omargs.text = text
+
 
−
return messageBox.main('ombox', omargs)
+
-- 'documentation-clear'
 +
return '<div class="' .. message('clear') .. '"></div>'
 +
.. require('Module:Message box').main('ombox', omargs)
 
end
 
end
   Line 390: Line 421:  
-- 'protection-template' --> 'pp-template'
 
-- 'protection-template' --> 'pp-template'
 
-- 'protection-template-args' --> {docusage = 'yes'}
 
-- 'protection-template-args' --> {docusage = 'yes'}
−
local title = env.title
+
local protectionLevels = env.protectionLevels
−
local protectionTemplate = message('protection-template')
+
if not protectionLevels then
−
local namespace = title.namespace
  −
if not (protectionTemplate and (namespace == 10 or namespace == 828)) then
  −
-- Don't display the protection template if we are not in the template or module namespaces.
   
return nil
 
return nil
 
end
 
end
−
local frame = mw.getCurrentFrame()
+
local editProt = protectionLevels.edit and protectionLevels.edit[1]
−
local function getProtectionLevel(protectionType, page)
+
local moveProt = protectionLevels.move and protectionLevels.move[1]
−
-- Gets the protection level for page, or for the current page if page is not specified.
+
if editProt then
−
local level = frame:callParserFunction('PROTECTIONLEVEL', protectionType, page)
+
-- The page is edit-protected.
−
if level ~= '' then
+
return require('Module:Protection banner')._main{
−
return level
+
message('protection-reason-edit'), small = true
−
else
+
}
−
return nil -- The parser function returns the blank string if there is no match.
+
elseif moveProt and moveProt ~= 'autoconfirmed' then
−
end
+
-- The page is move-protected but not edit-protected. Exclude move
 +
-- protection with the level "autoconfirmed", as this is equivalent to
 +
-- no move protection at all.
 +
return require('Module:Protection banner')._main{
 +
action = 'move', small = true
 +
}
 +
else
 +
return nil
 
end
 
end
−
local prefixedTitle = title.prefixedText
  −
if getProtectionLevel('move', prefixedTitle) == 'sysop' or getProtectionLevel('edit', prefixedTitle) then
  −
-- The page is full-move protected, or full, template, or semi-protected.
  −
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')}
  −
end
  −
return nil
   
end
 
end
   Line 434: Line 463:  
local links
 
local links
 
local content = args.content
 
local content = args.content
−
if not content then
+
if not content or args[1] 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)
Line 462: Line 491:  
-- 'history-link-display' --> 'history'
 
-- 'history-link-display' --> 'history'
 
-- 'purge-link-display' --> 'purge'
 
-- 'purge-link-display' --> 'purge'
−
-- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace'
   
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
 
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
 
-- 'docpage-preload' --> 'Template:Documentation/preload'
 
-- 'docpage-preload' --> 'Template:Documentation/preload'
Line 472: Line 500:  
if not title or not docTitle then
 
if not title or not docTitle then
 
return nil
 
return nil
 +
end
 +
if docTitle.isRedirect then
 +
docTitle = docTitle.redirectTarget
 
end
 
end
   Line 485: Line 516:  
local preload = args.preload
 
local preload = args.preload
 
if not preload then
 
if not preload then
−
if subjectSpace == 6 then -- File namespace
+
if subjectSpace == 828 then -- Module namespace
−
preload = message('file-docpage-preload')
  −
elseif subjectSpace == 828 then -- Module namespace
   
preload = message('module-preload')
 
preload = message('module-preload')
 
else
 
else
Line 500: Line 529:  
function p.renderStartBoxLinks(data)
 
function p.renderStartBoxLinks(data)
 
--[[
 
--[[
−
-- Generates the [view][edit][history][purge] or [create] links from the data table.
+
-- Generates the [view][edit][history][purge] or [create][purge] links from the data table.
 
-- @data - a table of data generated by p.makeStartBoxLinksData
 
-- @data - a table of data generated by p.makeStartBoxLinksData
 
--]]
 
--]]
Line 514: Line 543:  
local docTitle = data.docTitle
 
local docTitle = data.docTitle
 
local title = data.title
 
local title = data.title
 +
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
 
if docTitle.exists then
 
if docTitle.exists then
 
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
 
local viewLink = makeWikilink(docTitle.prefixedText, 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)
   
ret = '[%s] [%s] [%s] [%s]'
 
ret = '[%s] [%s] [%s] [%s]'
 
ret = escapeBrackets(ret)
 
ret = escapeBrackets(ret)
Line 524: Line 553:  
else
 
else
 
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
 
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
−
ret = '[%s]'
+
ret = '[%s] [%s]'
 
ret = escapeBrackets(ret)
 
ret = escapeBrackets(ret)
−
ret = mw.ustring.format(ret, createLink)
+
ret = mw.ustring.format(ret, createLink, purgeLink)
 
end
 
end
 
return ret
 
return ret
Line 539: Line 568:  
--
 
--
 
-- Messages:
 
-- Messages:
−
-- 'documentation-icon-wikitext' --> '[[File:Template-info.png|50px|link=|alt=Documentation icon]]'
+
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
 
-- 'template-namespace-heading' --> 'Template documentation'
 
-- 'template-namespace-heading' --> 'Template documentation'
 
-- 'module-namespace-heading' --> 'Module documentation'
 
-- 'module-namespace-heading' --> 'Module documentation'
 
-- 'file-namespace-heading' --> 'Summary'
 
-- 'file-namespace-heading' --> 'Summary'
 
-- 'other-namespaces-heading' --> 'Documentation'
 
-- 'other-namespaces-heading' --> 'Documentation'
−
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
  −
-- 'start-box-link-id' --> 'doc_editlinks'
   
-- 'testcases-create-link-display' --> 'create'
 
-- 'testcases-create-link-display' --> 'create'
 
--]=]
 
--]=]
Line 578: Line 605:  
if headingStyle then
 
if headingStyle then
 
data.headingStyleText = headingStyle
 
data.headingStyleText = headingStyle
−
elseif subjectSpace == 10 then
  −
-- We are in the template or template talk namespaces.
  −
data.headingFontWeight = 'bold'
  −
data.headingFontSize = '125%'
   
else
 
else
−
data.headingFontSize = '150%'
+
-- 'documentation-heading'
 +
data.headingClass = message('main-div-heading-class')
 
end
 
end
 
 
 
-- Data for the [view][edit][history][purge] or [create] links.
 
-- Data for the [view][edit][history][purge] or [create] links.
 
if links then
 
if links then
−
data.linksClass = message('start-box-linkclasses')
+
-- 'mw-editsection-like plainlinks'
−
data.linksId = message('start-box-link-id')
+
data.linksClass = message('start-box-link-classes')
 
data.links = links
 
data.links = links
 
end
 
end
Line 599: Line 623:  
-- Renders the start box html.
 
-- Renders the start box html.
 
-- @data - a table of data generated by p.makeStartBoxData.
 
-- @data - a table of data generated by p.makeStartBoxData.
−
local sbox = htmlBuilder.create('div')
+
local sbox = mw.html.create('div')
 
sbox
 
sbox
−
.css('padding-bottom', '3px')
+
-- 'documentation-startbox'
−
.css('border-bottom', '1px solid #aaa')
+
:addClass(message('start-box-class'))
−
.css('margin-bottom', '1ex')
+
:newline()
−
.newline()
+
:tag('span')
−
.tag('span')
+
:addClass(data.headingClass)
−
.cssText(data.headingStyleText)
+
:attr('id', 'documentation-heading')
−
.css('font-weight', data.headingFontWeight)
+
:cssText(data.headingStyleText)
−
.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 634: Line 657:  
local content = args.content
 
local content = args.content
 
if not content and docTitle and docTitle.exists then
 
if not content and docTitle and docTitle.exists then
−
local frame = mw.getCurrentFrame()
+
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
−
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 654: Line 688:  
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
 
-- @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]].
   
--]=]
 
--]=]
 
 
Line 685: Line 713:  
end
 
end
   −
-- Assemble the arguments for {{fmbox}}.
+
-- Assemble the link box.
−
local fmargs = {}
  −
fmargs.id = message('fmbox-id') -- Sets 'documentation-meta-data'
  −
fmargs.image = 'none'
  −
fmargs.style = message('fmbox-style') -- Sets 'background-color: #ecfcf4'
  −
fmargs.textstyle = message('fmbox-textstyle') -- 'font-style: italic;'
  −
 
  −
-- Assemble the fmbox text field.
   
local text = ''
 
local text = ''
 
if linkBox then
 
if linkBox then
Line 702: Line 723:  
-- Add sandbox and testcases links.
 
-- Add sandbox and testcases links.
 
-- "Editors can experiment in this template's sandbox and testcases pages."
 
-- "Editors can experiment in this template's sandbox and testcases pages."
−
text = text .. p.makeExperimentBlurb(args, env)
+
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'
−
text = text .. '<br />'
   
if not args.content and not args[1] then
 
if not args.content and not args[1] then
 
-- "Please add categories to the /doc subpage."
 
-- "Please add categories to the /doc subpage."
Line 711: Line 731:  
end
 
end
 
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
 
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
−
local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates.
  −
if printBlurb then
  −
text = text .. '<br />' .. printBlurb
  −
end
   
end
 
end
 
end
 
end
−
fmargs.text = text
+
 +
local box = mw.html.create('div')
 +
-- 'documentation-metadata'
 +
box:attr('role', 'note')
 +
:addClass(message('end-box-class'))
 +
-- 'plainlinks'
 +
:addClass(message('end-box-plainlinks'))
 +
:wikitext(text)
 +
:done()
   −
return messageBox.main('fmbox', fmargs)
+
return '\n' .. tostring(box)
 
end
 
end
   Line 733: Line 757:  
-- 'transcluded-from-blurb' -->  
 
-- 'transcluded-from-blurb' -->  
 
-- 'The above [[Wikipedia:Template documentation|documentation]]  
 
-- 'The above [[Wikipedia:Template documentation|documentation]]  
−
-- is [[Wikipedia:Transclusion|transcluded]] from $1.'
+
-- is [[Help:Transclusion|transcluded]] from $1.'
 
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
 
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
 
-- 'create-link-display' --> 'create'
 
-- 'create-link-display' --> 'create'
Line 783: Line 807:  
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
 
-- 'mirror-edit-summary' --> 'Create sandbox version of $1'
 
-- 'mirror-link-display' --> 'mirror'
 
-- 'mirror-link-display' --> 'mirror'
 +
-- 'mirror-link-preload' --> 'Template:Documentation/mirror'
 
-- 'sandbox-link-display' --> 'sandbox'
 
-- 'sandbox-link-display' --> 'sandbox'
 
-- 'testcases-link-display' --> 'testcases'
 
-- 'testcases-link-display' --> 'testcases'
 
-- 'testcases-edit-link-display'--> 'edit'
 
-- 'testcases-edit-link-display'--> 'edit'
−
-- 'module-testcases-preload' --> 'Template:Documentation/preload-module-testcases'
   
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
 
-- 'template-sandbox-preload' --> 'Template:Documentation/preload-sandbox'
 
-- 'testcases-create-link-display' --> 'create'
 
-- 'testcases-create-link-display' --> 'create'
Line 831: Line 855:  
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
 
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
 
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
 
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
−
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}
+
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 mirrorDisplay = message('mirror-link-display')
 
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
 
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
Line 843: Line 871:  
local testcasesEditDisplay = message('testcases-edit-link-display')
 
local testcasesEditDisplay = message('testcases-edit-link-display')
 
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
 
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
−
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
+
-- for Modules, add testcases run link if exists
 +
if testcasesTitle.contentModel == "Scribunto"  and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
 +
local testcasesRunLinkDisplay = message('testcases-run-link-display')
 +
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
 +
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink, testcasesRunLink)
 +
else
 +
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
 +
end
 
else
 
else
 
local testcasesPreload
 
local testcasesPreload
Line 912: Line 947:  
)
 
)
 
return message('subpages-blurb', {subpagesLink})
 
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
  
Retrieved from "https://www.crewsgenealogy.com/wiki/Special:MobileDiff/3989...27794"

Navigation menu