Template:Hidden ping/doc
This is a documentation subpage for Template:Hidden ping. It contains usage information, categories and other content that is not part of the original Template page. |
This template is used on approximately 1,650 pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
Uses Lua: |
This template is used to trigger a notification to one or several registered user(s) you are replying to in a discussion without displaying any text. The notification will only work successfully 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 {{Reply to }} template. It works on any talk page or Wikipedia namespace page.
IP addresses are only notified if you post to their user talk page.
For transparency reasons, please be cautious and judicious when using this template, and make sure you are familiar with the guideline on canvassing.
Usage
{{Hidden ping|Username}}Message text. ~~~~
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 § Notes 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.
Single recipient
Use the following syntax:
{{Hidden ping|Username}}Message text. ~~~~
For example, {{hidden ping|Jimbo Wales}}This is a message that Jimbo might be interested in.
would display "This is a message that Jimbo might be interested in." and notify Jimbo Wales.
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:
{{hidden ping|User1|User2|User3|User4|User5|User6|User7|User8|User9|User10|...}}Message text. ~~~~
For example, {{hidden ping|Example|Jimbo Wales}}
would notify User:Example and User:Jimbo Wales if used in a signed comment.
Warning: If the total number of detected to-be-pinged users in an edit exceeds 50, no notifications will be delivered. An error message will be displayed when previewing the page, but not once the page has been saved.
Error messages
As the intention of this template is that it not produce any output, error messages are only displayed when previewing a page. Once the page has been saved, this template will not display any output.
This error indicates that one or more of the usernames specified contained a character that is not allowed in Wikipedia usernames.
This indicates that no usernames were specified. This error can also be produced when the recipient's username contains an equal sign, for example {{hidden ping|test=test}}
. 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: {{hidden ping|1=test=test}}
If the total number of detected to-be-pinged users in an edit exceeds 50, no notifications will be delivered. An error message will be displayed when previewing the page, but not once the page has been saved. This is a limitation of the Echo software that provides the notifications (as of August 2015[update]).
See also
- Module:Hidden ping – the Lua module on which this template is based
- {{Reply to }} – Links to one or more users names preceded by the @ sign and followed by a colon
- {{User link }} – Links to a single user's page (without the @ sign and colon)
- {{No ping }} – Links a user's name without triggering the echo notification system
- {{To }} – Uses "To " (with a space) at the beginning instead of the @ sign
- Ttalkback – Allows a user to direct the attention of another user to a discussion via a notification
- Manual:Echo – the manual page for the underlying Echo feature that provides the notifications
- Help:Fixing failed pings
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Hidden ping
Trigger a notification to one or several registered user(s) you are replying to in a discussion without displaying any text.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Username | 1 | The name of a user that you want to notify | User | required |
Additional username | 2 | The name of an additional user you want to notify | User | optional |
Additional username | 3 | The name of an additional user you want to notify | User | optional |
Additional username | 4 | The name of an additional user you want to notify | User | optional |
Additional username | 5 | The name of an additional user you want to notify | User | optional |
Additional username | 6 | The name of an additional user you want to notify | User | optional |
Additional username | 7 | The name of an additional user you want to notify | User | optional |
Additional username | 8 | The name of an additional user you want to notify | User | optional |
Additional username | 9 | The name of an additional user you want to notify | User | optional |
Additional username | 10 | The name of an additional user you want to notify | User | optional |