Module:Reply to/sandbox: Difference between revisions

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 = {}

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

local function makeLink(u, l)
	return '[[User:' .. u .. '|' .. (l or u) .. ']]'
end

function p.replyto(frame)
	local args = frame:getParent().args
	local outArray = {}
	args.label1 = args.label1 or args.label

	local argIndex = {}
	for k, _ in pairs(args) do
		if type(k) == 'number' then
			table.insert(argIndex, k)
		end
	end
	table.sort(argIndex)
	for _, k in ipairs(argIndex) do
		if string.match(args[k],'%S') then
			local title = mw.title.new(args[k])
			if not title then return makeError('Input contains forbidden characters.') end
			title = title.rootText
			local label = args['label'..tostring(k)]
			if label == '' then label = '​' end
			table.insert( outArray, makeLink(title, label) )
		end
	end

	if #outArray > (tonumber(frame.args.max) or 50) then
		return makeError('More than ' .. tostring(frame.args.max or 50) .. ' names specified.')
	end
	if #outArray < 1 then
		if frame.args.example then
			outArray[1] = makeLink(frame.args.example)
		else
			return makeError('Username not given.')
		end
	end

	local conjuction = (#outArray == 2 and ' ' or ', ') .. (args.c or 'and') .. ' '
	local outStr = (args.c == '') and table.concat(outArray, ', ') or mw.text.listToText(outArray, ', ', conjuction)
	
	return mw.text.tag('span', {['class']='template-ping'}, (args.prefix or '@') .. outStr .. (args.p or ':'))
end

return p