Module:Documentation: Difference between revisions

-- Get required modules.

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

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

 

 

-- Often-used functions.

 

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

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

 

--[[

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

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

--]]

local msg = cfg[cfgKey]

error('message: type error in message cfg.' .. cfgKey .. ' (' .. expectType .. ' expected, got ' .. type(msg) .. ')', 2)

end

end

 

return ret

end

 

p.makeToolbar = makeToolbar

 

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

 

function p._main(args)

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

 

function p.getEnvironment(args)

--

-- Data includes:

-- env.subjectSpace - the number of the title's subject namespace.

local env, envFuncs = {}, {}

 

setmetatable(env, {

__index = function (t, key)

if titleArg then

title = mw.title.new(titleArg)

else

title = mw.title.getCurrentTitle()

end

return title

end

 

function envFuncs.templateTitle()

-- The template (or module, etc.) title object.

local title = env.title

local subpage = title.subpageText

else

end

end

 

function envFuncs.docTitle()

-- Title object of the /doc subpage.

local title = env.title

local docname = args[1] -- User-specified doc page.

docpage = docname

else

end

return mw.title.new(docpage)

end

function envFuncs.sandboxTitle()

-- Title object for the /sandbox subpage.

end

function envFuncs.testcasesTitle()

-- Title object for the /testcases subpage.

end

function envFuncs.printTitle()

-- Title object for the /Print subpage.

end

-- Diff link between the sandbox and the main template using [[Special:ComparePages]].

local templateTitle = env.templateTitle

local sandboxTitle = env.sandboxTitle

end

 

 

function p.sandboxNotice(args, env)

local title = env.title

local sandboxTitle = env.sandboxTitle

local templateTitle = env.templateTitle

return nil

end

-- Get the text. We start with the opening blurb, which is something like

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

local text = ''

local templateLink = makeWikilink(templateTitle.prefixedText)

else

end

local testcasesTitle = env.testcasesTitle

if testcasesTitle and testcasesTitle.exists then

end

omargs.text = text

end

 

function p.protectionTemplate(env)

local title = env.title

return nil

end

end

end

 

 

function p._startBox(args, env)

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)

links = p.renderStartBoxLinks(linksData)

end

end

-- Generate the start box html.

local data = p.makeStartBoxData(args, env, links)

return p.renderStartBox(data)

else

-- User specified no heading.

 

function p.makeStartBoxLinksData(args, env)

local title = env.title

local docTitle = env.docTitle

return nil

end

data.title = title

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

else

end

end

data.preload = preload

return data

end

 

function p.renderStartBoxLinks(data)

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

 

function p.makeStartBoxData(args, env, links)

local subjectSpace = env.subjectSpace

if not subjectSpace then

end

local data = {}

data.heading = heading

elseif subjectSpace == 10 then -- Template namespace

elseif subjectSpace == 828 then -- Module namespace

elseif subjectSpace == 6 then -- File namespace

else

end

end

if links then

data.links = links

end

function p.renderStartBox(data)

-- Renders the start box html.

sbox

local links = data.links

if links then

end

return tostring(sbox)

 

function p._content(args, env)

local docTitle = env.docTitle

local content = args.content

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

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

-- Assemble the arguments for {{fmbox}}.

local fmargs = {}

 

-- Assemble the fmbox text field.

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

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)

.. ' '

.. makeToolbar(editLink, historyLink)

elseif env.subjectSpace == 828 then

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

local createLink = makeUrlLink(createUrl, createDisplay)

.. '<br />'

end

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 sandboxTitle = env.sandboxTitle

local testcasesTitle = env.testcasesTitle

return nil

end

if sandboxTitle.exists then

local sandboxPage = sandboxTitle.prefixedText

local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)

local sandboxEditUrl = sandboxTitle:fullUrl{action = 'edit'}

local sandboxEditLink = makeUrlLink(sandboxEditUrl, sandboxEditDisplay)

sandboxLinks = sandboxLink .. ' ' .. makeToolbar(sandboxEditLink, compareLink)

else

local sandboxPreload

if subjectSpace == 828 then

else

end

local sandboxCreateUrl = sandboxTitle:fullUrl{action = 'edit', preload = sandboxPreload}

local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)

local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)

end

if testcasesTitle.exists then

local testcasesPage = testcasesTitle.prefixedText

local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)

local testcasesEditUrl = testcasesTitle:fullUrl{action = 'edit'}

local testcasesEditLink = makeUrlLink(testcasesEditUrl, testcasesEditDisplay)

else

local testcasesPreload

if subjectSpace == 828 then

else

end

local testcasesCreateUrl = testcasesTitle:fullUrl{action = 'edit', preload = testcasesPreload}

local testcasesCreateLink = makeUrlLink(testcasesCreateUrl, testcasesCreateDisplay)

end

local messageName

if subjectSpace == 828 then

else

end

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