Module:Documentation: Difference between revisions

-- Get required modules.

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

 

-- Get the config table.

-- Often-used functions.

local ugsub = mw.ustring.gsub

 

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

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

 

--[[

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

 

end

 

local function makeWikilink(page, display)

if display then

else

end

end

 

local function makeUrlLink(url, display)

end

 

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

end

end

 

p.makeToolbar = makeToolbar

 

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

 

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

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

 

p.main = makeInvokeFunc('_main')

 

function p._main(args)

local env = p.getEnvironment(args)

root

end

 

function p.getEnvironment(args)

--[[

--

-- Title objects include:

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

--

if titleArg then

title = mw.title.new(titleArg)

else

title = mw.title.getCurrentTitle()

 

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)

function envFuncs.sandboxTitle()

-- Title object for the /sandbox subpage.

end

function envFuncs.testcasesTitle()

-- Title object for the /testcases subpage.

end

end

 

 

function envFuncs.docSpace()

local subjectSpace = env.subjectSpace

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

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

 

-- Auxiliary templates

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

 

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)

local compareUrl = env.compareUrl

local compareLink = makeUrlLink(compareUrl, compareDisplay)

end

local testcasesTitle = env.testcasesTitle

if testcasesTitle and testcasesTitle.exists then

end

end

 

function p.protectionTemplate(env)

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)

 

function p.makeStartBoxLinksData(args, env)

local title = env.title

local docTitle = env.docTitle

return nil

end

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

local preload = args.preload

if not preload then

else

end

end

end

 

function p.renderStartBoxLinks(data)

local docTitle = data.docTitle

if docTitle.exists then

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

else

end

end

 

function p.makeStartBoxData(args, env, links)

local subjectSpace = env.subjectSpace

if not subjectSpace then

data.heading = heading

elseif subjectSpace == 10 then -- Template namespace

elseif subjectSpace == 828 then -- Module namespace

elseif subjectSpace == 6 then -- File namespace

else

end

if headingStyle then

data.headingStyleText = headingStyle

else

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

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

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

end

 

local text = ''

if linkBox then

text = text .. linkBox

else

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

end

end

end

 

end

 

function p.makeDocPageBlurb(args, env)

local docTitle = env.docTitle

if not docTitle then

return nil

end

if docTitle.exists then

-- /doc exists; link to it.

local docLink = makeWikilink(docTitle.prefixedText)

.. ' '

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

if sandboxTitle.exists then

local sandboxPage = sandboxTitle.prefixedText

local sandboxLink = makeWikilink(sandboxPage, sandboxDisplay)

local compareUrl = env.compareUrl

local compareLink

if compareUrl then

compareLink = makeUrlLink(compareUrl, compareDisplay)

end

local sandboxPreload

if subjectSpace == 828 then

else

end

local sandboxCreateLink = makeUrlLink(sandboxCreateUrl, sandboxCreateDisplay)

local mirrorLink = makeUrlLink(mirrorUrl, mirrorDisplay)

end

if testcasesTitle.exists then

local testcasesPage = testcasesTitle.prefixedText

local testcasesLink = makeWikilink(testcasesPage, testcasesDisplay)

else

local testcasesPreload

if subjectSpace == 828 then

else

end

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

end