Module:Pagelist

Module documentationviewedithistorypurge

This is a Lua implementation of {{pagelist}}. Please see the template page for documentation.

The above documentation is transcluded from Module:Pagelist/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Subpages of this module.

local p = {}

local yesno = require('Module:Yesno')
local mRedirect = require('Module:Redirect')

local separators = {
	dot = true,
	pipe = true,
	comma = true,
	['tpt-languages'] = true
}

local function getSeparator(sep)
	if type(sep) ~= 'string' then
		return nil
	end
	if separators[sep] then
		return mw.message.new(sep .. '-separator'):plain()
	else
		return sep
	end
end

local function generateLink(page, nspace, delim, endDelim, noredir)
	if not page then
		return nil
	end
	delim = delim or ''
	endDelim = endDelim or delim
	nspace = nspace or ''

	local fullPage = nspace ~= '' and (nspace .. ':' .. page) or page
	local outStr

    if yesno(noredir) and mRedirect.luaIsRedirect(fullPage) then
		local url = tostring(mw.uri.fullUrl(fullPage, {
			redirect = 'no'
		}))
		outStr = mw.ustring.gsub( 
			string.format( 
            	'%s<span class="plainlinks">[%s %s]</span><span style="display: none">[[:%s]]</span>%s',
				delim, url, page, fullPage, endDelim
			),
			':+',
			':' 
		)
	else
		outStr = mw.ustring.gsub( 
			string.format( 
				'%s[[:%s|%s]]%s',
				delim, fullPage, page, endDelim
			),
			':+',
			':' 
		)
	end
	return outStr
end

function p._main(args)
	local t = {}
	local separator = getSeparator(args.separator)
	local conjunction = getSeparator(args.conjunction)
	for i, v in ipairs(args) do
		table.insert(t, generateLink(
			v, args.nspace, args.delim, args.edelim, args.noredir
		))
	end
	return mw.text.listToText(t, separator, conjunction)
end

function p.main(frame)
	local origArgs = require('Module:Arguments').getArgs(frame, {
		trim = false,
		removeBlanks = false,
		wrappers = {
			'Template:Pagelist',
			'Template:Pagelist/sandbox'
		}
	})

	-- Process integer args. Allow for explicit positional arguments that are
	-- specified out of order, e.g. {{br separated entries|3=entry3}}.
	-- After processing, the args can be accessed accurately from ipairs.
	local args = {}
	for k, v in pairs(origArgs) do
		if type(k) == 'number' and 
			k >= 1 and
			math.floor(k) == k and
			string.match(v, '%S') then -- Remove blank or whitespace values.
			table.insert(args, k)
		end
	end
	table.sort(args)
	for i, v in ipairs(args) do
		args[i] = origArgs[v]
		-- Trim whitespace.
		if type(args[i]) == 'string' then
			args[i] = mw.text.trim(args[i])
		end
	end

	-- Get old named args. We don't need to remove blank values
	-- as for the nspace and edelim parameters the behaviour is different
	-- depending on whether the parameters are blank or absent, and for
	-- the delim parameter the default should be the blank string anyway.
	args.delim = origArgs.delim
	args.edelim = origArgs.edelim
	args.nspace = origArgs.nspace
	args.noredir = origArgs.noredir

	-- Get new named args, "separator" and "conjunction", and strip blank values.
	if origArgs.separator and origArgs.separator ~= '' then
		args.separator = origArgs.separator
	end
	if origArgs.conjunction and origArgs.conjunction ~= '' then
		args.conjunction = origArgs.conjunction
	end

	return p._main(args)
end

return p