Module:Documentation: Difference between revisions

m
reflect changes to our config
No edit summary
m>Jackmcbarn
m (reflect changes to our config)
Line 1: Line 1:
-- This module implements {{documentation}}.
-- This module implements {{documentation}}.
 
-- Get required modules.
-- Get required modules.
local getArgs = require('Module:Arguments').getArgs
local getArgs = require('Module:Arguments').getArgs
local htmlBuilder = require('Module:HtmlBuilder')
local htmlBuilder = require('Module:HtmlBuilder')
local messageBox = require('Module:Message box')
local messageBox = require('Module:Message box')
 
-- Get the config table.
-- Get the config table.
local cfg = mw.loadData('Module:Documentation/config')
local cfg = mw.loadData('Module:Documentation/config')
 
local p = {}
local p = {}
 
-- Often-used functions.
-- Often-used functions.
local ugsub = mw.ustring.gsub
local ugsub = mw.ustring.gsub
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Helper functions
-- Helper functions
Line 20: Line 20:
-- table for testing purposes.
-- table for testing purposes.
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
local function message(cfgKey, valArray, expectType)
local function message(cfgKey, valArray, expectType)
--[[
--[[
Line 39: Line 39:
return msg
return msg
end
end
 
local function getMessageVal(match)
local function getMessageVal(match)
match = tonumber(match)
match = tonumber(match)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
return valArray[match] or error('message: no value found for key $' .. match .. ' in message cfg.' .. cfgKey, 4)
end
end
 
local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
local ret = ugsub(msg, '$([1-9][0-9]*)', getMessageVal)
return ret
return ret
end
end
 
p.message = message
p.message = message
 
local function makeWikilink(page, display)
local function makeWikilink(page, display)
if display then
if display then
Line 58: Line 58:
end
end
end
end
 
p.makeWikilink = makeWikilink
p.makeWikilink = makeWikilink
 
local function makeCategoryLink(cat, sort)
local function makeCategoryLink(cat, sort)
local catns = mw.site.namespaces[14].name
local catns = mw.site.namespaces[14].name
return makeWikilink(catns .. ':' .. cat, sort)
return makeWikilink(catns .. ':' .. cat, sort)
end
end
 
p.makeCategoryLink = makeCategoryLink
p.makeCategoryLink = makeCategoryLink
 
local function makeUrlLink(url, display)
local function makeUrlLink(url, display)
return mw.ustring.format('[%s %s]', url, display)
return mw.ustring.format('[%s %s]', url, display)
end
end
 
p.makeUrlLink = makeUrlLink
p.makeUrlLink = makeUrlLink
 
local function makeToolbar(...)
local function makeToolbar(...)
local ret = {}
local ret = {}
Line 85: Line 85:
return '<small style="font-style: normal;">(' .. table.concat(ret, ' &#124; ') .. ')</small>'
return '<small style="font-style: normal;">(' .. table.concat(ret, ' &#124; ') .. ')</small>'
end
end
 
p.makeToolbar = makeToolbar
p.makeToolbar = makeToolbar
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Argument processing
-- Argument processing
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
local function makeInvokeFunc(funcName)
local function makeInvokeFunc(funcName)
return function (frame)
return function (frame)
Line 111: Line 111:
end
end
end
end
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Main function
-- Main function
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
p.main = makeInvokeFunc('_main')
p.main = makeInvokeFunc('_main')
 
function p._main(args)
function p._main(args)
--[[
--[[
Line 150: Line 150:
return tostring(root)
return tostring(root)
end
end
 
----------------------------------------------------------------------------
----------------------------------------------------------------------------
-- Environment settings
-- Environment settings
----------------------------------------------------------------------------
----------------------------------------------------------------------------
 
function p.getEnvironment(args)
function p.getEnvironment(args)
--[[
--[[
Line 179: Line 179:
-- returned will be nil.
-- returned will be nil.
--]]
--]]
local env, envFuncs = {}, {}
local env, envFuncs = {}, {}
 
-- Set up the metatable. If triggered we call the corresponding function in the envFuncs table. The value
-- 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
-- returned by that function is memoized in the env table so that we don't call any of the functions
Line 198: Line 198:
end
end
})
})
 
function envFuncs.title()
function envFuncs.title()
-- The title object for the current page, or a test page passed with args.page.
-- The title object for the current page, or a test page passed with args.page.
Line 210: Line 210:
return title
return title
end
end
 
function envFuncs.templateTitle()
function envFuncs.templateTitle()
--[[
--[[
Line 227: Line 227:
end
end
end
end
 
function envFuncs.docTitle()
function envFuncs.docTitle()
--[[
--[[