-- Define constantslocal ROOT_PAGE = 'Module:Find sources'local TEMPLATE_LIST = ROOT_PAGE .. '/templates' -- template config module listlocal TEMPLATE_ROOT = TEMPLATE_LIST .. '/' -- template config module prefixlocal LINK_CONFIG = ROOT_PAGE .. '/links' -- link config module listlocal AUTODOC_SUFFIX = '/autodoc'
-- Load necessary modules.local mFindSources = require('Module:Find sources')local cfg = mw.loadData('Module:Find sources/autodoc/config')
local p =
local function maybeLoadData(page) local success, data = pcall(mw.loadData, page) return success and dataend
local function substituteParams(msg, ...) return mw.message.newRawMessage(msg, ...):plainend
local function sortKeys(t) local ret = for k in pairs(t) do ret[#ret + 1] = k end table.sort(ret) return retend
local function isValidLinkCfg(linkCfg) if type(linkCfg) ~= 'table' then return false end for _, s in ipairs do if type(linkCfg[s]) ~= 'string' then return false end end for _, s in ipairs do if linkCfg[s] ~= nil and type(linkCfg[s]) ~= 'string' then return false end end return trueend
local function isValidLink(code) if type(code) ~= 'string' or code
local function isValidTemplateCfg(templateCfg) if type(templateCfg) ~= 'table' then return false end for _, s in ipairs do if type(templateCfg[s]) ~= 'string' then return false end end for _, s in ipairs do if templateCfg[s] ~= nil and type(templateCfg[s]) ~= 'string' then return false end end if templateCfg.isUsedInMainspace and templateCfg.isUsedInMainspace ~= true then return false end if type(templateCfg.links) ~= 'table' then return false end
local function isValidLinkTable(t) if type(t) ~= 'table' then return false end if type(t.code) ~= 'string' then return false end if t.display and type(t.display) ~= 'string' then return false end return true end
if templateCfg.introLink and not isValidLinkTable(templateCfg.introLink) then return false end for _, t in ipairs(templateCfg.links) do if not isValidLinkTable(t) then return false end end
return trueend
local function isValidTemplate(template) if type(template) ~= 'string' or template
local function isValidTemplateAutdocCfg(t) if type(t) ~= 'table' then return false end for _, s in ipairs do if t[s] and type(t[s]) ~= 'string' then return false end end if t.shortcuts and type(t.shortcuts) ~= 'table' then return false elseif t.shortcuts then for _, s in ipairs(t.shortcuts) do if type(s) ~= 'string' then return false end end end return trueend
local function makeWikitable(headers, rows) local ret =
-- Table start ret[#ret + 1] = '
| -' for i, header in ipairs(headers) do ret[#ret + 1] = '! scope="col | ' .. header end -- Rows for i, row in ipairs(rows) do ret[#ret + 1] = ' | -' for j, cell in ipairs(row) do if j 1 then ret[#ret + 1] = '! scope="row" | ' .. cell else ret[#ret + 1] = ' | ' .. cell end end end -- Table end ret[#ret + 1] = ' |
return table.concat(ret, '\n')end
local function grey(s) return string.format('
%s', s)endlocal function colspan(s, n) return string.format('colspan="%d" | %s', n, s)end
local function makeWikitextError(msg) return string.format('%s', msg)end
local function makeWikilink(page, display) if display then return string.format('%s', page, display) else return string.format('%s', page) endend
function p.linkTable local codes = sortKeys(require(LINK_CONFIG)) local headers = local rows = local links = maybeLoadData(LINK_CONFIG) for i, code in ipairs(codes) do if isValidLink(code) then
local linkData = links[code]
-- Make the example link. local success, link = pcall(mFindSources._renderLink, code, ) if not success then link = makeWikitextError(link) end
-- Build the row. local row = rows[i] = row else local msg = substituteParams(cfg['invalid-link-config-error'], code) msg = makeWikitextError(msg) msg = colspan(msg, 5) rows[i] = end end return makeWikitable(headers, rows)end
function p.templateTable local templates = sortKeys(require(TEMPLATE_LIST)) local headers = local rows = for i, template in ipairs(templates) do if isValidTemplate(template) then local configPage = TEMPLATE_ROOT .. template local autodocConfigPage = configPage .. AUTODOC_SUFFIX local templateData = maybeLoadData(autodocConfigPage) if not isValidTemplateAutdocCfg(templateData) then templateData = end
-- Make the example text local success, example = pcall(mFindSources._main, template, ) if not success then example = makeWikitextError(example) end
-- Build the row. local row = rows[i] = row else local msg = substituteParams(cfg['invalid-template-config-error'], TEMPLATE_ROOT .. template ) msg = makeWikitextError(msg) msg = colspan(msg, 4) rows[i] = end end return makeWikitable(headers, rows)end
local function documentation(template) -- This function makes documentation for the template specified in -- the template parameter. The template should be without the "Template:" -- prefix.
-- Load necessary modules local mDocumentation = require('Module:Documentation') local mList = require('Module:List') local frame = mw.getCurrentFrame
-- Load the config files local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template) if not isValidTemplateCfg(templateCfg) then error(substituteParams(cfg['invalid-template-name-error'], template, TEMPLATE_ROOT .. template )) end local autodocCfg = maybeLoadData(TEMPLATE_ROOT .. template .. AUTODOC_SUFFIX) if not isValidTemplateAutdocCfg(autodocCfg) then autodocCfg = end
-- Get the documentation content local content do -- Shortcuts local shortcuts if autodocCfg.shortcuts then shortcuts = frame:expandTemplate end
-- Link descriptions local codes = if templateCfg.introLink then codes[#codes + 1] = templateCfg.introLink.code end for _, t in ipairs(templateCfg.links) do codes[#codes + 1] = t.code end
local links = maybeLoadData(LINK_CONFIG) for i, code in ipairs(codes) do if links[code] then codes[i] = links[code].description or code else codes[i] = code end end local linkDescriptions = mList.bulleted(codes)
-- Build the content. content = frame:expandTemplate end
return mDocumentation.mainend
setmetatable(p,)
return p