View source for Template:Reply to/doc

{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

{{template shortcut|re|ping|yo|reply}}

== Usage ==

This template triggers a [[Wikipedia:Notifications|notification]] to one or several registered user(s) you are replying to in a discussion. It is a replacement for the {{tl|talkback}} template. It works on any talk page or Wikipedia namespace page.

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 {{tl|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.

''Note that it isn't 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.''

{{red|The edit that adds this template '''must''' be signed with new signature tildes at a minimum, or the notification(s) will not work. See [[Wikipedia:Notifications]] and [[:mw:Help:Echo#Technical details]] for more information.}}

=== Single recipient ===

Use the following syntax:
 <nowiki>{{reply to|Username}} Message text. ~~~~</nowiki>

For example, "{{tlf|Reply to|Jimbo Wales}}" generates "{{Reply to|Jimbo Wales}}".

The comment must be signed and belong to a section in order for the notification to work.

=== Multiple recipients ===

You can reply to up to 7 people at once. Use the following syntax:
 <nowiki>{{reply to|User1|User2|User3|User4|User5|User6|User7}} Message text. ~~~~</nowiki>

For example, <code><nowiki>{{reply to|Example|Jimbo Wales}}</nowiki></code> will produce:

{{reply to|Example|Jimbo Wales}}

'''''Warning:'' If the total number of detected to-be-pinged users in an edit exceeds 50, no notifications will be delivered.'''

=== Specify a nickname ===

You can display any text in place of a username by using {{para|labelX}}, where X is the index of a positional parameter, counting from 1. For example:
:"<code>{{tlf|reply to|2=Example|3=label1=Exemplar|4=Example2|5=label2=John}}</code>" produces "{{reply to|Example|label1=Exemplar|Example2|label2=John}}"

You can also use {{para|label}} in place of {{para|label1}}. For example:
:"<code>{{tlf|reply to|2=Example|3=label=John}}</code>" produces "{{reply to|Example|label=John}}"

=== Specify a prefix ===
To change the prefix, use {{para|prefix|''custom prefix''}}. For example:
:"<code>{{tlf|reply to|Example|3=prefix=Hello&amp;nbsp; }}</code>" produces "{{reply to|Example|prefix=Hello&nbsp;}}"
Or you can remove the prefix entirely by using {{para|prefix}}. For example:
:"<code>{{tlf|reply to|Example|3=prefix=}}</code>" produces "{{reply to|Example|prefix=}}"

=== Customise punctuation ===

By default, the template will insert a colon after the final name. To change this, specify the required character using the {{para|p}} parameter. For example:
:"<code>{{tlf|reply to|Example|3=p=—}}</code>" produces "{{reply to|Example|p=—}}"

The parameter omits leading or trailing spaces. Use <code>&amp;nbsp;</code> instead. For example:
:"<code>{{tlf|reply to|Example|3=p=&amp;nbsp;–}} Text message</code>" produces "{{reply to|Example|p=&nbsp;–}} Text message"

To simply remove the colon, use the parameter with an empty value:
:"<code>{{tlf|reply to|Example|3=p=}}</code>" produces "{{reply to|Example|p=}}"

=== Customise conjunction ===

By default, the template will use the word "and" between multiple names. To change this, specify the required conjunction using the {{para|c}} parameter. For example:
:"<code>{{tlf|reply to|Example|Example2|4=c=or}}</code>" produces "{{reply to|Example|Example2|c=or}}"
:"<code>Neither {{tlf|reply to|Example|Example2|Example3|5=c=nor}}</code>" produces "Neither {{reply to|Example|Example2|Example3|c=nor}}"

To simply remove the conjunction, use the parameter with an empty value:
:"<code>{{tlf|reply to|Example|Example2|4=c=}}</code>" produces "{{reply to|Example|Example2|c=}}"

=== Or don't use! ===
If you are using the {{para|prefix}} and {{para|p}} together to just display one user name, then there is no need to use this template. Simply code <code>&#x5B;[user:''username''|]]</code>. This will generate the same notifications as are generated by the template.

=== Error messages ===

Sometimes, when the recipient's username contains an equal sign, for example <code><nowiki>{{reply to|test=test}}</nowiki></code>, it will show:<br />

{{reply to|test=test}}
<br />

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:<br />

<code><nowiki>{{reply to|1=test=test}}</nowiki></code>

== Redirects ==
* {{Tlx|Re}}
* {{Tlx|Yo}}
* {{Tlx|Ping}}
* {{Tlx|Reply}}
* {{Tlx|Mention}}
* {{Plain link|url={{fullurl:Special:WhatLinksHere/Template:Reply to|hidelinks=1&hidetrans=1}}|name=''Complete list of (alias) redirects''}}<!-- checks WhatLinksHere to template, not doc -->

== Related templates ==
* {{tl|user link}} – Links to a single user's page (without the @ sign and colon)
* {{tl|noping}} – Links a user's name without triggering the echo notification system
* {{tl|to}} – Uses "To " (with a space) at the beginning instead of the @ sign

== TemplateData ==
{{TemplateData header}}
<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"
		},
		"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",
		},
		"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"
		},
		"p": {
			"label": "End punctuation",
			"description": "Custom punctuation to be displayed after the final name (defaults to ':')",
			"type": "string",
			"default": ":",
		},
		"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",
		"label1",
		"label2",
		"label3",
		"label4",
		"label5",
		"label6",
		"label7",
		"p",
		"c",
		"prefix"
	]
}
</templatedata>

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Username internal link templates]]
}}</includeonly>