Template:Reply to/doc

From eRepublik Official Wiki
Jump to: navigation, search
edit

Edit-copy green.png Documentation subpage

This documentation subpage contains instructions, categories, or other information for technical reasons.
To view the Template page itself, see Template:Reply to.


Shortcuts:
Template:Ping
Template:Reply

Usage

This template triggers a notification to one or several registered user(s) you are replying to in a discussion. 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. 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 at a minimum, or the notification(s) will not work. See Wikipedia:Notifications for more information.

Single recipient

Use the following syntax:

{{Reply to|Username}} Message text. ~~~~

For example, "{{Reply to|Andycro}}" generates "@Andycro:".

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:

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

For example, {{Reply to|Andycro|Bogi|Gucio}} will produce:

@Andycro, Bogi, and Gucio:

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 |labelX=, where X is the index of a positional parameter, counting from 1. For example:

"{{Reply to|Example|label1=Dude|Andycro|label2=Uber Editor}}" produces "@Dude and Uber Editor:"

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

"{{Reply to|Example|label=John}}" produces "@John:"

Specify a prefix

To change the prefix, use |prefix=custom prefix. For example:

"{{reply to|Example|prefix=Hello }}" produces "Hello Example:"

Or you can remove the prefix entirely by using |prefix=. For example:

"{{reply to|Example|prefix=}}" produces "Example:"

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:

"{{reply to|Example|p=—}}" produces "@Example"

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

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

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

"{{reply to|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:

"{{reply to|Example|Andycro|c=or}}" produces "@Example or Andycro:"
"Neither {{reply to|Example|Andycro|Gucio|c=nor}}" produces "Neither @Example, Andycro, nor Gucio:"

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

"{{reply to|Example|Andycro|c=}}" produces "@Example, Andycro:"

Or don't use!

If you are using the |prefix= and |p= together to just display one user name, then there is no need to use this template. Simply code [[user:username|]]. This will generate the same notifications as are generated by the template.

Error messages

Sometimes, when the recipient's username contains an equal sign, an error could occur.

Redirects

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Reply to

<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>