Module:Documentation: Difference between revisions

Jump to navigation Jump to search
← Older edit
m>Mr. Stradivarius
more efficient code for the subpages link
MeowyCats2 (talk | contribs)
Bureaucrats, Interface administrators, Stewards, Administrators
38 edits
m 224 revisions imported
 
(216 intermediate revisions by 68 users not shown)
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.
local cfg = mw.loadData('Module:Documentation/config')


local p = {}
local p = {}


-- Constants.
-- Often-used functions.
local currentTitle = mw.title.getCurrentTitle()
local ugsub = mw.ustring.gsub
local subjectSpace = mw.site.namespaces[currentTitle.namespace].subject.id


----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Helper functions
-- Helper functions
--
-- These are defined as local functions, but are made available in the p
-- table for testing purposes.
----------------------------------------------------------------------------
----------------------------------------------------------------------------
local function message(cfgKey, valArray, expectType)
--[[
-- 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
-- of the type expectType. The default type for expectType is 'string'.
-- 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.
-- For example, if the message "foo-message" had the value 'Foo $2 bar $1.',
-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."
--]]
local msg = cfg[cfgKey]
expectType = expectType or 'string'
if type(msg) ~= expectType then
error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)
end
if not valArray then
return msg
end
local function getMessageVal(match)
match = tonumber(match)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end
return ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
end
p.message = message


local function makeWikilink(page, display)
local function makeWikilink(page, display)
Line 23: Line 55:
end
end
end
end
p.makeWikilink = makeWikilink
local function makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
return makeWikilink(catns .. ':' .. cat, sort)
end
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


local function makeToolbar(...)
local function makeToolbar(...)
Line 37: 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
p.makeToolbar = makeToolbar


----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Main functions
-- Argument processing
----------------------------------------------------------------------------
----------------------------------------------------------------------------


function p.main(frame)
local function makeInvokeFunc(funcName)
local args = getArgs(frame, {
return function (frame)
valueFunc = function (key, value)
local args = getArgs(frame, {
if type(value) == 'string' then
valueFunc = function (key, value)
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
if type(value) == 'string' then
if key == 'heading' or value ~= '' then
value = value:match('^%s*(.-)%s*$') -- Remove whitespace.
if key == 'heading' or value ~= '' then
return value
else
return nil
end
else
return value
return value
else
return nil
end
end
else
return value
end
end
end
})
})
return p[funcName](args)
return p._main(args)
end
end
 
----------------------------------------------------------------------------
-- 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
end
p.main = makeInvokeFunc('_main')


function p._main(args)
function p._main(args)
local root = htmlBuilder.create()
--[[
-- This function defines logic flow for the module.
-- @args - table of arguments passed by the user
--]]
local env = p.getEnvironment(args)
local root = mw.html.create()
root
root
.wikitext(p.protectionTemplate())
:tag('div')
.wikitext(p.sandboxNotice(args))
-- 'documentation-container'
-- This div tag is from {{documentation/start box}}, but moving it here
:addClass(message('container'))
-- so that we don't have to worry about unclosed tags.
:attr('role', 'complementary')
.tag('div')
:attr('aria-labelledby', args.heading ~= '' and 'documentation-heading' or nil)
.attr('id', 'template-documentation')
:attr('aria-label', args.heading == '' and 'Documentation' or nil)
.addClass('template-documentation iezoomfix')
:newline()
.wikitext(p.startBox(args))
:tag('div')
.wikitext(p.content(args))
-- 'documentation'
.tag('div')
:addClass(message('main-div-classes'))
.css('clear', 'both') -- So right or left floating items don't stick out of the doc box.
:newline()
.done()
:wikitext(p._startBox(args, env))
.done()
:wikitext(p._content(args, env))
.wikitext(p.endBox(args))
:tag('div')
.wikitext(p.addTrackingCategories())
-- '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


function p.sandboxNotice(args)
----------------------------------------------------------------------------
if currentTitle.subpageText == 'sandbox' then
-- Environment settings
local frame = mw.getCurrentFrame()
----------------------------------------------------------------------------
local root = htmlBuilder.create()
 
root
function p.getEnvironment(args)
.tag('div')
--[[
.css('clear', 'both')
-- Returns a table with information about the environment, including title
.done()
-- objects and other namespace- or path-related data.
.wikitext(frame:expandTemplate{title = 'template sandbox notice', args = {args.livepage}})
-- @args - table of arguments passed by the user
return tostring(root)
--
else
-- Title objects include:
return nil
-- env.title - the page we are making documentation for (usually the current title)
-- env.templateTitle - the template (or module, file, etc.)
-- env.docTitle - the /doc subpage.
-- env.sandboxTitle - the /sandbox subpage.
-- env.testcasesTitle - the /testcases subpage.
--
-- Data includes:
-- env.subjectSpace - the number of the title's subject namespace.
-- 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.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.
--
-- All table lookups are passed through pcall so that errors are caught. If an error occurs, the value
-- returned will be nil.
--]]
local env, envFuncs = {}, {}
 
-- 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
-- more than once. (Nils won't be memoized.)
setmetatable(env, {
__index = function (t, key)
local envFunc = envFuncs[key]
if envFunc then
local success, val = pcall(envFunc)
if success then
env[key] = val -- Memoise the value.
return val
end
end
return nil
end
})
 
function envFuncs.title()
-- The title object for the current page, or a test page passed with args.page.
local title
local titleArg = args.page
if titleArg then
title = mw.title.new(titleArg)
else
title = mw.title.getCurrentTitle()
end
return title
end
end
end


function p.protectionTemplate()
function envFuncs.templateTitle()
if currentTitle.namespace == 10 then -- We are in the template namespace.
--[[
local frame = mw.getCurrentFrame()
-- The template (or module, etc.) title object.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
-- 'testcases-subpage' --> 'testcases'
--]]
local subjectSpace = env.subjectSpace
local title = env.title
local subpage = title.subpageText
if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then
return mw.title.makeTitle(subjectSpace, title.baseText)
else
return mw.title.makeTitle(subjectSpace, title.text)
end
end


local function getProtectionLevel(protectionType)
function envFuncs.docTitle()
-- Gets the protection level for the current page.
--[[
local level = frame:callParserFunction('PROTECTIONLEVEL', protectionType)
-- Title object of the /doc subpage.
if level ~= '' then
-- Messages:
return level
-- 'doc-subpage' --> 'doc'
else
--]]
return nil -- The parser function returns the blank string if there is no match.
local title = env.title
end
local docname = args[1] -- User-specified doc page.
local docpage
if docname then
docpage = docname
else
docpage = env.docpageBase .. '/' .. message('doc-subpage')
end
end
return mw.title.new(docpage)
end
function envFuncs.sandboxTitle()
--[[
-- Title object for the /sandbox subpage.
-- Messages:
-- 'sandbox-subpage' --> 'sandbox'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('sandbox-subpage'))
end
function envFuncs.testcasesTitle()
--[[
-- Title object for the /testcases subpage.
-- Messages:
-- 'testcases-subpage' --> 'testcases'
--]]
return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))
end


if getProtectionLevel('move') == 'sysop' or getProtectionLevel('edit') then
 
-- The page is full-move protected, or full, template, or semi-protected.
function envFuncs.subjectSpace()
return frame:expandTemplate{title = 'pp-template', args = {docusage = 'yes'}}
-- The subject namespace number.
return mw.site.namespaces[env.title.namespace].subject.id
end
 
function envFuncs.docSpace()
-- The documentation namespace number. For most namespaces this is the
-- same as the subject namespace. However, pages in the Article, File,
-- MediaWiki or Category namespaces must have their /doc, /sandbox and
-- /testcases pages in talk space.
local subjectSpace = env.subjectSpace
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
return subjectSpace + 1
else
return subjectSpace
end
end
end
end
return nil
end


function p.startBox(args)
function envFuncs.docpageBase()
-- Arg processing from {{documentation}}.
-- The base page of the /doc, /sandbox, and /testcases subpages.
local preload = args.preload -- Allow custom preloads.
-- For some namespaces this is the talk page, rather than the template page.
local heading = args.heading -- Blank values are not removed.
local templateTitle = env.templateTitle
local headingStyle = args['heading-style']
local docSpace = env.docSpace
local docSpaceText = mw.site.namespaces[docSpace].name
-- Assemble the link. docSpace is never the main namespace, so we can hardcode the colon.
return docSpaceText .. ':' .. templateTitle.text
end
function envFuncs.compareUrl()
-- Diff link between the sandbox and the main template using [[Special:ComparePages]].
local templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
if templateTitle.exists and sandboxTitle.exists then
local compareUrl = mw.uri.fullUrl(
'Special:ComparePages',
{ page1 = templateTitle.prefixedText, page2 = sandboxTitle.prefixedText}
)
return tostring(compareUrl)
else
return nil
end
end
 
return env
end
 
----------------------------------------------------------------------------
-- Start box
----------------------------------------------------------------------------
 
p.startBox = makeInvokeFunc('_startBox')
 
function p._startBox(args, env)
--[[
-- 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 content = args.content
local content = args.content
local docspace = p.docspace()
if not content or args[1] then
local docname = args[1] -- Other docname, if fed.
-- No need to include the links if the documentation is on the template page itself.
local templatePage = p.templatePage()
local linksData = p.makeStartBoxLinksData(args, env)
 
if linksData then
-- Arg processing from {{documentation/start box2}}.
links = p.renderStartBoxLinks(linksData)
local docpage
end
if docname then
end
docpage = docname
-- Generate the start box html.
local data = p.makeStartBoxData(args, env, links)
if data then
return p.renderStartBox(data)
else
else
local namespace = docspace or currentTitle.nsText
-- User specified no heading.
local pagename = templatePage or currentTitle.text
return nil
docpage = namespace .. ':' .. pagename .. '/doc'
end
end
local docTitle = mw.title.new(docpage)
end
local docExist = docTitle.exists
-- Output from {{documentation/start box}}.


-- First, check the heading parameter.
function p.makeStartBoxLinksData(args, env)
if heading == '' then
--[[
-- Heading is defined but blank, so do nothing.
-- Does initial processing of data to make the [view] [edit] [history] [purge] links.
-- @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'
-- '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 docTitle = env.docTitle
if not title or not docTitle then
return nil
return nil
end
if docTitle.isRedirect then
docTitle = docTitle.redirectTarget
end
end


-- Build the start box div.
local data = {}
local sbox = htmlBuilder.create('div')
data.title = title
sbox
data.docTitle = docTitle
.css('padding-bottom', '3px')
-- View, display, edit, and purge links if /doc exists.
.css('border-bottom', '1px solid #aaa')
data.viewLinkDisplay = message('view-link-display')
.css('margin-bottom', '1ex')
data.editLinkDisplay = message('edit-link-display')
data.historyLinkDisplay = message('history-link-display')
data.purgeLinkDisplay = message('purge-link-display')
-- Create link if /doc doesn't exist.
local preload = args.preload
if not preload then
if subjectSpace == 828 then -- Module namespace
preload = message('module-preload')
else
preload = message('docpage-preload')
end
end
data.preload = preload
data.createLinkDisplay = message('create-link-display')
return data
end
 
function p.renderStartBoxLinks(data)
--[[
-- Generates the [view][edit][history][purge] or [create][purge] 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


-- Make the heading.
local ret
local hspan = sbox.tag('span')
local docTitle = data.docTitle
if headingStyle then
local title = data.title
hspan.cssText(headingStyle)
local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)
elseif subjectSpace == 10 then
if docTitle.exists then
-- We are in the template or template talk namespaces.
local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)
hspan
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)
.css('font-weight', 'bold')
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)
.css('fond-size', '125%')
ret = '[%s] [%s] [%s] [%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)
else
else
hspan.css('font-size', '150%')
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)
ret = '[%s] [%s]'
ret = escapeBrackets(ret)
ret = mw.ustring.format(ret, createLink, purgeLink)
end
return ret
end
 
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'
-- 'testcases-create-link-display' --> 'create'
--]=]
local subjectSpace = env.subjectSpace
if not subjectSpace then
-- Default to an "other namespaces" namespace, so that we get at least some output
-- if an error occurs.
subjectSpace = 2
end
local data = {}
-- Heading
local heading = args.heading -- Blank values are not removed.
if heading == '' then
-- Don't display the start box if the heading arg is defined but blank.
return nil
end
end
if heading then
if heading then
-- "heading" has data.
data.heading = heading
hspan.wikitext(heading)
elseif subjectSpace == 10 then -- Template namespace
elseif subjectSpace == 10 then -- Template namespace
hspan.wikitext('[[File:Template-info.png|50px|link=|alt=Documentation icon]] Template documentation')
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('template-namespace-heading')
elseif subjectSpace == 828 then -- Module namespace
elseif subjectSpace == 828 then -- Module namespace
hspan.wikitext('[[File:Template-info.png|50px|link=|alt=Documentation icon]] Module documentation')
data.heading = message('documentation-icon-wikitext') .. ' ' .. message('module-namespace-heading')
elseif subjectSpace == 6 then -- File namespace
elseif subjectSpace == 6 then -- File namespace
hspan.wikitext('Summary')
data.heading = message('file-namespace-heading')
else
data.heading = message('other-namespaces-heading')
end
-- Heading CSS
local headingStyle = args['heading-style']
if headingStyle then
data.headingStyleText = headingStyle
else
else
hspan.wikitext('Documentation')
-- 'documentation-heading'
data.headingClass = message('main-div-heading-class')
end
-- Data for the [view][edit][history][purge] or [create] links.
if links then
-- 'mw-editsection-like plainlinks'
data.linksClass = message('start-box-link-classes')
data.links = links
end
end
return data
end


-- Add the [view][edit][history][purge] or [create] links.
function p.renderStartBox(data)
-- Check for the content parameter first, as we don't need the links if the documentation
-- Renders the start box html.
-- content is being entered directly onto the template page.
-- @data - a table of data generated by p.makeStartBoxData.
if not content then
local sbox = mw.html.create('div')
local lspan = sbox.tag('span') -- lspan is short for "link span".
sbox
lspan
-- 'documentation-startbox'
.addClass('mw-editsection plainlinks')
:addClass(message('start-box-class'))
.attr('id', 'doc_editlinks')
:newline()
if docExist then
:tag('span')
local viewLink = makeWikilink(docpage, 'view')
:addClass(data.headingClass)
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, 'edit')
:attr('id', 'documentation-heading')
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, 'history')
:cssText(data.headingStyleText)
local purgeLink = makeUrlLink(docTitle:fullUrl{action = 'purge'}, 'purge')
:wikitext(data.heading)
local text = '[%s] [%s] [%s] [%s]'
local links = data.links
text = text:gsub('%[', '&#91;') -- Replace square brackets with HTML entities.
if links then
text = text:gsub('%]', '&#93;')
sbox:tag('span')
lspan.wikitext(mw.ustring.format(text, viewLink, editLink, historyLink, purgeLink))
:addClass(data.linksClass)
else
:attr('id', data.linksId)
if not preload then
:wikitext(links)
if subjectSpace == 6 then -- File namespace
preload = 'Template:Documentation/preload-filespace'
else
preload = 'Template:Documentation/preload'
end
end
lspan.wikitext(makeUrlLink(docTitle:fullUrl{action = 'edit', preload = preload}, 'create'))
end
end
end
return tostring(sbox)
return tostring(sbox)
end
end


function p.content(args)
----------------------------------------------------------------------------
-- Documentation content
----------------------------------------------------------------------------
 
p.content = makeInvokeFunc('_content')
 
function p._content(args, env)
-- Displays the documentation contents
-- @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 content = args.content
local content = args.content
if not content then
if not content and docTitle and docTitle.exists then
local docpage = args[1]
content = args._content or mw.getCurrentFrame():expandTemplate{title = docTitle.prefixedText}
if docpage and mw.title.new(docpage).exists then
end
local frame = mw.getCurrentFrame()
if mw.site.siteName == "Miraheze Developers Wiki" and args.noexportinstructions ~= "yes" then
content = frame:preprocess('{{ ' .. docpage .. ' }}')
local export = mw.getCurrentFrame():expandTemplate{title="How to export"}
else
content = export .. "<br/>" .. (content or '')
docpage = p.docspace() .. ':' .. p.templatePage() .. '/doc'
if mw.title.new(docpage).exists then
local frame = mw.getCurrentFrame()
content = frame:preprocess('{{ ' .. docpage .. ' }}')
end
end
end
end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
-- The line breaks below are necessary so that "=== Headings ===" at the start and end
Line 234: Line 542:
end
end


function p.endBox(args)
p.contentTitle = makeInvokeFunc('_contentTitle')
-- Argument processing in {{documentation}}.
local preload = args.preload -- Allow custom preloads.
local content = args.content
local linkBox = args['link box'] -- So "link box=off" works.
local docspace = p.docspace()
local docname = args[1] -- Other docname, if fed.
local templatePage = p.templatePage()


-- Argument processing in {{documentation/end box2}}.
function p._contentTitle(args, env)
local docpageRoot = (docspace or currentTitle.nsText) .. ':' .. (templatePage or currentTitle.text)
env = env or p.getEnvironment(args)
local docpage
local docTitle = env.docTitle
if docname then
if not args.content and docTitle and docTitle.exists then
docpage = docname
return docTitle.prefixedText
else
else
docpage = docpageRoot .. '/doc'
return ''
end
end
local docTitle = mw.title.new(docpage)
end
local docExist = docTitle.exists
 
local docnameFed = args[1] and true
----------------------------------------------------------------------------
local sandbox = docpageRoot .. '/sandbox'
-- End box
local testcases = docpageRoot .. '/testcases'
----------------------------------------------------------------------------
templatePage = currentTitle.nsText .. ':' .. templatePage
 
p.endBox = makeInvokeFunc('_endBox')


-- Output from {{documentation/end box}}
function p._endBox(args, env)
--[=[
-- 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
--
--]=]
-- First, check whether we should output the end box at all. Add the end box by default if the documentation
-- Get environment data.
-- exists or if we are in the user, module or template namespaces.
env = env or p.getEnvironment(args)
if linkBox == 'off' or not (docExist or subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10) then
local subjectSpace = env.subjectSpace
local docTitle = env.docTitle
if not subjectSpace or not docTitle then
return nil
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
-- user, module or template namespaces.
local linkBox = args['link box']
if linkBox == 'off'
or not (
docTitle.exists
or subjectSpace == 2
or subjectSpace == 828
or subjectSpace == 10
)
then
return nil
return nil
end
end


-- Assemble the arguments for {{fmbox}}.
-- Assemble the link box.
local fmargs = {}
fmargs.id = 'documentation-meta-data'
fmargs.image = 'none'
fmargs.style = 'background-color: #ecfcf4'
fmargs.textstyle = 'font-style: italic;'
 
-- 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
if docExist then
text = text .. (p.makeDocPageBlurb(args, env) or '') -- "This documentation is transcluded from [[Foo]]."
-- /doc exists; link to it.
if subjectSpace == 2 or subjectSpace == 10 or subjectSpace == 828 then
local docLink = makeWikilink(docpage)
-- We are in the user, template or module namespaces.
local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, 'edit')
-- Add sandbox and testcases links.
local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, 'history')
-- "Editors can experiment in this template's sandbox and testcases pages."
text = text .. 'The above [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from '
text = text .. (p.makeExperimentBlurb(args, env) or '') .. '<br />'
.. docLink .. '. ' .. makeToolbar(editLink, historyLink) .. '<br />'
if not args.content and not args[1] then
elseif subjectSpace == 828 then
-- "Please add categories to the /doc subpage."
-- /doc does not exist; ask to create it.
-- Don't show this message with inline docs or with an explicitly specified doc page,
local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = 'Template:Documentation/preload-module-doc'}, 'create')
-- as then it is unclear where to add the categories.
text = text .. 'You might want to ' .. createLink .. ' a documentation page for this [[Wikipedia:Lua|Scribunto module]].<br />'
text = text .. (p.makeCategoriesBlurb(args, env) or '')
end
-- Add links to /sandbox and /testcases when appropriate.
if subjectSpace == 2 or subjectSpace == 828 or subjectSpace == 10 then
-- We are in the user, module or template namespaces.  
local pagePossessive = subjectSpace == 828 and "module's" or "template's"
text = text .. 'Editors can experiment in this ' .. pagePossessive .. ' '
local sandboxTitle = mw.title.new(sandbox)
if sandboxTitle.exists then
local sandboxLink = makeWikilink(sandbox, 'sandbox')
local sandboxEditLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit'}, 'edit')
local compareLink = makeUrlLink(mw.title.new('Special:ComparePages'):fullUrl{page1 = templatePage, page2 = sandbox}, 'diff')
text = text .. sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
local sandboxPreload = 'Template:Documentation/preload-' .. (subjectSpace == 828 and 'module-' or '') .. 'sandbox'
local sandboxCreateLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}, 'create')
local mirrorSummary = 'Create sandbox version of ' .. makeWikilink(templatePage)
local mirrorLink = makeUrlLink(sandboxTitle:fullUrl{action = 'edit', preload = templatePage, summary = mirrorSummary}, 'mirror')
text = text .. 'sandbox ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
text = text .. ' and '
local testcaseTitle = mw.title.new(testcases)
if testcaseTitle.exists then
local testcasesLink = makeWikilink(testcases, 'testcases')
local testcasesEditLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit'}, 'edit')
text = text .. testcasesLink .. ' ' .. makeToolbar(testcasesEditLink)
else
local testcasesPreload = 'Template:Documentation/preload-' .. (subjectSpace == 828 and 'module-' or '') .. 'testcases'
local testcasesCreateLink = makeUrlLink(testcaseTitle:fullUrl{action = 'edit', preload = testcasesPreload}, 'create')
text = text .. 'testcases ' .. makeToolbar(testcasesCreateLink)
end
text = text .. ' pages. <br />'
-- Show the categories text, but not if "content" fed or "docname fed" since then it is unclear where to add the categories.
if not content and not docnameFed then
text = text .. 'Please add categories to the ' .. makeWikilink(docpage, '/doc') .. ' subpage.'
end
-- Show the "subpages" link.
if subjectSpace ~= 6 then -- Don't show the link in file space.
local pagetype
if subjectSpace == 10 then
pagetype = 'template'
elseif subjectSpace == 828 then
pagetype = 'module'
else
pagetype = 'page'
end
text = text .. ' ' .. makeWikilink('Special:PrefixIndex/' .. templatePage .. '/', 'Subpages of this ' .. pagetype)
end
-- Show the "print" link if it exists.
local printPage = templatePage .. '/Print'
local printTitle = mw.title.new(printPage)
if printTitle.exists then
text = text .. '<br />A [[Help:Books/for experts#Improving the book layout|print version]] of this template exists at '
.. makeWikilink(printPage, '/Print') .. '. If you make a change to this template, please update the print version as well.'
.. '[[Category:Templates with print versions]]'
end
end
text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"
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 the fmbox output.
return '\n' .. tostring(box)
return messageBox.main('fmbox', fmargs)
end
end


function p.addTrackingCategories()
function p.makeDocPageBlurb(args, env)
-- Check if {{documentation}} is transcluded on a /doc or /testcases page.
--[=[
local ret = ''
-- Makes the blurb "This documentation is transcluded from [[Template:Foo]] (edit, history)".
local subpage = currentTitle.subpageText
-- @args - a table of arguments passed by the user
if subpage == 'doc' or subpage == 'testcases' then
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
local sort = (currentTitle.namespace == 0 and 'Main:' or '') .. currentTitle.prefixedText -- Sort on namespace.
--
ret = ret .. makeWikilink('Category:Wikipedia pages with strange ((documentation)) usage', sort)
-- Messages:
-- 'edit-link-display' --> 'edit'
-- 'history-link-display' --> 'history'
-- 'transcluded-from-blurb' -->
-- 'The above [[Wikipedia:Template documentation|documentation]]
-- is [[Help:Transclusion|transcluded]] from $1.'
-- 'module-preload' --> 'Template:Documentation/preload-module-doc'
-- 'create-link-display' --> 'create'
-- 'create-module-doc-blurb' -->
-- 'You might want to $1 a documentation page for this [[Wikipedia:Lua|Scribunto module]].'
--]=]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local ret
if docTitle.exists then
-- /doc exists; link to it.
local docLink = makeWikilink(docTitle.prefixedText)
local editUrl = docTitle:fullUrl{action = 'edit'}
local editDisplay = message('edit-link-display')
local editLink = makeUrlLink(editUrl, editDisplay)
local historyUrl = docTitle:fullUrl{action = 'history'}
local historyDisplay = message('history-link-display')
local historyLink = makeUrlLink(historyUrl, historyDisplay)
ret = message('transcluded-from-blurb', {docLink})
.. ' '
.. makeToolbar(editLink, historyLink)
.. '<br />'
elseif env.subjectSpace == 828 then
-- /doc does not exist; ask to create it.
local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}
local createDisplay = message('create-link-display')
local createLink = makeUrlLink(createUrl, createDisplay)
ret = message('create-module-doc-blurb', {createLink})
.. '<br />'
end
end
return ret
return ret
end
end


function p.docspace()
function p.makeExperimentBlurb(args, env)
-- Determines the namespace of the documentation.
--[[
if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then
-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."
-- Pages in the Article, File, MediaWiki or Category namespaces must have their
-- @args - a table of arguments passed by the user
-- /doc, /sandbox and /testcases pages in talk space.
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
return mw.site.namespaces[subjectSpace].talk.name
--
-- 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 templateTitle = env.templateTitle
local sandboxTitle = env.sandboxTitle
local testcasesTitle = env.testcasesTitle
local templatePage = templateTitle.prefixedText
if not subjectSpace or not templateTitle or not sandboxTitle or not testcasesTitle then
return nil
end
-- Make links.
local sandboxLinks, testcasesLinks
if sandboxTitle.exists then
local sandboxPage = sandboxTitle.prefixedText
local sandboxDisplay = message('sandbox-link-display')
local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)
local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}
local sandboxEditDisplay = message('sandbox-edit-link-display')
local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)
local compareUrl = env.compareUrl
local compareLink
if compareUrl then
local compareDisplay = message('compare-link-display')
compareLink = makeUrlLink(compareUrl, compareDisplay)
end
sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)
else
else
return currentTitle.subjectNsText
local sandboxPreload
if subjectSpace == 828 then
sandboxPreload = message('module-sandbox-preload')
else
sandboxPreload = message('template-sandbox-preload')
end
local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}
local sandboxCreateDisplay = message('sandbox-create-link-display')
local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)
local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})
local mirrorPreload = message('mirror-link-preload')
local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}
if subjectSpace == 828 then
mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = templateTitle.prefixedText, summary = mirrorSummary}
end
local mirrorDisplay = message('mirror-link-display')
local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)
sandboxLinks = message('sandbox-link-display') .. ' ' .. makeToolbar(sandboxCreateLink, mirrorLink)
end
end
if testcasesTitle.exists then
local testcasesPage = testcasesTitle.prefixedText
local testcasesDisplay = message('testcases-link-display')
local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)
local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}
local testcasesEditDisplay = message('testcases-edit-link-display')
local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)
-- for Modules, add testcases run link if exists
if 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
local testcasesPreload
if subjectSpace == 828 then
testcasesPreload = message('module-testcases-preload')
else
testcasesPreload = message('template-testcases-preload')
end
local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}
local testcasesCreateDisplay = message('testcases-create-link-display')
local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)
testcasesLinks = message('testcases-link-display') .. ' ' .. makeToolbar(testcasesCreateLink)
end
local messageName
if subjectSpace == 828 then
messageName = 'experiment-blurb-module'
else
messageName = 'experiment-blurb-template'
end
return message(messageName, {sandboxLinks, testcasesLinks})
end
function p.makeCategoriesBlurb(args, env)
--[[
-- Generates the text "Please add categories to the /doc subpage."
-- @args - a table of arguments passed by the user
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'doc-link-display' --> '/doc'
-- 'add-categories-blurb' --> 'Please add categories to the $1 subpage.'
--]]
local docTitle = env.docTitle
if not docTitle then
return nil
end
local docPathLink = makeWikilink(docTitle.prefixedText, message('doc-link-display'))
return message('add-categories-blurb', {docPathLink})
end
end


function p.templatePage()
function p.makeSubpagesBlurb(args, env)
-- Determines the template page. No namespace or interwiki prefixes are included.
--[[
local subpage = currentTitle.subpageText
-- Generates the "Subpages of this template" link.
if subpage == 'sandbox' or subpage == 'testcases' then
-- @args - a table of arguments passed by the user
return currentTitle.baseText
-- @env - environment table containing title objects, etc., generated with p.getEnvironment
-- Messages:
-- 'template-pagetype' --> 'template'
-- 'module-pagetype' --> 'module'
-- 'default-pagetype' --> 'page'
-- 'subpages-link-display' --> 'Subpages of this $1'
--]]
local subjectSpace = env.subjectSpace
local templateTitle = env.templateTitle
if not subjectSpace or not templateTitle then
return nil
end
local pagetype
if subjectSpace == 10 then
pagetype = message('template-pagetype')
elseif subjectSpace == 828 then
pagetype = message('module-pagetype')
else
else
return currentTitle.text
pagetype = message('default-pagetype')
end
end
local subpagesLink = makeWikilink(
'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',
message('subpages-link-display', {pagetype})
)
return message('subpages-blurb', {subpagesLink})
end
----------------------------------------------------------------------------
-- Tracking categories
----------------------------------------------------------------------------
function p.addTrackingCategories(env)
--[[
-- 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 subjectSpace = env.subjectSpace
if not title or not subjectSpace then
return nil
end
local subpage = title.subpageText
local ret = ''
if message('display-strange-usage-category', nil, 'boolean')
and (
subpage == message('doc-subpage')
or subjectSpace ~= 828 and subpage == message('testcases-subpage')
)
then
ret = ret .. makeCategoryLink(message('strange-usage-category'))
end
return ret
end
end


return p
return p
Retrieved from "https://meta.skywiki.org/wiki/Module:Documentation"