Module:Documentation: Difference between revisions

-- Get required modules.

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

local messageBox = require('Module:Message box')

 

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

-- message('foo-message', {'baz', 'qux'}) would return "Foo qux bar baz."

--]]

--]]

local env = p.getEnvironment(args)

root

-- This div tag is from {{documentation/start box}}, but moving it here

-- so that we don't have to worry about unclosed tags.

return tostring(root)

end

--

-- 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.compareUrl - URL of the Special:ComparePages page comparing the sandbox with the template.

--

-- 'testcases-subpage' --> 'testcases'

--]]

local title = env.title

local subpage = title.subpageText

if subpage == message('sandbox-subpage') or subpage == message('testcases-subpage') then

else

end

end

docpage = docname

else

end

return mw.title.new(docpage)

-- 'sandbox-subpage' --> 'sandbox'

--]]

end

-- 'testcases-subpage' --> 'testcases'

--]]

end

--]]

return env.templateTitle:subPageTitle(message('print-subpage'))

end

 

end

 

-- The base page of the /doc, /sandbox, and /testcases subpages.

-- For some namespaces this is the talk page, rather than the template page.

local templateTitle = env.templateTitle

local sandboxTitle = env.sandboxTitle

end

 

--

-- Messages:

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

-- 'sandbox-notice-testcases-blurb' --> 'See also the companion subpage for $1.'

local sandboxTitle = env.sandboxTitle

local templateTitle = env.templateTitle

return nil

end

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

local text = ''

local templateLink = makeWikilink(templateTitle.prefixedText)

local compareUrl = env.compareUrl

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

local compareLink = makeUrlLink(compareUrl, compareDisplay)

end

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

local testcasesTitle = env.testcasesTitle

if testcasesTitle and testcasesTitle.exists then

end

-- Add the sandbox to the sandbox category.

text = text .. makeCategoryLink(message('sandbox-category'))

omargs.text = text

end

 

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

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

local title = env.title

return nil

end

end

end

 

-- which generate the box HTML.

--]]

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)

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

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

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

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

--]]

local title = env.title

local docTitle = env.docTitle

return nil

end

data.title = title

data.docTitle = docTitle

local preload = args.preload

if not preload then

preload = message('file-docpage-preload')

else

preload = message('docpage-preload')

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

--]]

local ret

local docTitle = data.docTitle

local purgeLink = makeUrlLink(title:fullUrl{action = 'purge'}, data.purgeLinkDisplay)

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

ret = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)

else

end

end

 

--

-- Messages:

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

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

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

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

-- 'start-box-link-id' --> 'doc_editlinks'

--]=]

local subjectSpace = env.subjectSpace

-- Renders the start box html.

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

sbox

local links = data.links

if links then

end

return tostring(sbox)

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

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

local docTitle = env.docTitle

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.

return '\n' .. (content or '') .. '\n'

end

 

 

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

-- Messages:

-- 'fmbox-id' --> 'documentation-meta-data'

--

-- Get environment data.

local subjectSpace = env.subjectSpace

local docTitle = env.docTitle

-- box by default if the documentation exists or if we are in the

-- user, module or template namespaces.

if linkBox == 'off'

or not (

local text = ''

if linkBox then

text = text .. linkBox

else

text = text .. '<br />'

text = text .. (p.makeCategoriesBlurb(args, env) or '')

end

if printBlurb then

text = text .. '<br />' .. printBlurb

fmargs.text = text

 

return messageBox.main('fmbox', fmargs)

end

 

function p.makeDocPageBlurb(args, env)

local docTitle = env.docTitle

if not docTitle then

return nil

end

local ret

if docTitle.exists then

end

 

-- Renders the text "Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages."

local subjectSpace = env.subjectSpace

local templateTitle = env.templateTitle

local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)

local mirrorSummary = message('mirror-edit-summary', {makeWikilink(templatePage)})

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

end

return message(messageName, {sandboxLinks, testcasesLinks})

end

 

 

function p.addTrackingCategories(env)

-- Check if {{documentation}} is transcluded on a /doc or /testcases page.

local title = env.title

local subpage = title.subpageText

end

return ret