Editing Module:Documentation

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. Read the Privacy Policy to learn what information we collect about you and how we use it.

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 publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
-- This module implements {{documentation}}.
-- This module implements {{documentation}}.
 
-- 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.
local cfg = mw.loadData('Module:Documentation/config')
local cfg = mw.loadData('Module:Documentation/config')
 
local p = {}
local p = {}
 
-- Often-used functions.
-- Often-used functions.
local ugsub = mw.ustring.gsub
local ugsub = mw.ustring.gsub
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Helper functions
-- Helper functions
Line 18: Line 20:
-- table for testing purposes.
-- table for testing purposes.
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
local function message(cfgKey, valArray, expectType)
local function message(cfgKey, valArray, expectType)
--[[
--[[
Line 37: Line 39:
return msg
return msg
end
end
 
local function getMessageVal(match)
local function getMessageVal(match)
match = tonumber(match)
match = tonumber(match)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end
end
 
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
return ret
end
end
 
p.message = message
p.message = message
 
local function makeWikilink(page, display)
local function makeWikilink(page, display)
if display then
if display then
Line 55: Line 58:
end
end
end
end
 
p.makeWikilink = makeWikilink
p.makeWikilink = makeWikilink
 
local function makeCategoryLink(cat, sort)
local function makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
local catns = mw.site.namespaces[14].name
return makeWikilink(catns .. ':' .. cat, sort)
return makeWikilink(catns .. ':' .. cat, sort)
end
end
 
p.makeCategoryLink = makeCategoryLink
p.makeCategoryLink = makeCategoryLink
 
local function makeUrlLink(url, display)
local function makeUrlLink(url, display)
return mw.ustring.format('[%s %s]', url, display)
return mw.ustring.format('[%s %s]', url, display)
end
end
 
p.makeUrlLink = makeUrlLink
p.makeUrlLink = makeUrlLink
 
local function makeToolbar(...)
local function makeToolbar(...)
local ret = {}
local ret = {}
Line 80: Line 83:
ret[#ret + 1] = select(i, ...)
ret[#ret + 1] = select(i, ...)
end
end
-- 'documentation-toolbar'
return '<small style="font-style: normal;">(' .. table.concat(ret, ' &#124; ') .. ')</small>'
return '<span class="' .. message('toolbar-class') .. '">('
.. table.concat(ret, ' &#124; ') .. ')</span>'
end
end
 
p.makeToolbar = makeToolbar
p.makeToolbar = makeToolbar
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Argument processing
-- Argument processing
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
local function makeInvokeFunc(funcName)
local function makeInvokeFunc(funcName)
return function (frame)
return function (frame)
Line 110: Line 111:
end
end
end
end
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Entry points
-- Main function
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
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')
 
function p._main(args)
function p._main(args)
--[[
--[[
-- 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 = mw.html.create()
local root = htmlBuilder.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))
-- This div tag is from {{documentation/start box}}, but moving it here
:tag('div')
-- so that we don't have to worry about unclosed tags.
-- 'documentation-container'
.tag('div')
:addClass(message('container'))
.attr('id', message('main-div-id'))
:newline()
.addClass(message('main-div-classes'))
:tag('div')
.newline()
-- 'documentation'
.wikitext(p._startBox(args, env))
:addClass(message('main-div-classes'))
.wikitext(p._content(args, env))
:newline()
.tag('div')
:wikitext(p._startBox(args, env))
.css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
:wikitext(p._content(args, env))
.newline()
:tag('div')
.done()
-- 'documentation-clear'
.done()
:addClass(message('clear'))
.wikitext(p._endBox(args, env))
:done()
.newline()
:newline()
.wikitext(p.addTrackingCategories(env))
:done()
return tostring(root)
: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
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Environment settings
-- Environment settings
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
function p.getEnvironment(args)
function p.getEnvironment(args)
--[[
--[[
-- Returns a table with information about the environment, including title
-- Returns a table with information about the environment, including title objects and other namespace- or
-- objects and other namespace- or path-related data.
-- path-related data.
-- @args - table of arguments passed by the user
-- @args - table of arguments passed by the user
--
--
Line 189: Line 179:
-- returned will be nil.
-- returned will be nil.
--]]
--]]
local env, envFuncs = {}, {}
local env, envFuncs = {}, {}
 
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- returned by that function is memoized in the env table so that we don't call any of the functions
-- returned by that function is memoized in the env table so that we don't call any of the functions
Line 208: Line 198:
end
end
})
})
 
function envFuncs.title()
function envFuncs.title()
-- The title object for the current page, or a test page passed with args.page.
-- The title object for the current page, or a test page passed with args.page.
Line 220: Line 210:
return title
return title
end
end
 
function envFuncs.templateTitle()
function envFuncs.templateTitle()
--[[
--[[
Line 237: Line 227:
end
end
end
end
 
function envFuncs.docTitle()
function envFuncs.docTitle()
--[[
--[[
Line 254: Line 244:
return mw.title.new(docpage)
return mw.title.new(docpage)
end
end
function envFuncs.sandboxTitle()
function envFuncs.sandboxTitle()
--[[
--[[
Line 263: Line 253:
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
end
end
function envFuncs.testcasesTitle()
function envFuncs.testcasesTitle()
--[[
--[[
Line 272: Line 262:
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.printTitle()
--[[
--[[
Line 281: Line 271:
return env.templateTitle:subPageTitle(message('print-subpage'))
return env.templateTitle:subPageTitle(message('print-subpage'))
end
end
 
function envFuncs.protectionLevels()
function envFuncs.protectionLevels()
-- The protection levels table of the title object.
-- The protection levels table of the title object.
return env.title.protectionLevels
return env.title.protectionLevels
end
end
 
function envFuncs.subjectSpace()
function envFuncs.subjectSpace()
-- The subject namespace number.
-- The subject namespace number.
return mw.site.namespaces[env.title.namespace].subject.id
return mw.site.namespaces[env.title.namespace].subject.id
end
end
 
function envFuncs.docSpace()
function envFuncs.docSpace()
-- The documentation namespace number. For most namespaces this is the
-- The documentation namespace number. For most namespaces this is the same as the
-- same as the subject namespace. However, pages in the Article, File,
-- subject namespace. However, pages in the Article, File, MediaWiki or Category
-- MediaWiki or Category namespaces must have their /doc, /sandbox and
-- namespaces must have their /doc, /sandbox and /testcases pages in talk space.
-- /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 304: Line 293:
end
end
end
end
 
function envFuncs.docpageBase()
function envFuncs.docpageBase()
-- The base page of the /doc, /sandbox, and /testcases subpages.
-- The base page of the /doc, /sandbox, and /testcases subpages.
Line 314: Line 303:
return docSpaceText .. ':' .. templateTitle.text
return docSpaceText .. ':' .. templateTitle.text
end
end
function envFuncs.compareUrl()
function envFuncs.compareUrl()
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
Line 322: Line 311:
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 329: Line 318:
end
end
end
end
 
return env
return env
end
end
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- 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 371: Line 348:
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
if not (subjectSpace and title and sandboxTitle and templateTitle and mw.title.equals(title, sandboxTitle)) then
and mw.title.equals(title, sandboxTitle)) then
return nil
return nil
end
end
Line 381: Line 357:
-- "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 391: Line 369:
local templateLink = makeWikilink(templateTitle.prefixedText)
local templateLink = makeWikilink(templateTitle.prefixedText)
local compareUrl = env.compareUrl
local compareUrl = env.compareUrl
if compareUrl then
if isPreviewing or not compareUrl then
text = text .. message('sandbox-notice-blurb', {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 402: Line 380:
local testcasesTitle = env.testcasesTitle
local testcasesTitle = env.testcasesTitle
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle and testcasesTitle.exists then
if testcasesTitle.contentModel == "Scribunto" then
if testcasesTitle.namespace == mw.site.namespaces.Module.id then
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesLinkDisplay = message('sandbox-notice-testcases-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
local testcasesRunLinkDisplay = message('sandbox-notice-testcases-run-link-display')
Line 415: Line 393:
end
end
-- Add the sandbox to the sandbox category.
-- Add the sandbox to the sandbox category.
omargs.text = text .. makeCategoryLink(message('sandbox-category'))
text = text .. makeCategoryLink(message('sandbox-category'))
 
omargs.text = text
-- 'documentation-clear'
local ret = '<div style="clear: both;"></div>'
return '<div class="' .. message('clear') .. '"></div>'
ret = ret .. messageBox.main('ombox', omargs)
.. require('Module:Message box').main('ombox', omargs)
return ret
end
end
 
function p.protectionTemplate(env)
function p.protectionTemplate(env)
-- Generates the padlock icon in the top right.
-- Generates the padlock icon in the top right.
Line 428: Line 406:
-- 'protection-template' --> 'pp-template'
-- 'protection-template' --> 'pp-template'
-- 'protection-template-args' --> {docusage = 'yes'}
-- 'protection-template-args' --> {docusage = 'yes'}
local protectionLevels = env.protectionLevels
local title = env.title
local protectionLevels
local protectionTemplate = message('protection-template')
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
end
protectionLevels = env.protectionLevels
if not protectionLevels then
if not protectionLevels then
return nil
return nil
end
end
local editProt = protectionLevels.edit and protectionLevels.edit[1]
local editLevels = protectionLevels.edit
local moveProt = protectionLevels.move and protectionLevels.move[1]
local moveLevels = protectionLevels.move
if editProt then
if moveLevels and moveLevels[1] == 'sysop' or editLevels and editLevels[1] then
-- The page is edit-protected.
-- The page is full-move protected, or full, template, or semi-protected.
return require('Module:Protection banner')._main{
local frame = mw.getCurrentFrame()
message('protection-reason-edit'), small = true
return frame:expandTemplate{title = protectionTemplate, args = message('protection-template-args', nil, 'table')}
}
elseif moveProt and moveProt ~= 'autoconfirmed' then
-- 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
else
return nil
return nil
end
end
end
end
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Start box
-- Start box
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
p.startBox = makeInvokeFunc('_startBox')
p.startBox = makeInvokeFunc('_startBox')
 
function p._startBox(args, env)
function p._startBox(args, env)
--[[
--[[
Line 470: Line 448:
local links
local links
local content = args.content
local content = args.content
if not content or args[1] then
if not content then
-- No need to include the links if the documentation is on the template page itself.
-- No need to include the links if the documentation is on the template page itself.
local linksData = p.makeStartBoxLinksData(args, env)
local linksData = p.makeStartBoxLinksData(args, env)
Line 486: Line 464:
end
end
end
end
 
function p.makeStartBoxLinksData(args, env)
function p.makeStartBoxLinksData(args, env)
--[[
--[[
Line 509: Line 487:
return nil
return nil
end
end
if docTitle.isRedirect then
docTitle = docTitle.redirectTarget
end
 
local data = {}
local data = {}
data.title = title
data.title = title
Line 536: Line 511:
return data
return data
end
end
 
function p.renderStartBoxLinks(data)
function p.renderStartBoxLinks(data)
--[[
--[[
Line 542: Line 517:
-- @data - a table of data generated by p.makeStartBoxLinksData
-- @data - a table of data generated by p.makeStartBoxLinksData
--]]
--]]
local function escapeBrackets(s)
local function escapeBrackets(s)
-- Escapes square brackets with HTML entities.
-- Escapes square brackets with HTML entities.
Line 549: Line 524:
return s
return s
end
end
 
local ret
local ret
local docTitle = data.docTitle
local docTitle = data.docTitle
Line 569: Line 544:
return ret
return ret
end
end
 
function p.makeStartBoxData(args, env, links)
function p.makeStartBoxData(args, env, links)
--[=[
--[=[
Line 578: Line 553:
--
--
-- Messages:
-- Messages:
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=]]'
-- 'documentation-icon-wikitext' --> '[[File:Test Template Info-Icon - Version (2).svg|50px|link=|alt=Documentation icon]]'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'template-namespace-heading' --> 'Template documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'module-namespace-heading' --> 'Module documentation'
-- 'file-namespace-heading' --> 'Summary'
-- 'file-namespace-heading' --> 'Summary'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'other-namespaces-heading' --> 'Documentation'
-- 'start-box-linkclasses' --> 'mw-editsection-like plainlinks'
-- 'start-box-link-id' --> 'doc_editlinks'
-- 'testcases-create-link-display' --> 'create'
-- 'testcases-create-link-display' --> 'create'
--]=]
--]=]
Line 592: Line 569:
end
end
local data = {}
local data = {}
-- Heading
-- Heading
local heading = args.heading -- Blank values are not removed.
local heading = args.heading -- Blank values are not removed.
Line 610: Line 587:
data.heading = message('other-namespaces-heading')
data.heading = message('other-namespaces-heading')
end
end
-- Heading CSS
-- Heading CSS
local headingStyle = args['heading-style']
local headingStyle = args['heading-style']
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
-- 'documentation-heading'
data.headingFontSize = '150%'
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.linksClass = message('start-box-linkclasses')
data.linksClass = message('start-box-link-classes')
data.linksId = message('start-box-link-id')
data.links = links
data.links = links
end
end
return data
return data
end
end
 
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.
-- @data - a table of data generated by p.makeStartBoxData.
local sbox = mw.html.create('div')
local sbox = htmlBuilder.create('div')
sbox
sbox
-- 'documentation-startbox'
.css('padding-bottom', '3px')
:addClass(message('start-box-class'))
.css('border-bottom', '1px solid #aaa')
:newline()
.css('margin-bottom', '1ex')
:tag('span')
.newline()
:addClass(data.headingClass)
.tag('span')
:cssText(data.headingStyleText)
.cssText(data.headingStyleText)
:wikitext(data.heading)
.css('font-weight', data.headingFontWeight)
.css('font-size', data.headingFontSize)
.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)
end
end
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Documentation content
-- Documentation content
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
p.content = makeInvokeFunc('_content')
p.content = makeInvokeFunc('_content')
 
function p._content(args, env)
function p._content(args, env)
-- Displays the documentation contents
-- Displays the documentation contents
Line 672: Line 654:
return '\n' .. (content or '') .. '\n'  
return '\n' .. (content or '') .. '\n'  
end
end
 
p.contentTitle = makeInvokeFunc('_contentTitle')
p.contentTitle = makeInvokeFunc('_contentTitle')
 
function p._contentTitle(args, env)
function p._contentTitle(args, env)
env = env or p.getEnvironment(args)
env = env or p.getEnvironment(args)
Line 684: Line 666:
end
end
end
end
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- End box
-- End box
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
p.endBox = makeInvokeFunc('_endBox')
p.endBox = makeInvokeFunc('_endBox')
 
function p._endBox(args, env)
function p._endBox(args, env)
--[=[
--[=[
Line 697: Line 679:
-- @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]].
--]=]
--]=]
-- Get environment data.
-- Get environment data.
env = env or p.getEnvironment(args)
env = env or p.getEnvironment(args)
Line 706: Line 694:
return nil
return nil
end
end
-- Check whether we should output the end box at all. Add the end
-- Check whether we should output the end box at all. Add the end
-- 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
Line 721: Line 709:
return nil
return nil
end
end
 
-- Assemble the link box.
-- Assemble the arguments for {{fmbox}}.
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 732: Line 727:
-- 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 '') .. '<br />'
text = text .. p.makeExperimentBlurb(args, env)
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 746: Line 742:
end
end
end
end
fmargs.text = text
local box = mw.html.create('div')
-- 'documentation-metadata'
return messageBox.main('fmbox', fmargs)
box:addClass(message('end-box-class'))
-- 'plainlinks'
:addClass(message('end-box-plainlinks'))
:wikitext(text)
:done()
 
return '\n' .. tostring(box)
end
end
 
function p.makeDocPageBlurb(args, env)
function p.makeDocPageBlurb(args, env)
--[=[
--[=[
Line 769: Line 758:
-- 'transcluded-from-blurb' -->  
-- 'transcluded-from-blurb' -->  
-- 'The above [[Wikipedia:Template documentation|documentation]]  
-- 'The above [[Wikipedia:Template documentation|documentation]]  
-- is [[Help:Transclusion|transcluded]] from $1.'
-- is [[Wikipedia: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 803: Line 792:
return ret
return ret
end
end
 
function p.makeExperimentBlurb(args, env)
function p.makeExperimentBlurb(args, env)
--[[
--[[
Line 819: Line 808:
-- '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 867: Line 856:
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
local mirrorPreload = message('mirror-link-preload')
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
if subjectSpace == 828 then
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
end
local mirrorDisplay = message('mirror-link-display')
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
Line 883: Line 868:
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
-- for Modules, add testcases run link if exists
testcasesLinks = testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
if 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 911: Line 889:
return message(messageName, {sandboxLinks, testcasesLinks})
return message(messageName, {sandboxLinks, testcasesLinks})
end
end
 
function p.makeCategoriesBlurb(args, env)
function p.makeCategoriesBlurb(args, env)
--[[
--[[
Line 928: Line 906:
return message('add-categories-blurb', {docPathLink})
return message('add-categories-blurb', {docPathLink})
end
end
 
function p.makeSubpagesBlurb(args, env)
function p.makeSubpagesBlurb(args, env)
--[[
--[[
Line 934: Line 912:
-- @args - a table of arguments passed by the user
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- Messages:
-- 'template-pagetype' --> 'template'
-- 'template-pagetype' --> 'template'
Line 960: Line 938:
return message('subpages-blurb', {subpagesLink})
return message('subpages-blurb', {subpagesLink})
end
end
 
function p.makePrintBlurb(args, env)
function p.makePrintBlurb(args, env)
--[=[
--[=[
Line 990: Line 968:
return ret
return ret
end
end
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Tracking categories
-- Tracking categories
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
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
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- Messages:
-- 'display-strange-usage-category' --> true
-- 'display-strange-usage-category' --> true
Line 1,026: Line 1,004:
return ret
return ret
end
end
 
return p
return p
Please note that all contributions to Nonbinary Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see Nonbinary Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, 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. Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Template used on this page: