Difference between revisions of "Module:Reply to"

From blackwiki
Jump to navigation Jump to search
blackwiki>Ahecht
(user string.format for better readability, use consistent single vs double quotes, simplify error messages)
blackwiki>Ahecht
(cleanup code)
Line 1: Line 1:
 
local p = {}
 
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)
 
function p.replyto(frame)
Line 12: Line 17:
 
usernames = usernames + 1
 
usernames = usernames + 1
 
local title = mw.title.new(v)
 
local title = mw.title.new(v)
if not title then return '<strong class="error">Error in [[Template:Reply to]]: Input contains forbidden characters.</strong>' end
+
if not title then return makeError('Input contains forbidden characters.') end
 
args[k] = title.rootText
 
args[k] = title.rootText
 
end
 
end
Line 23: Line 28:
  
 
if usernames > (tonumber(frame.args.max) or 50) then
 
if usernames > (tonumber(frame.args.max) or 50) then
return string.format(
+
return makeError(string.format(
'<strong class="error">Error in [[Template:Reply to]]: More than %s names specified.</strong>',
+
'More than %s names specified.',
 
tostring(frame.args.max or 50)
 
tostring(frame.args.max or 50)
)
+
))
 
else
 
else
 
if usernames < 1 then
 
if usernames < 1 then
if frame.args.example then args[1] = frame.args.example else return '<strong class="error">Error in [[Template:Reply to]]: Username not given.</strong>' end
+
if frame.args.example then args[1] = frame.args.example else return makeError('Username not given.') end
 
end
 
end
 +
args['label1'] = args['label1'] or args['label']
 
local isfirst = true
 
local isfirst = true
local outStr = ''
+
local outStr = args['prefix'] or '@'
 
for i = 1, maxArg do
 
for i = 1, maxArg do
 
if args[i] then
 
if args[i] then
 
if isfirst then
 
if isfirst then
outStr = string.format(
+
isfirst = false
'<span class="template-ping">%s[[User:%s|%s]]',
 
args['prefix'] or '@',
 
args[i],
 
(args['label1'] or args['label']) or args[i]
 
)
 
isfirst = false
 
 
else
 
else
if ( (usernames > 2) or ((usernames == 2) and (args['c'] == '')) ) then outStr = outStr..',' end
+
if ( (usernames > 2) or ((usernames == 2) and (args['c'] == '')) ) then outStr = outStr..', ' end
if i == maxArg then outStr = outStr..' '..(args['c'] or 'and') end
+
if i == maxArg then outStr = outStr..' '..(args['c'] or 'and') .. ' ' end
outStr = string.format(
 
'%s [[User:%s|%s]]',
 
outStr,
 
args[i],
 
args['label'..tostring(i)] or args[i]
 
)
 
 
end
 
end
 +
outStr = string.format(
 +
'%s[[User:%s|%s]]',
 +
outStr,
 +
args[i],
 +
args['label'..tostring(i)] or args[i]
 +
)
 
end
 
end
 
end
 
end
outStr = outStr..(args['p'] or ':')..'</span>'
+
outStr = outStr..(args['p'] or ':')
return outStr
+
return mw.text.tag('span', {['class']='template-ping'}, outStr)
 
end
 
end
 
end
 
end
  
 
return p
 
return p

Revision as of 01:38, 4 July 2018

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.



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