Module:Documentation: Difference between revisions

Help

-- Get required modules.

local getArgs = require('Module:Arguments').getArgs

 

-- Get the config table.

local cfg = mw.loadData('Module:Documentation/config')

local p = {}

 

expectType = expectType or 'string'

if type(msg) ~= expectType then

end

if not valArray then

local function getMessageVal(match)

match = tonumber(match)

end

 

end

 

ret[#ret + 1] = select(i, ...)

end

end

 

 

----------------------------------------------------------------------------

----------------------------------------------------------------------------

 

end

 

 

function p._main(args)

-- 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

:wikitext(p.protectionTemplate(env))

:wikitext(p.sandboxNotice(args, env))

:tag('div')

:done()

:wikitext(p.addTrackingCategories(env))

end

 

function p.getEnvironment(args)

--[[

-- @args - table of arguments passed by the user

--

-- env.sandboxTitle - the /sandbox subpage.

-- env.testcasesTitle - the /testcases subpage.

--

-- Data includes:

--]]

return mw.title.new(env.docpageBase .. '/' .. message('testcases-subpage'))

end

 

 

function envFuncs.docSpace()

local subjectSpace = env.subjectSpace

if subjectSpace == 0 or subjectSpace == 6 or subjectSpace == 8 or subjectSpace == 14 then

local compareUrl = mw.uri.fullUrl(

'Special:ComparePages',

)

return tostring(compareUrl)

-- Auxiliary templates

----------------------------------------------------------------------------

 

function p.sandboxNotice(args, env)

--

-- Messages:

-- 'sandbox-notice-blurb' --> 'This is the $1 for $2.'

-- 'sandbox-notice-diff-blurb' --> 'This is the $1 for $2 ($3).'

-- 'sandbox-notice-pagetype-other' --> 'sandbox page'

-- 'sandbox-notice-compare-link-display' --> 'diff'

local templateTitle = env.templateTitle

local subjectSpace = env.subjectSpace

return nil

end

-- "This is the template sandbox for [[Template:Foo]] (diff)."

local text = ''

local pagetype

if subjectSpace == 10 then

local templateLink = makeWikilink(templateTitle.prefixedText)

local compareUrl = env.compareUrl

local compareDisplay = message('sandbox-notice-compare-link-display')

local compareLink = makeUrlLink(compareUrl, compareDisplay)

text = text .. message('sandbox-notice-diff-blurb', {pagetype, templateLink, compareLink})

end

-- Get the test cases page blurb if the page exists. This is something like

end

-- Add the sandbox to the sandbox category.

end

 

-- 'protection-template' --> 'pp-template'

-- 'protection-template-args' --> {docusage = 'yes'}

if not protectionLevels then

return nil

end

else

return nil

local links

local content = args.content

-- No need to include the links if the documentation is on the template page itself.

local linksData = p.makeStartBoxLinksData(args, env)

-- 'history-link-display' --> 'history'

-- 'purge-link-display' --> 'purge'

-- 'module-preload' --> 'Template:Documentation/preload-module-doc'

-- 'docpage-preload' --> 'Template:Documentation/preload'

data.docTitle = docTitle

-- View, display, edit, and purge links if /doc exists.

-- Create link if /doc doesn't exist.

local preload = args.preload

if not preload then

preload = message('module-preload')

else

end

data.preload = preload

return data

end

function p.renderStartBoxLinks(data)

--[[

-- @data - a table of data generated by p.makeStartBoxLinksData

--]]

local docTitle = data.docTitle

local title = data.title

if docTitle.exists then

local viewLink = makeWikilink(docTitle.prefixedText, data.viewLinkDisplay)

local editLink = makeUrlLink(docTitle:fullUrl{action = 'edit'}, data.editLinkDisplay)

local historyLink = makeUrlLink(docTitle:fullUrl{action = 'history'}, data.historyLinkDisplay)

ret = '[%s] [%s] [%s] [%s]'

ret = escapeBrackets(ret)

else

local createLink = makeUrlLink(docTitle:fullUrl{action = 'edit', preload = data.preload}, data.createLinkDisplay)

ret = escapeBrackets(ret)

end

return ret

--

-- Messages:

-- 'template-namespace-heading' --> 'Template documentation'

-- 'module-namespace-heading' --> 'Module documentation'

-- 'file-namespace-heading' --> 'Summary'

-- 'other-namespaces-heading' --> 'Documentation'

-- 'testcases-create-link-display' --> 'create'

--]=]

data.heading = heading

elseif subjectSpace == 10 then -- Template namespace

elseif subjectSpace == 828 then -- Module namespace

elseif subjectSpace == 6 then -- File namespace

else

end

-- Data for the [view][edit][history][purge] or [create] links.

if links then

data.links = links

end

local sbox = mw.html.create('div')

sbox

:wikitext(data.heading)

local links = data.links

if links then

end

return tostring(sbox)

local content = args.content

if not content and docTitle and docTitle.exists then

end

-- The line breaks below are necessary so that "=== Headings ===" at the start and end

-- of docs are interpreted correctly.

end

 

-- @args - a table of arguments passed by the user

-- @env - environment table containing title objects, etc., generated with p.getEnvironment

--]=]

end

 

local text = ''

if linkBox then

-- Add sandbox and testcases links.

-- "Editors can experiment in this template's sandbox and testcases pages."

if not args.content and not args[1] then

-- "Please add categories to the /doc subpage."

end

text = text .. ' ' .. (p.makeSubpagesBlurb(args, env) or '') --"Subpages of this template"

end

end

:wikitext(text)

end

 

-- 'history-link-display' --> 'history'

-- 'transcluded-from-blurb' -->

-- 'module-preload' --> 'Template:Documentation/preload-module-doc'

-- 'create-link-display' --> 'create'

-- 'create-module-doc-blurb' -->

--]=]

local docTitle = env.docTitle

return nil

end

local docLink = makeWikilink(docTitle.prefixedText)

local editUrl = docTitle:fullUrl{action = 'edit'}

local editLink = makeUrlLink(editUrl, editDisplay)

local historyUrl = docTitle:fullUrl{action = 'history'}

local historyLink = makeUrlLink(historyUrl, historyDisplay)

ret = message('transcluded-from-blurb', {docLink})

-- /doc does not exist; ask to create it.

local createUrl = docTitle:fullUrl{action = 'edit', preload = message('module-preload')}

local createLink = makeUrlLink(createUrl, createDisplay)

ret = message('create-module-doc-blurb', {createLink})

local mirrorPreload = message('mirror-link-preload')

local mirrorUrl = sandboxTitle:fullUrl{action = 'edit', preload = mirrorPreload, summary = mirrorSummary}

local mirrorDisplay = message('mirror-link-display')

local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)

local testcasesEditDisplay = message('testcases-edit-link-display')

local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)

else

local testcasesPreload

)

return message('subpages-blurb', {subpagesLink})

end