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|<noinclude>example=example name</noinclude>|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 = {}

-- Make an HTML error from the supplied error message.
local function makeHTMLError(msg)
	msg = string.format(
		'Error in [[Template:Reply to]]: %s.',
		msg
	)
	return require('Module:Error').error{msg}
end

-- Make a title object for the given user's user page. If the username contains
-- invalid characters, returns nil. Usernames can be given as 'Foo' or
-- 'User:Foo'.
local function makeUserTitle(user)
	return mw.title.new(user, 2)
end

-- Make a wikilink with the given page and display text.
local function makeWikilink(page, display)
	if display then
		return string.format('[[%s|%s]]', page, display)
	else
		return string.format('[[%s]]', page)
	end
end

function p.replyto(frame)
	local origArgs = frame:getParent().args
	local args = {}
	local maxArg = 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
				local title = mw.title.new(v)
				if not title then
					return htmlerror{'Error in [[Template:Reply to]]: Input contains forbidden characters.'}
				end
				args[k] = title.baseText
			end
		else
			args[k] = v
		end
	end

	if maxArg == 0 then
		if frame.args.example then args[1] = frame.args.example else return htmlerror{'Error in [[Template:Reply to]]: Username not given.'} end
	end

	if maxArg > (tonumber(frame.args.max) or 50) then
		return makeHtmlError('More than '..tostring(frame.args.max or 50)..' names specified')
	else
		local outStr = '<span class="template-ping">'..(args['prefix'] or '@')..'[[:User:'..args[1]..'|'..((args['label1'] or args['label']) or args[1])..']]'
		for i = 2, maxArg do
			if ( (maxArg > 2) or ((maxArg == 2) and (args['c'] == '')) ) then outStr = outStr.."," end
			if i == maxArg then outStr = outStr.." "..(args['c'] or "and") end
			outStr = outStr.." [[:User:"..args[i].."|"..(args['label'..tostring(i)] or args[i]).."]]"
		end
		outStr = outStr..(args['p'] or ":").."</span>"
		return outStr
	end
end

return makeUserLink