Module:Documentation: Difference between revisions

-- Get required modules.

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

-- Get the config table.

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

--]]

end

end

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

end

end

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

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

p.main = makeInvokeFunc('_main')

-- This function defines logic flow for the module.

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

--]]

local env = p.getEnvironment(args)

root

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

function envFuncs.docSpace()

local subjectSpace = env.subjectSpace

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

local templateTitle = env.templateTitle

local sandboxTitle = env.sandboxTitle

end

return env

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)

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

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

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

else

preload = message('docpage-preload')

function p.renderStartBoxLinks(data)

--[[

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

--]]

local ret

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 = mw.ustring.format(ret, viewLink, editLink, historyLink, purgeLink)

else

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'

--]=]

if headingStyle then

data.headingStyleText = headingStyle

else

end

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

if links then

data.links = links

end

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

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

--  

--]=]

-- Get environment data.

local subjectSpace = env.subjectSpace

local docTitle = env.docTitle

end

local text = ''

if linkBox then

text = text .. linkBox

else

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

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

end

end

end

end

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

-- 'The above [[Wikipedia:Template documentation|documentation]]  

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

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

end

--[[

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

-- 'mirror-edit-summary' --> 'Create sandbox version of $1'

-- 'mirror-link-display' --> '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'

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

function p.makeSubpagesBlurb(args, env)

local subjectSpace = env.subjectSpace

local templateTitle = env.templateTitle

return nil

end

local pagetype

if subjectSpace == 10 then

pagetype = message('default-pagetype')

end

'Special:PrefixIndex/' .. templateTitle.prefixedText .. '/',

message('subpages-link-display', {pagetype})

)

end

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

-- 'strange-usage-category' --> 'Wikipedia pages with strange ((documentation)) usage'

--]]

local title = env.title

local ret = ''

if message('display-strange-usage-category', nil, 'boolean')

then

end

return ret