Module:Reply to

-
Jump to navigation Jump to search

Module documentation move view edit history

_____________________________________________________________________________________________________________

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>


Everybody can test out in the sandbox and testcases.

  • The Template:Para parameter sets the name that will show when the template page is viewed. This parameter should be surrounded by Template:Tag 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 Template:Para 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 Template:As of). If this number of names is exceeded, the parent template will return an error message.


}}


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 mw.ustring.match(v,'%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(0,5) == 'label' then
			args[k] = '&#x200B;'
		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)
		))
	else
		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
				outStr = string.format(
					'%s[[User:%s|%s]]',
					outStr,
					args[i],
					args['label'..tostring(i)] or args[i]
				)
			end
		end
		outStr = outStr..(args['p'] or ':')
		return mw.text.tag('span', {['class']='template-ping'}, outStr)
	end
end

return p