Template:Ping/doc

This template is used to link one or more users' names, in the form " @Username: ", to trigger a notification for user(s) you are replying to in a discussion. The notification will work successfully only if you sign your post in the same edit in which you use this template. If you make a mistake in placing this template or in signing, see Help:Fixing failed pings. It is an alternative to the talkback template. It works on any talk page or Wikipedia namespace page.

'''You cannot directly type the "@" symbol to notify a user of your reply, you must use the template documented here or manually create a wikilink to their user page. The "@" symbol is used by this template for display purposes only.'''

This template is particularly helpful in discussions that are not threaded, to indicate which user's comment is referenced. If you feel that this template unnecessarily personalizes the discussion, you may still use the talkback template on the user's talk page to indicate that you have replied to a comment. IP addresses are only notified if you post to their user talk page.

Usage
Message text. ~

The edit that adds this template must meet the following requirement for notifications to work:


 * The edit must add new lines of text, not just edit existing lines.
 * The edit must be signed by adding  to the end of the message.
 * If you have specified a custom signature, it must contain a plain wiki link to your user page, user talk page, or contributions page; it cannot be embedded in a template.
 * The edit must either be entirely within an existing sections (it cannot have new section headers in the middle) or start a new section (starts with a new section header).
 * Only sections of level 2 and above count.
 * If the number of detected to-be-pinged users exceeds 50, no notifications will be delivered.

See Notifications and mw:Help:Echo for more information.

It is not necessary to use this template to ping the user if you are already linking to the username from your post, neither is it necessary when posting on their own talk page.

Note: Wikipedia does not support using the at sign in a reply to notify the user you are replying to, as many discussion boards do. While Wikipedia shows the results of using this template with an at sign, you must either use a template or directly link to the user's user page (e.g. ) to ping them.

DOES NOT WORK

Single recipient
Use the following syntax: Message text. ~

For example,  generates "@:" and notifies

The comment must be signed and belong to a named section of a "Talk" or "Wikipedia" namespace page in order for the notification to work.

Multiple recipients
You can reply to up to 50 people at once. Use the following syntax: Message text. ~

For example,  will produce:

 Warning: If the total number of detected to-be-pinged users in an edit exceeds 50, no notifications will be delivered. This is a software limit, and applies to the entire edit, even if the mentions are split between multiple templates. If you need to ping more than 50 users, it will need to be spread across multiple edits, and each edit needs to add new lines and be signed by you.

Specify a nickname
You can display any text in place of a username by using labelX, where X is the index of a positional parameter, counting from 1. For example:
 * " " produces ""

You can also use label in place of label1. For example:
 * " " produces ""

Specify a prefix
To change the "@" prefix, use custom prefix. For example:
 * " " produces ""

Or you can remove the prefix entirely by using prefix. For example:
 * " " produces ""

Customise punctuation
By default, the template will insert a colon after the final name. To change this, specify the required character using the p parameter. For example:
 * " " produces ""

The parameter omits leading or trailing spaces. Use  instead. For example:
 * " " produces " Text message"

To simply remove the colon, use the parameter with an empty value:
 * " " produces ""

Customise conjunction
By default, the template will use the word "and" between multiple names. To change this, specify the required conjunction using the c parameter. For example:
 * " " produces ""
 * " " produces "Neither "

To simply remove the conjunction, use the parameter with an empty value:
 * " " produces ""

Or don't use!
If you are using the prefix and p together to just display one user name, then there is no need to use this template. Simply code  or. This will generate the same notifications as are generated by the template.

Username not given
Sometimes, when the recipient's username contains an equal sign, for example, it will show:

To fix this, simply add 1= at the beginning of the username, 2= at the second username, 3= at the third username and so on:

More than 50 names specified
If more than 50 names are specified in the template, it will show:

This is a limitation of the notification system, as documented at mw:Manual:Echo. Note that the system limitation is per edit, so while splitting a longer list between two templates will avoid this error message, none of the notifications will be sent. In the rare case you need to notify more than 50 people, it will need to be done in multiple edits.

TemplateData
{	"params": { "1": {			"label": "Username #1", "description": "The name of the first user that you want to notify", "type": "wiki-user-name", "required": true },		"2": {			"label": "Username #2", "description": "The name of the second user you want to notify (optional)", "type": "wiki-user-name" },		"3": {			"label": "Username #3", "description": "The name of the third user you want to notify (optional)", "type": "wiki-user-name" },		"4": {			"label": "Username #4", "description": "The name of the fourth user you want to notify (optional)", "type": "wiki-user-name" },		"5": {			"label": "Username #5", "description": "The name of the fifth user you want to notify (optional)", "type": "wiki-user-name" },		"6": {			"label": "Username #6", "description": "The name of the sixth user you want to notify (optional)", "type": "wiki-user-name" },		"7": {			"label": "Username #7", "description": "The name of the seventh user you want to notify (optional)", "type": "wiki-user-name" },		"8": {			"label": "Username #8", "description": "The name of the eighth user you want to notify (optional)", "type": "wiki-user-name" },		"9": {			"label": "Username #9", "description": "The name of the ninth user you want to notify (optional)", "type": "wiki-user-name" },		"10": {			"label": "Username #10", "description": "The name of the tenth user you want to notify (optional)", "type": "wiki-user-name" },		"label1": { "aliases": [ "label" ],			"label": "Label #1", "description": "An alternative nickname to be displayed instead of the first username (optional)", "type": "string" },		"c": { "label": "Conjunction", "description": "Custom conjunction to be displayed between the last two names (defaults to 'and')", "type": "string", "default": "and", "autovalue": "" },		"label2": { "label": "Label #2", "description": "An alternative nickname to be displayed instead of the second username (optional)", "type": "string" },		"label3": { "label": "Label #3", "description": "An alternative nickname to be displayed instead of the third username (optional)", "type": "string" },		"label4": { "label": "Label #4", "description": "An alternative nickname to be displayed instead of the fourth username (optional)", "type": "string" },		"label5": { "label": "Label #5", "description": "An alternative nickname to be displayed instead of the fifth username (optional)", "type": "string" },		"label6": { "label": "Label #6", "description": "An alternative nickname to be displayed instead of the sixth username (optional)", "type": "string" },		"label7": { "label": "Label #7", "description": "An alternative nickname to be displayed instead of the seventh username (optional)", "type": "string" },		"label8": { "label": "Label #8", "description": "An alternative nickname to be displayed instead of the eighth username (optional)", "type": "string" },		"label9": { "label": "Label #9", "description": "An alternative nickname to be displayed instead of the ninth username (optional)", "type": "string" },		"label10": { "label": "Label #10", "description": "An alternative nickname to be displayed instead of the tenth username (optional)", "type": "string" },		"p": { "label": "End punctuation", "description": "Custom punctuation to be displayed after the final name (defaults to ':')", "type": "string", "default": ":", "autovalue": "" },		"prefix": { "label": "Prefix", "description": "Custom prefix to be displayed before the first name (defaults to '@')", "type": "string", "default": "@" }	},	"description": "Trigger a notification to one or several registered user(s) you are replying to in a discussion.", "paramOrder": [ "1",		"2",		"3",		"4",		"5",		"6",		"7",		"8",		"9",		"10",		"label1", "label2", "label3", "label4", "label5", "label6", "label7", "label8", "label9", "label10", "p", "c", "prefix" ] }