Module:User

Module documentation[view] [edit] [history] [purge]

This module implements {{user}}, {{user2}}, {{user3}}, {{user4}}, {{user5}}, {{user6}}, {{user7}}, {{user8}}, {{admin}}, and {{former admin}}. For documentation, please see the template page.

Technical details

While the {{user}} template is only a wrapper for Module:UserLinks, by implementing it as a Lua module we make significant gains in performance. It is roughly twice as fast as accessing Module:UserLinks from wikitext. For example, this module rendered a test page containing nothing but 1000 {{user}} transclusions in 3.9 seconds, whereas the version that called Module:UserLinks from wikitext rendered it in 7.7 seconds.

The performance gains are achieved by reducing the number of parameters that are looked up from wikitext. In particular, the link codes, "t" and "c", along with the "span=no" option, are passed directly to UserLinks. Also, UserLinks looks up the arguments "user", "User", "project", "Project", "lang", and "Lang". From wikitext, each parameter is checked twice – once for the #invoke text and once for the calling template – and each check is relatively resource-heavy. From Lua, each parameter is only checked once, and the individual checks take much less time. This means that on average, maybe nine argument lookups are saved in each invocation by using this module. On pages with hundreds or thousands of invocations, this adds up to a lot of argument lookups saved.

Examples

• {{user}}: {{#invoke:User|‍|Example}} →
• {{user2}}: {{#invoke:User|2|Example}} →
• {{user3}}: {{#invoke:User|3|Example}} →
• {{user4}}: {{#invoke:User|4|Example}} →
• {{user5}}: {{#invoke:User|5|Example}} →
• {{user6}}: {{#invoke:User|6|Example}} →
• {{user7}}: {{#invoke:User|7|Example}} →
• {{user8}}: {{#invoke:User|8|Example}} →
• {{admin}}: {{#invoke:User|admin|Example}} →
• {{former admin}}: {{#invoke:User|former admin|Example}} →

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

local mUserLinks = require('Module:UserLinks')
local mShared = require('Module:UserLinks/shared')
local yesno = require('Module:Yesno')

local p = {}

local function validateArg(arg)
	arg = arg:match('^%s*(.-)%s*$')
	if arg ~= '' then
		return arg
	end
end

function p.main(frame)
	local argKeys = {
		user = {
			1,
			'User',
			'user'
		},
		project = {
			2,
			'Project',
			'project'
		},
		lang = {
			3,
			'Lang',
			'lang'
		}
	}
	local origArgs = frame:getParent().args
	local args = {}
	for argKey, t in pairs(argKeys) do
		for i, origArgKey in ipairs(t) do
			local value = validateArg(origArgs[origArgKey])
			if value then
				args[argKey] = value
				break
			end
		end
	end
	local options = {
		span = false,
		separator = validateArg(origArgs.separator) or 'dot',
		isDemo = yesno(validateArg(origArgs.demo))
	}
	local codes = {'t', 'c'}
	local snippets = userLinks.getSnippets(args)
	local links = userLinks.getLinks(snippets)
	local success, result = pcall(mUserLinks.export, codes, links, options)
	if success then
		return result
	else
		return mShared.makeWikitextError(result, options.isDemo)
	end
end

return p