Difference between revisions of "Module:Reply to"

From blackwiki
Jump to navigation Jump to search
blackwiki>Ahecht
(support blank label)
blackwiki>Ahecht
(fix example)
Line 5: Line 5:
 
local origArgs = frame:getParent().args
 
local origArgs = frame:getParent().args
 
local args = {}
 
local args = {}
local maxArg = 0
+
local maxArg = 1
 
local usernames = 0
 
local usernames = 0
 
for k, v in pairs(origArgs) do
 
for k, v in pairs(origArgs) do
Line 23: Line 23:
 
args[k] = v
 
args[k] = v
 
end
 
end
end
 
 
if usernames < 1 then
 
if frame.args.example then args[1] = frame.args.example else return htmlerror{'Error in [[Template:Reply to]]: Username not given.'} end
 
 
end
 
end
  
Line 32: Line 28:
 
return htmlerror{'Error in [[Template:Reply to]]: More than '..tostring(frame.args.max or 50)..' names specified.'}
 
return htmlerror{'Error in [[Template:Reply to]]: More than '..tostring(frame.args.max or 50)..' names specified.'}
 
else
 
else
 +
if usernames < 1 then
 +
if frame.args.example then args[1] = frame.args.example else return htmlerror{'Error in [[Template:Reply to]]: Username not given.'} end
 +
end
 
local isfirst = true
 
local isfirst = true
 
local outStr = '<span class="template-ping">'
 
local outStr = '<span class="template-ping">'

Revision as of 15:18, 19 July 2017

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 htmlerror = require('Module:Error').error

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 htmlerror{'Error in [[Template:Reply to]]: Input contains forbidden characters.'}
				end
				args[k] = title.baseText
			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 htmlerror{'Error in [[Template:Reply to]]: More than '..tostring(frame.args.max or 50)..' names specified.'}
	else
		if usernames < 1 then
			if frame.args.example then args[1] = frame.args.example else return htmlerror{'Error in [[Template:Reply to]]: Username not given.'} end
		end
		local isfirst = true
		local outStr = '<span class="template-ping">'
		for i = 1, maxArg do
			if args[i] then
				if isfirst then
					outStr = outStr..(args['prefix'] or '@')..'[[:User:'..args[i]..'|'..((args['label1'] or args['label']) or args[i])..']]'
					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
					outStr = outStr.." [[:User:"..args[i].."|"..(args['label'..tostring(i)] or args[i]).."]]"
				end
			end
		end
		outStr = outStr..(args['p'] or ":").."</span>"
		return outStr
	end
end

return p