Module:Reply to/sandbox

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

This module is used by {{Reply to}} to trigger a notification to one or several registered user(s) you are replying to in a discussion.

Usage from wikitext

This module cannot be used directly from wikitext. Please use the {{Reply to}} template instead.

Usage within templates

{{#invoke:Reply to|replyto|example=''example name''|max=''maximum number of names''}}

• The |example= parameter sets the name that will show when the template page is viewed. This parameter should be surrounded by <noinclude>...</noinclude> so that it is not transcluded with the parent template, and the parent template will show an error message if no names are specified.
• The |max= parameter sets the maximum number of names that the template will accept. If not specified, it defaults to 50 (which is the maximum number that Echo currently supports as of August 2015). If this number of names is exceeded, the parent template will return an error message.

The above documentation is transcluded from Module:Reply to/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Add categories to the /doc subpage. Subpages of this module.

local p = {}

local function makeError(msg)
	msg ='Error in [[Template:Reply to]]: ' .. msg
	return mw.text.tag('strong', {['class']='error'}, msg)
end

function p.replyto(frame)
	local origArgs = frame:getParent().args
	local args = {}
	local maxArg = 1
	local usernames = 0
	for k, v in pairs(origArgs) do
		if type(k) == 'number' then
			if v:match('%S') then
				if k > maxArg then maxArg = k end
				usernames = usernames + 1
				local title = mw.title.new(v)
				if not title then return makeError('Input contains forbidden characters.') end
				args[k] = title.rootText
			end
		elseif v == '' and k:sub(1, 5) == 'label' then
			args[k] = '​'
		else
			args[k] = v
		end
	end

	if usernames > (tonumber(frame.args.max) or 50) then
		return makeError(string.format(
			'More than %s names specified.',
			tostring(frame.args.max or 50)
		))
	end
	if usernames < 1 then
		if frame.args.example then args[1] = frame.args.example else return makeError('Username not given.') end
	end
	args['label1'] = args['label1'] or args['label']
	local isfirst = true
	local outStr = args['prefix'] or '@'
	for i = 1, maxArg do
		if args[i] then
			if isfirst then
				isfirst = false
			else
				if ( (usernames > 2) or ((usernames == 2) and (args['c'] == '')) ) then outStr = outStr..', ' end
				if i == maxArg then outStr = outStr..' '..(args['c'] or 'and') .. ' ' end
			end
			local item
			local label = args['label'..tostring(i)] or args[i]
			if args[i]:sub(1, 3) == "~20" then  -- assume temporary account
				item = string.format(
					'[[User:%s|&#x200B;]][[User talk:%s|%s]]',  -- hidden ping and link to user talk
					args[i],
					args[i],
					label
				)
			else
				item = string.format(
					'[[User:%s|%s]]',
					args[i],
					label
				)
			end
			outStr = outStr .. item
		end
	end
	outStr = outStr..(args['p'] or ':')
	return mw.text.tag('span', {['class']='template-ping'}, outStr)
end

return p