Xablón:Ping/uso

Apologies for importing the documentation whole in English. Translation welcome!

Usage

This template triggers a notification to one or several registered user(s) you are replying to in a discussion. It is a replacement for the {{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 {{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.

The edit that adds this template must be signed with new signature tildes, or the notification(s) will not work. See en:Wikipedia:Notifications and mw:Help:Echo#Technical details for more information.

Single recipient

Use the following syntax:

{{ping|Username}} Message text. ~~~~

For example, "{{ping|Jimbo Wales}}" generates "@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:

{{ping|User1|User2|User3|User4|User5|User6|User7}} Message text. ~~~~

For example, {{ping|Example|Jimbo Wales}} will produce:

@Example and Jimbo Wales:

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

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:

"{{ping|Example|label1=Exemplar|Example2|label2=John}}" produces "@Exemplar and John:"

You can also use |label= in place of |label1=. For example:

"{{ping|Example|label=John}}" produces "@John:"

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:

"{{ping|Example|p=—}}" produces "@Example—"

The parameter omits leading or trailing spaces. Use   instead. For example:

"{{ping|Example|p= –}} Text message" produces "@Example – Text message"

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

"{{ping|Example|p=}}" produces "@Example"

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:

"{{ping|Example|Example2|c=or}}" produces "@Example or Example2:"

"Neither {{ping|Example|Example2|Example3|c=nor}}" produces "Neither @Example, Example2, nor Example3:"

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

"{{ping|Example|Example2|c=}}" produces "@Example, Example2:"

Bugs

Sometimes, when the recipient's username contains an equal sign, for example {{ping|test=test}}, it will show

Xablón:Error

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:

{{ping|1=test=test}}