View source for Template:To/doc

{{documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see {{Wikipedia|Wikipedia:Wikidata}}) -->
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}

== Usage ==
This template takes advantage of the user mention {{Wikipedia|Wikipedia:Notifications|notification}} to ping the user(s) you are replying to in a discussion (so you don't have to use 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.

''Note that it isn't necessary to use this template to ping (indicate) the user if you are already linking to their username from your post.''

=== Single recipient ===
To use it, just add something like the following to an existing discussion:
 <nowiki>{{to|User1}} Message text. ~~~~</nowiki>
For example, "<code><nowiki>:{{to|Jimbo Wales}} Message text.</nowiki></code>" displays as:
:{{to|Jimbo Wales}} Message text.

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:
 <nowiki>{{to|User1|UserII|UserC}} Message text. ~~~~</nowiki>

=== Specify a nickname ===
You can display any text in place of a username by using {{para|labelX}} or {{para|sX}}, where X is the index of a positional parameter, counting from 1. For example:
* <code><nowiki>{{to|Example|label1=Exemplar|Example2|label2=John}}</nowiki></code> produces {{to|Example|label1=Exemplar|Example2|label2=John}}
* <code><nowiki>{{to|Example|s1=Examp|Example2|s2=Jack}}</nowiki></code> produces {{to|Example|s1=Examp|Example2|s2=Jack}}
:'''{{smallcaps|Tip!}}''' – by default, the very first letter after the {{para|labelx}} parameter is in uppercase, as in {{para|label1|exemplar}}, which produces {{to|Example|label1=Exemplar}}. A trick that uses one {{Wikipedia|soft hyphen}}, between the equal sign and the first letter, as in {{para|label1|exemplar}} will make the first letter lowercase if needed, as in {{to|Example|label1=exemplar}}. The soft hyphen is invisible and yet it can be copied and pasted. So here it is for you to copy and paste: =e (between the equal sign and letter "e"). It's easiest to copy the "=e" in the previous sentence, paste it where you want the soft hyphen to go, and then carefully erase just the "e" and the equal sign separately, which will leave the soft hyphen behind.

=== Customize 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><nowiki>{{to|Example|p=---}}</nowiki></code> produces {{to|Example|p=---}}
* <code><nowiki>{{to|Example|p=}}</nowiki></code> produces {{to|Example|p=}}

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

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