Module:Find sources/autodoc - Revision history

Gonnym: use proper scopes which automatically apply bold

2021-12-06T10:15:44Z

use proper scopes which automatically apply bold

← Previous revision		Revision as of 10:15, 6 December 2021
Line 140:		Line 140:
	ret[#ret + 1] = '\|-'		ret[#ret + 1] = '\|-'
	for i, header in ipairs(headers) do		for i, header in ipairs(headers) do
	ret[#ret + 1] = '! ' .. header		ret[#ret + 1] = '! scope="col \| ' .. header
	end		end

Line 147:		Line 147:
	ret[#ret + 1] = '\|-'		ret[#ret + 1] = '\|-'
	for j, cell in ipairs(row) do		for j, cell in ipairs(row) do
	~~ret[#ret~~ ~~+ 1]~~ = ~~'\| ' ..~~ ~~cell~~		if j == 1 then
			ret[#ret + 1] = '! scope="row" \| ' .. cell
			else
			ret[#ret + 1] = '\| ' .. cell
		⚫	end
	end		end
	end		end
Line 159:		Line 163:
	local function grey(s)		local function grey(s)
	return string.format('<span style="color: gray;">%s</span>', s)		return string.format('<span style="color: gray;">%s</span>', s)
⚫	end

	local function bold(s)
	return string.format("'''%s'''", s)
	end		end

Line 208:		Line 208:
	-- Build the row.		-- Build the row.
	local row = {		local row = {
	~~bold(~~code),		code,
	linkData.description or grey("''No description available''"),		linkData.description or grey("''No description available''"),
	link,		link,
Line 254:		Line 254:
	-- Build the row.		-- Build the row.
	local row = {		local row = {
	~~bold(~~makeWikilink(mw.site.namespaces[10].name .. ':' .. template, template)),		makeWikilink(mw.site.namespaces[10].name .. ':' .. template, template),
	templateData.description or grey("''No description available''"),		templateData.description or grey("''No description available''"),
	example,		example,

Gonnym: synced changes from /sandbox per Wikipedia:Templates for discussion/Log/2021 November 27#Module:Find sources/links/archive.org

2021-12-06T09:57:19Z

synced changes from /sandbox per Wikipedia:Templates for discussion/Log/2021 November 27#Module:Find sources/links/archive.org

← Previous revision		Revision as of 09:57, 6 December 2021
Line 3:		Line 3:
	local TEMPLATE_LIST = ROOT_PAGE .. '/templates' -- template config module list		local TEMPLATE_LIST = ROOT_PAGE .. '/templates' -- template config module list
	local TEMPLATE_ROOT = TEMPLATE_LIST .. '/' -- template config module prefix		local TEMPLATE_ROOT = TEMPLATE_LIST .. '/' -- template config module prefix
	local ~~LINK_LIST~~ = ROOT_PAGE .. '/links' -- link config module list		local LINK_CONFIG = ROOT_PAGE .. '/links' -- link config module list
	local LINK_ROOT = LINK_LIST .. '/' -- link config module prefix
	local AUTODOC_SUFFIX = '/autodoc'		local AUTODOC_SUFFIX = '/autodoc'

Line 52:		Line 51:
	return false		return false
	end		end
	local ~~linkCfg~~ = maybeLoadData(~~LINK_ROOT .. code~~)		local links = maybeLoadData(LINK_CONFIG)
			local linkCfg = links[code]
	return isValidLinkCfg(linkCfg)		return isValidLinkCfg(linkCfg)
	end		end
Line 108:		Line 108:
	local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)		local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)
	return isValidTemplateCfg(templateCfg)		return isValidTemplateCfg(templateCfg)
	end

	local function isValidLinkAutdocCfg(t)
	if type(t) ~= 'table' then
	return false
	end
	for _, s in ipairs{'description', 'notes'} do
	if t[s] and type(t[s]) ~= 'string' then
	return false
	end
	end
	return true
	end		end

Line 194:		Line 182:

	function p.linkTable()		function p.linkTable()
	local codes = sortKeys(require(~~LINK_LIST~~))		local codes = sortKeys(require(LINK_CONFIG))
	local headers = {		local headers = {
	cfg['link-table-code-header'],		cfg['link-table-code-header'],
	cfg['link-table-description-header'],		cfg['link-table-description-header'],
	cfg['link-table-example-header'],		cfg['link-table-example-header'],
	cfg['link-table-config-header'],
	cfg['link-table-notes-header']		cfg['link-table-notes-header']
	}		}
	local rows = {}		local rows = {}
		⚫	local links = maybeLoadData(LINK_CONFIG)
	for i, code in ipairs(codes) do		for i, code in ipairs(codes) do
	if isValidLink(code) then		if isValidLink(code) then

	local configPage = LINK_ROOT .. code
	local ~~autodocConfigPage~~ = ~~configPage .. AUTODOC_SUFFIX~~		local linkData = links[code]
⚫	local ~~linkData~~ = maybeLoadData(~~autodocConfigPage~~)
	if not isValidLinkAutdocCfg(linkData) then
⚫	linkData = {}
⚫	~~end~~

	-- Make the example link.		-- Make the example link.
Line 227:		Line 211:
	linkData.description or grey("''No description available''"),		linkData.description or grey("''No description available''"),
	link,		link,
		⚫	linkData.notes or '',
	table.concat({
	makeWikilink(configPage, cfg['link-table-main-config-link-display']),
	makeWikilink(autodocConfigPage, cfg['link-table-autodoc-config-link-display'])
	}, cfg['table-config-separator']),
	linkData.notes or ''
	}		}
	rows[i] = row		rows[i] = row
	else		else
	local msg = substituteParams(		local msg = substituteParams(cfg['invalid-link-config-error'], code)
	cfg['invalid-link-config-error'],
⚫	~~LINK_ROOT~~ .. code
	)
	msg = makeWikitextError(msg)		msg = makeWikitextError(msg)
	msg = colspan(msg, 5)		msg = colspan(msg, 5)
Line 340:		Line 317:
	codes[#codes + 1] = t.code		codes[#codes + 1] = t.code
	end		end

			local links = maybeLoadData(LINK_CONFIG)
	for i, code in ipairs(codes) do		for i, code in ipairs(codes) do
			if links[code] then
	local linkAutodocCfg = maybeLoadData(LINK_ROOT .. code .. AUTODOC_SUFFIX)
		⚫	codes[i] = links[code].description or code
	if not isValidLinkAutdocCfg(linkAutodocCfg) then
		⚫	else
	linkAutodocCfg = {}
		⚫	codes[i] = code
	end		end
⚫	codes[i] = ~~linkAutodocCfg~~.description or code
	end		end
	local linkDescriptions = mList.bulleted(codes)		local linkDescriptions = mList.bulleted(codes)

Mr. Stradivarius: use the 'invalid-template-name-error' message instead of hard-coding it

2014-12-02T03:24:48Z

use the 'invalid-template-name-error' message instead of hard-coding it

← Previous revision		Revision as of 03:24, 2 December 2014
Line 3:		Line 3:
	local TEMPLATE_LIST = ROOT_PAGE .. '/templates' -- template config module list		local TEMPLATE_LIST = ROOT_PAGE .. '/templates' -- template config module list
	local TEMPLATE_ROOT = TEMPLATE_LIST .. '/' -- template config module prefix		local TEMPLATE_ROOT = TEMPLATE_LIST .. '/' -- template config module prefix
	local LINK_LIST = ROOT_PAGE .. '/links'		local LINK_LIST = ROOT_PAGE .. '/links' -- link config module list
	local LINK_ROOT = LINK_LIST .. '/' -- link config module prefix		local LINK_ROOT = LINK_LIST .. '/' -- link config module prefix
	local AUTODOC_SUFFIX = '/autodoc'		local AUTODOC_SUFFIX = '/autodoc'
Line 312:		Line 312:
	local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)		local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)
	if not isValidTemplateCfg(templateCfg) then		if not isValidTemplateCfg(templateCfg) then
	error(~~string.format~~(		error(substituteParams(
	"invalid template name '~~%s'; no template config found at [[%s]~~]",		cfg['invalid-template-name-error'],
	template,		template,
	TEMPLATE_ROOT .. template		TEMPLATE_ROOT .. template

Mr. Stradivarius: remove mw.text.unstrip and fix a mistaken global

2014-12-02T03:08:12Z

remove mw.text.unstrip and fix a mistaken global

← Previous revision		Revision as of 03:08, 2 December 2014
Line 1:		Line 1:
	-- Define constants		-- Define constants
	local ROOT_PAGE = 'Module:Find sources'		local ROOT_PAGE = 'Module:Find sources'
	local ~~TEMPLATE_ROOT~~ = ROOT_PAGE .. '/templates/' -- ~~for~~ template config ~~modules~~		local TEMPLATE_LIST = ROOT_PAGE .. '/templates' -- template config module list
	local ~~LINK_ROOT~~ = ~~ROOT_PAGE~~ .. '~~/links~~/' -- ~~for~~ ~~link~~ ~~config~~ ~~modules~~		local TEMPLATE_ROOT = TEMPLATE_LIST .. '/' -- template config module prefix
			local LINK_LIST = ROOT_PAGE .. '/links'
			local LINK_ROOT = LINK_LIST .. '/' -- link config module prefix
	local AUTODOC_SUFFIX = '/autodoc'		local AUTODOC_SUFFIX = '/autodoc'

Line 20:		Line 22:
	end		end

	local function ~~escapePattern~~(s)		local function sortKeys(t)
		⚫	local ret = {}
	return s:gsub('%p', '%%%0')
			for k in pairs(t) do
	end
			ret[#ret + 1] = k

	local function getPrefixPagenames(prefix)
	local specialText = string.format('{{Special:PrefixIndex/%s}}', prefix)
	specialText = mw.getCurrentFrame():preprocess(specialText)
	specialText = mw.text.unstrip(specialText)
	local pagenames = {}
	for s in string.gmatch(specialText, '<a href="[^"]" title="([^"])"[^>]>[^<]</a>') do
	pagenames[#pagenames + 1] = mw.text.decode(s)
	end		end
			table.sort(ret)
	return ~~pagenames~~		return ret
	end		end

	local function getSubpages(pagenames, prefix)
⚫	local ~~stripped~~ = {}
	for i, page in ipairs(pagenames) do
	local pattern = '^' .. escapePattern(prefix) -- Turn the prefix into a Lua pattern
	stripped[i] = mw.ustring.gsub(page, pattern, '')
	end
	return stripped
	end

	local function getPrefixSubpages(prefix)
	return getSubpages(getPrefixPagenames(prefix), prefix)
	end

	local function getFilteredPrefixSubpages(prefix)
	-- Filter out unwanted pages from the subpage list. For now, this means
	-- the autodoc pages.
	local subpages = getPrefixSubpages(prefix)
	local pattern = escapePattern(AUTODOC_SUFFIX) .. '$'
	local filtered = {}
	for _, subpage in ipairs(subpages) do
	if not mw.ustring.find(subpage, pattern) then
	filtered[#filtered + 1] = subpage
	end
	end
	return filtered
	end

	local function isValidLinkCfg(linkCfg)		local function isValidLinkCfg(linkCfg)
Line 101:		Line 70:
	end		end
	end		end
	if templateCfg~~[s]~~ and templateCfg~~[s]~~ ~= true then		if templateCfg.isUsedInMainspace and templateCfg.isUsedInMainspace ~= true then
	return false		return false
	end		end
Line 225:		Line 194:

	function p.linkTable()		function p.linkTable()
	local codes = ~~getFilteredPrefixSubpages~~(~~LINK_ROOT~~)		local codes = sortKeys(require(LINK_LIST))
	local headers = {		local headers = {
	cfg['link-table-code-header'],		cfg['link-table-code-header'],
Line 279:		Line 248:

	function p.templateTable()		function p.templateTable()
	local templates = ~~getFilteredPrefixSubpages~~(~~TEMPLATE_ROOT~~)		local templates = sortKeys(require(TEMPLATE_LIST))
	local headers = {		local headers = {
	cfg['template-table-template-header'],		cfg['template-table-template-header'],

Mr. Stradivarius: put calls to find sources through pcall

2014-09-29T15:38:48Z

put calls to find sources through pcall

@@ Line 242: / Line 242: @@
 				linkData = {}
 			end
 			local row = {
 				bold(code),
 				linkData.description or grey("''No description available''"),
 				table.concat({
 					makeWikilink(configPage, cfg['link-table-main-config-link-display']),
@@ Line 283: / Line 295: @@
 				templateData = {}
 			end
 			local row = {
 				bold(makeWikilink(mw.site.namespaces[10].name .. ':' .. template, template)),
 				templateData.description or grey("''No description available''"),
 				table.concat({
 					makeWikilink(configPage, cfg['template-table-main-config-link-display']),

Mr. Stradivarius: fix function order

2014-09-29T15:28:02Z

fix function order

← Previous revision		Revision as of 15:28, 29 September 2014
Line 61:		Line 61:
	return filtered		return filtered
	end		end

⚫	local function ~~isValidLink~~(~~code~~)
⚫	if type(~~code~~) ~= 'string' or ~~code~~ == '' then
⚫	return false
⚫	end
⚫	local ~~linkCfg~~ = maybeLoadData(~~LINK_ROOT~~ .. ~~code~~)
	return isValidLinkCfg(linkCfg)
⚫	end

	local function isValidLinkCfg(linkCfg)		local function isValidLinkCfg(linkCfg)
Line 87:		Line 79:
	end		end

	local function ~~isValidTemplate~~(~~template~~)		local function isValidLink(code)
	if type(~~template~~) ~= 'string' or ~~template~~ == '' then		if type(code) ~= 'string' or code == '' then
	return false		return false
	end		end
	local ~~templateCfg~~ = maybeLoadData(~~TEMPLATE_ROOT~~ .. ~~template~~)		local linkCfg = maybeLoadData(LINK_ROOT .. code)
	return ~~isValidTemplateCfg~~(~~templateCfg~~)		return isValidLinkCfg(linkCfg)
	end		end

Line 139:		Line 131:

	return true		return true
		⚫	end

		⚫	local function isValidTemplate(template)
		⚫	if type(template) ~= 'string' or template == '' then
		⚫	return false
		⚫	end
		⚫	local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)
			return isValidTemplateCfg(templateCfg)
	end		end

Mr. Stradivarius: do more thorough type checking in the documentation function

2014-09-29T15:26:48Z

do more thorough type checking in the documentation function

← Previous revision		Revision as of 15:26, 29 September 2014
Line 67:		Line 67:
	end		end
	local linkCfg = maybeLoadData(LINK_ROOT .. code)		local linkCfg = maybeLoadData(LINK_ROOT .. code)
			return isValidLinkCfg(linkCfg)
			end

			local function isValidLinkCfg(linkCfg)
	if type(linkCfg) ~= 'table' then		if type(linkCfg) ~= 'table' then
	return false		return false
Line 88:		Line 92:
	end		end
	local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)		local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)
			return isValidTemplateCfg(templateCfg)
			end

			local function isValidTemplateCfg(templateCfg)
	if type(templateCfg) ~= 'table' then		if type(templateCfg) ~= 'table' then
	return false		return false
Line 300:		Line 308:
	local function documentation(template)		local function documentation(template)
	-- This function makes documentation for the template specified in		-- This function makes documentation for the template specified in
	-- ~~frame.args[1]~~. The template ~~name~~ should be without the "Template:"		-- the template parameter. The template should be without the "Template:"
	-- prefix.		-- prefix.

Line 310:		Line 318:
	-- Load the config files		-- Load the config files
	local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)		local templateCfg = maybeLoadData(TEMPLATE_ROOT .. template)
	if not templateCfg then		if not isValidTemplateCfg(templateCfg) then
	error(string.format(		error(string.format(
	"invalid template name '%s'; no template config found at [[%s]]",		"invalid template name '%s'; no template config found at [[%s]]",
Line 317:		Line 325:
	))		))
	end		end
	local autodocCfg = maybeLoadData(TEMPLATE_ROOT .. template .. AUTODOC_SUFFIX) ~~or {}~~		local autodocCfg = maybeLoadData(TEMPLATE_ROOT .. template .. AUTODOC_SUFFIX)
			if not isValidTemplateAutdocCfg(autodocCfg) then
			autodocCfg = {}
			end

	-- Get the documentation content		-- Get the documentation content
Line 337:		Line 348:
	end		end
	for i, code in ipairs(codes) do		for i, code in ipairs(codes) do
	local linkAutodocCfg = maybeLoadData(LINK_ROOT .. code .. AUTODOC_SUFFIX) ~~or {}~~		local linkAutodocCfg = maybeLoadData(LINK_ROOT .. code .. AUTODOC_SUFFIX)
	~~local~~ ~~description =~~ linkAutodocCfg~~.description~~		if not isValidLinkAutdocCfg(linkAutodocCfg) then
			linkAutodocCfg = {}
⚫	codes[i] = ~~type(description) == 'string' and~~ description or code
			end
		⚫	codes[i] = linkAutodocCfg.description or code
	end		end
	local linkDescriptions = mList.bulleted(codes)		local linkDescriptions = mList.bulleted(codes)

Mr. Stradivarius: use strong tags rather than span tags for wikitext errors

2014-09-29T15:12:43Z

use strong tags rather than span tags for wikitext errors

← Previous revision		Revision as of 15:12, 29 September 2014
Line 205:		Line 205:

	local function makeWikitextError(msg)		local function makeWikitextError(msg)
	return string.format('<~~span~~ class="error">%s</~~span~~>', msg)		return string.format('<strong class="error">%s</strong>', msg)
	end		end

Mr. Stradivarius: use mw.message for substituting parameters

2014-09-29T15:11:41Z

use mw.message for substituting parameters

← Previous revision		Revision as of 15:11, 29 September 2014
Line 14:		Line 14:
	local success, data = pcall(mw.loadData, page)		local success, data = pcall(mw.loadData, page)
	return success and data		return success and data
			end

			local function substituteParams(msg, ...)
			return mw.message.newRawMessage(msg, ...):plain()
	end		end

Line 242:		Line 246:
	rows[i] = row		rows[i] = row
	else		else
	local msg = ~~string.format~~(		local msg = substituteParams(
	cfg['invalid-link-config-error'],		cfg['invalid-link-config-error'],
	LINK_ROOT .. code		LINK_ROOT .. code
Line 282:		Line 286:
	rows[i] = row		rows[i] = row
	else		else
	local msg = ~~string.format~~(		local msg = substituteParams(
	cfg['invalid-template-config-error'],		cfg['invalid-template-config-error'],
	TEMPLATE_ROOT .. template		TEMPLATE_ROOT .. template

Mr. Stradivarius: use cfg table vales for the error messages

2014-09-29T15:08:28Z

use cfg table vales for the error messages

← Previous revision		Revision as of 15:08, 29 September 2014
Line 243:		Line 243:
	else		else
	local msg = string.format(		local msg = string.format(
	'~~Invalid~~ link ~~code detected on page [[%s~~]~~].'~~,		cfg['invalid-link-config-error'],
	LINK_ROOT .. code		LINK_ROOT .. code
	)		)
Line 283:		Line 283:
	else		else
	local msg = string.format(		local msg = string.format(
	'~~Invalid~~ template ~~configuration detected on page [[%s~~]~~].'~~,		cfg['invalid-template-config-error'],
	TEMPLATE_ROOT .. template		TEMPLATE_ROOT .. template
	)		)