Module:Documentation: Difference between revisions

-- This module implements {{documentation}}.

-- Get required modules.

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

-- Get the config table.

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

local p = {}

-- Often-used functions.

local ugsub = mw.ustring.gsub

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

-- Helper functions

-- table for testing purposes.

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

local function message(cfgKey, valArray, expectType)

--[[

return msg

end

local function getMessageVal(match)

match = tonumber(match)

return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)

end

end

p.message = message

local function makeWikilink(page, display)

if display then

end

end

p.makeWikilink = makeWikilink

local function makeCategoryLink(cat, sort)

local catns = mw.site.namespaces[14].name

return makeWikilink(catns .. ':' .. cat, sort)

end

p.makeCategoryLink = makeCategoryLink

local function makeUrlLink(url, display)

return mw.ustring.format('[%s %s]', url, display)

end

p.makeUrlLink = makeUrlLink

local function makeToolbar(...)

local ret = {}

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

end

end

p.makeToolbar = makeToolbar

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

-- Argument processing

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

local function makeInvokeFunc(funcName)

return function (frame)

end

end

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

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

p.main = makeInvokeFunc('_main')

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)

root

end

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

-- Environment settings

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

function p.getEnvironment(args)

--[[

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

--

-- env.sandboxTitle - the /sandbox subpage.

-- env.testcasesTitle - the /testcases subpage.

--

-- Data includes:

-- returned will be nil.

--]]

local env, envFuncs = {}, {}

-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value

-- returned by that function is memoized in the env table so that we don't call any of the functions

end

})

function envFuncs.title()

-- The title object for the current page, or a test page passed with args.page.

return title

end

function envFuncs.templateTitle()

--[[

end

end

function envFuncs.docTitle()

--[[

return mw.title.new(docpage)

end

function envFuncs.sandboxTitle()

--[[

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

end

function envFuncs.testcasesTitle()

--[[

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

end

function envFuncs.subjectSpace()

-- The subject namespace number.

return mw.site.namespaces[env.title.namespace].subject.id

end

function envFuncs.docSpace()

local subjectSpace = env.subjectSpace

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

end

end

function envFuncs.docpageBase()

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

return docSpaceText .. ':' .. templateTitle.text

end

function envFuncs.compareUrl()

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

local compareUrl = mw.uri.fullUrl(

'Special:ComparePages',

)

return tostring(compareUrl)

end

end

return env

end

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

-- Start box

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

p.startBox = makeInvokeFunc('_startBox')

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)

end

end

function p.makeStartBoxLinksData(args, env)

--[[

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

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

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

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

return nil

end

local data = {}

data.title = title

local preload = args.preload

if not preload then

preload = message('module-preload')

else

return data

end

function p.renderStartBoxLinks(data)

--[[

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

--]]

local function escapeBrackets(s)

-- Escapes square brackets with HTML entities.

return s

end

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 = escapeBrackets(ret)

else

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

ret = escapeBrackets(ret)

end

return ret

end

function p.makeStartBoxData(args, env, links)

--[=[

--

-- Messages:

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

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

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

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

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

--]=]

end

local data = {}

-- Heading

local heading = args.heading -- Blank values are not removed.

data.heading = message('other-namespaces-heading')

end

-- Heading CSS

local headingStyle = args['heading-style']

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

return data

end

function p.renderStartBox(data)

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

end

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

-- Documentation content

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

p.content = makeInvokeFunc('_content')

function p._content(args, env)

-- Displays the documentation contents

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

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

end

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

-- End box

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

p.endBox = makeInvokeFunc('_endBox')

function p._endBox(args, env)

--[=[

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

--  

--]=]

-- Get environment data.

env = env or p.getEnvironment(args)

return nil

end

-- Check whether we should output the end box at all. Add the end

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

return nil

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

end

function p.makeDocPageBlurb(args, env)

--[=[

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

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

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

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

return ret

end

function p.makeExperimentBlurb(args, env)

--[[

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

return message(messageName, {sandboxLinks, testcasesLinks})

end

function p.makeCategoriesBlurb(args, env)

--[[

return message('add-categories-blurb', {docPathLink})

end

function p.makeSubpagesBlurb(args, env)

--[[

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

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

-- Messages:

-- 'template-pagetype' --> 'template'

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

end

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

-- Tracking categories

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

function p.addTrackingCategories(env)

--[[

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

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

-- Messages:

-- 'display-strange-usage-category' --> true

return ret

end

return p