Editing Template:Ping/doc

{{Documentation subpage}}
{{Lua|Module:Reply to}}

This template is used to link one or more users' names, in the form "<kbd>@Username:</kbd>", to trigger a [[mw:Notifications|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. It works on any talk page or Project 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 [[w:WP:WIKILINK|wikilink]] to their [[w:WP:USERPAGE|user page]].<br /> 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 post 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 ==
{| class="wikitable"
!Template !! Result
|-
|{{tlx|ping|Example}} || {{ping|Example}}
|-
|{{tlx|ping|Example|John}} || {{ping|Example|John}}
|}

=== Single recipient ===
Use the following syntax:
 <nowiki>{{ping|Username}} Message text. ~~~~</nowiki>
For example, <code>{{tlx|ping|Example}}</code> generates "@[[User:Example|Example]]:" and notifies [[User:Example|Example]]

=== Multiple recipient ===
You can reply to up to 50 people at once. Use the following syntax:
 <nowiki>{{ping|User1|User2|User3|User4|User5|User6|User7|User8|User9|User10|...}} Message text. ~~~~</nowiki>

For example, <code><nowiki>{{ping|Example|John}}</nowiki></code> will produce:

{{ping|Example|John}}

[[File:Ambox warning pn.svg|20px|link=|alt=⚠]]&nbsp;'''<span style="color:red;">''Warning:''</span> 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.

== See also ==
{{#lst:Template:Template list|inline-talk-templates}}
__NOTOC__