Bureaucrats, Interface administrators, Administrators (Semantic MediaWiki), Curators (Semantic MediaWiki), Editors (Semantic MediaWiki), Suppressors, Administrators
19,911
edits
Changes
Jump to navigation
Jump to search
mLine 3:
Line 3: − local messageBox = require('Module:Message box') Line 44:
Line 43: − local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal) + − return ret Line 82:
Line 80: − + + + Line 112:
Line 112: − + + + + + + + + + Line 121:
Line 129: − -- − -- Messages: − -- 'main-div-id' --> 'template-documentation' − -- 'main-div-classes' --> 'template-documentation iezoomfix' + − -- This div tag is from {{documentation/start box}}, but moving it here − -- so that we don't have to worry about unclosed tags. − + − + + + + − :wikitext(p._startBox(args, env)) − :wikitext(p._content(args, env)) − + + + + + + + + + + − :wikitext(p._endBox(args, env)) − + + + + Line 155:
Line 170: − + − -- path-related data.+ Line 165:
Line 180: − -- env.printTitle - the print version of the template, located at the /Print subpage. Line 259:
Line 273: − end − − function envFuncs.printTitle() − --[[ − -- Title object for the /Print subpage. − -- Messages: − -- 'print-subpage' --> 'Print' − --]] − return env.templateTitle:subPageTitle(message('print-subpage')) Line 281:
Line 286: − + − + − + + Line 309:
Line 315: − + Line 323:
Line 329: + + + + + + + + + + + + Line 346:
Line 364: − + + Line 376:
Line 395: − + Line 389:
Line 408: − + − omargs.text = text + − local ret = '<div style="clear: both;"></div>' + − ret = ret .. messageBox.main('ombox', omargs)+ − return ret+ Line 402:
Line 421: − + − local title = env.title − protectionLevels = env.protectionLevels Line 412:
Line 429: − mProtectionBanner = require('Module:Protection banner') + − local reason = message('protection-reason-edit')+ − return mProtectionBanner._main{reason, small = true}+ − mProtectionBanner = require('Module:Protection banner') + − return mProtectionBanner._main{action = 'move', small = true}+ + Line 445:
Line 463: − + Line 473:
Line 491: − -- 'file-docpage-preload' --> 'Template:Documentation/preload-filespace' Line 483:
Line 500: + + + Line 496:
Line 516: − + − preload = message('file-docpage-preload') − elseif subjectSpace == 828 then -- Module namespace Line 511:
Line 529: − + Line 525:
Line 543: + − local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay) Line 535:
Line 553: − + − + Line 555:
Line 573: − -- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks' − -- 'start-box-link-id' --> 'doc_editlinks' Line 589:
Line 605: − elseif subjectSpace == 10 then − -- We are in the template or template talk namespaces. − data.headingFontWeight = 'bold' − data.headingFontSize = '125%' − + + − data.linksClass = message('start-box-linkclasses') + − + Line 612:
Line 625: − :css('padding-bottom', '3px') + − + − :css('margin-bottom', '1ex') + + − :css('font-weight', data.headingFontWeight) − :css('font-size', data.headingFontSize) Line 676:
Line 688: − -- 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 707:
Line 713: − + − 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. Line 724:
Line 723: − + − text = text .. '<br />' Line 733:
Line 731: − local printBlurb = p.makePrintBlurb(args, env) -- Two-line blurb about print versions of templates. − if printBlurb then − text = text .. '<br />' .. printBlurb − end − fmargs.text = text + + + + + + + + + − + Line 755:
Line 757: − + Line 870:
Line 872: − + Line 945:
Line 947: − 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
1 revision imported
-- Get required modules.
-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local getArgs = require('Module:Arguments').getArgs
-- Get the config table.
-- Get the config table.
end
end
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
end
end
ret[#ret + 1] = select(i, ...)
ret[#ret + 1] = select(i, ...)
end
end
return '<small style="font-style: normal;">(' .. table.concat(ret, ' | ') .. ')</small>'
-- 'documentation-toolbar'
return '<span class="' .. message('toolbar-class') .. '">('
.. table.concat(ret, ' | ') .. ')</span>'
end
end
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- 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')
-- 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
--]]
--]]
local env = p.getEnvironment(args)
local env = p.getEnvironment(args)
local root = mw.html.create()
local root = mw.html.create()
root
root
:wikitext(p._getModuleWikitext(args, env))
:wikitext(p.protectionTemplate(env))
:wikitext(p.protectionTemplate(env))
:wikitext(p.sandboxNotice(args, env))
:wikitext(p.sandboxNotice(args, env))
:tag('div')
:tag('div')
:attr('id', message('main-div-id'))
-- 'documentation-container'
:addClass(message('main-div-classes'))
:addClass(message('container'))
:attr('role', 'complementary')
:attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil)
:attr('aria-label', args.heading == '' and 'Documentation' or nil)
:newline()
:newline()
:tag('div')
:tag('div')
:css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
-- 'documentation'
:addClass(message('main-div-classes'))
:newline()
:wikitext(p._startBox(args, env))
:wikitext(p._content(args, env))
:tag('div')
-- 'documentation-clear'
:addClass(message('clear'))
:done()
:newline()
:newline()
:done()
:done()
:wikitext(p._endBox(args, env))
:done()
:done()
:wikitext(p.addTrackingCategories(env))
:wikitext(p.addTrackingCategories(env))
return tostring(root)
-- 'Module:Documentation/styles.css'
return mw.getCurrentFrame():extensionTag (
'templatestyles', '', {src=cfg['templatestyles']
}) .. tostring(root)
end
end
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
-- objects and other namespace- or path-related data.
-- @args - table of arguments passed by the user
-- @args - table of arguments passed by the user
--
--
-- env.sandboxTitle - the /sandbox subpage.
-- env.sandboxTitle - the /sandbox subpage.
-- env.testcasesTitle - the /testcases subpage.
-- env.testcasesTitle - the /testcases subpage.
--
--
-- Data includes:
-- Data includes:
--]]
--]]
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
end
end
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
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)
-- 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)
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
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
if testcasesTitle.contentModel == "Scribunto" then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
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'))
-- 'documentation-clear'
return '<div class="' .. message('clear') .. '"></div>'
.. require('Module:Message box').main('ombox', omargs)
end
end
-- 'protection-template' --> 'pp-template'
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels, mProtectionBanner
local protectionLevels = env.protectionLevels
if not protectionLevels then
if not protectionLevels then
return nil
return nil
if editProt then
if editProt then
-- The page is edit-protected.
-- The page is edit-protected.
return require('Module:Protection banner')._main{
message('protection-reason-edit'), small = true
}
elseif moveProt and moveProt ~= 'autoconfirmed' then
elseif moveProt and moveProt ~= 'autoconfirmed' then
-- The page is move-protected but not edit-protected. Exclude move
-- The page is move-protected but not edit-protected. Exclude move
-- protection with the level "autoconfirmed", as this is equivalent to
-- protection with the level "autoconfirmed", as this is equivalent to
-- no move protection at all.
-- no move protection at all.
return require('Module:Protection banner')._main{
action = 'move', small = true
}
else
else
return nil
return nil
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)
-- 'history-link-display' --> 'history'
-- 'history-link-display' --> 'history'
-- 'purge-link-display' --> 'purge'
-- 'purge-link-display' --> 'purge'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'docpage-preload' --> 'Template:Documentation/preload'
-- 'docpage-preload' --> 'Template:Documentation/preload'
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
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('module-preload')
preload = message('module-preload')
else
else
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
--]]
--]]
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)
ret = '[%s] [%s] [%s] [%s]'
ret = '[%s] [%s] [%s] [%s]'
ret = escapeBrackets(ret)
ret = escapeBrackets(ret)
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
-- 'file-namespace-heading' --> 'Summary'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'testcases-create-link-display' --> 'create'
-- 'testcases-create-link-display' --> 'create'
--]=]
--]=]
if headingStyle then
if headingStyle then
data.headingStyleText = headingStyle
data.headingStyleText = headingStyle
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
-- '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
local sbox = mw.html.create('div')
local sbox = mw.html.create('div')
sbox
sbox
-- 'documentation-startbox'
:css('border-bottom', '1px solid #aaa')
:addClass(message('start-box-class'))
:newline()
:newline()
:tag('span')
:tag('span')
:addClass(data.headingClass)
:attr('id', 'documentation-heading')
:cssText(data.headingStyleText)
:cssText(data.headingStyleText)
:wikitext(data.heading)
:wikitext(data.heading)
local links = data.links
local links = data.links
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
--
--
--]=]
--]=]
end
end
-- Assemble the arguments for {{fmbox}}.
-- Assemble the link box.
local text = ''
local text = ''
if linkBox then
if linkBox then
-- 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) or '')
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<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."
end
end
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
end
end
end
end
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
-- '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'
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
-- for Modules, add testcases run link if exists
-- for Modules, add testcases run link if exists
if subjectSpace == 828 and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
if testcasesTitle.contentModel == "Scribunto" and testcasesTitle.talkPageTitle and testcasesTitle.talkPageTitle.exists then
local testcasesRunLinkDisplay = message('testcases-run-link-display')
local testcasesRunLinkDisplay = message('testcases-run-link-display')
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
local testcasesRunLink = makeWikilink(testcasesTitle.talkPageTitle.prefixedText, testcasesRunLinkDisplay)
)
)
return message('subpages-blurb', {subpagesLink})
return message('subpages-blurb', {subpagesLink})
end
end