Template:Reply to/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
meta>Izno
move non-use info out, leave previously emphasized text in usage (and remove emphasis
meta>Ahecht
update documentation for Lua module
Line 2: Line 2:
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{redirects|Template:CC|"Commons category"|Template:cc|Creative Commons templates|Category:Creative Commons copyright templates}}
{{redirects|Template:CC|"Commons category"|Template:cc|Creative Commons templates|Category:Creative Commons copyright templates}}
{{template shortcut|re|ping|yo|reply}}
{{Lua|Module:Reply to}}
{{template shortcut|re|ping|yo|reply|CC}}


This template triggers a [[Wikipedia:Notifications|notification]] to one or several registered user(s) you are replying to in a discussion. It is a replacement for the {{tl|talkback}} template. It works on any talk page or Wikipedia namespace page.
This template triggers a [[Wikipedia:Notifications|notification]] to one or several registered user(s) you are replying to in a discussion. It is a replacement for the {{tl|talkback}} template. It works on any talk page or Wikipedia namespace page.
Line 24: Line 25:
=== Multiple recipients ===
=== Multiple recipients ===


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


For example, <code><nowiki>{{reply to|Example|Jimbo Wales}}</nowiki></code> will produce:
For example, <code><nowiki>{{reply to|Example|Jimbo Wales}}</nowiki></code> will produce:
Line 84: Line 85:
* {{Tlx|Re}}
* {{Tlx|Re}}
* {{Tlx|Yo}}
* {{Tlx|Yo}}
* {{Tlx|CC}}
* {{Tlx|Ping}}
* {{Tlx|Ping}}
* {{Tlx|Reply}}
* {{Tlx|Reply}}
Line 89: Line 91:
* {{Plain link|url={{fullurl:Special:WhatLinksHere/Template:Reply to|hidelinks=1&hidetrans=1}}|name=''Complete list of (alias) redirects''}}<!-- checks WhatLinksHere to template, not doc -->
* {{Plain link|url={{fullurl:Special:WhatLinksHere/Template:Reply to|hidelinks=1&hidetrans=1}}|name=''Complete list of (alias) redirects''}}<!-- checks WhatLinksHere to template, not doc -->


== Related templates ==
== See also ==
* [[Module:Reply to]] – the Lua module on which this template is based
* {{tl|user link}} – Links to a single user's page (without the @ sign and colon)
* {{tl|user link}} – Links to a single user's page (without the @ sign and colon)
* {{tl|noping}} – Links a user's name without triggering the echo notification system
* {{tl|noping}} – Links a user's name without triggering the echo notification system
* {{tl|to}} – Uses "To " (with a space) at the beginning instead of the @ sign
* {{tl|to}} – Uses "To " (with a space) at the beginning instead of the @ sign
* {{t|talkback}} – Allows a user to direct the attention of another user to a discussion via a notification
* {{t|talkback}} – Allows a user to direct the attention of another user to a discussion via a notification
* [[:mw:Manual:Echo|Manual:Echo]] – the manual page for the underlying ''Echo'' feature that provides the notifications


== TemplateData ==
== TemplateData ==
Line 134: Line 138:
"label": "Username #7",
"label": "Username #7",
"description": "The name of the seventh user you want to notify (optional)",
"description": "The name of the seventh user you want to notify (optional)",
"type": "wiki-user-name"
},
"8": {
"label": "Username #8",
"description": "The name of the eighth user you want to notify (optional)",
"type": "wiki-user-name"
},
"9": {
"label": "Username #9",
"description": "The name of the ninth user you want to notify (optional)",
"type": "wiki-user-name"
},
"10": {
"label": "Username #10",
"description": "The name of the tenth user you want to notify (optional)",
"type": "wiki-user-name"
"type": "wiki-user-name"
},
},
Line 178: Line 197:
"label": "Label #7",
"label": "Label #7",
"description": "An alternative nickname to be displayed instead of the seventh username (optional)",
"description": "An alternative nickname to be displayed instead of the seventh username (optional)",
"type": "string"
},
"label8": {
"label": "Label #8",
"description": "An alternative nickname to be displayed instead of the eighth username (optional)",
"type": "string"
},
"label9": {
"label": "Label #9",
"description": "An alternative nickname to be displayed instead of the ninth username (optional)",
"type": "string"
},
"label10": {
"label": "Label #10",
"description": "An alternative nickname to be displayed instead of the tenth username (optional)",
"type": "string"
"type": "string"
},
},
Line 202: Line 236:
"6",
"6",
"7",
"7",
"8",
"9",
"10",
"label1",
"label1",
"label2",
"label2",
Line 209: Line 246:
"label6",
"label6",
"label7",
"label7",
"label8",
"label9",
"label10",
"p",
"p",
"c",
"c",

Revision as of 04:12, 15 April 2016

Template:Redirects

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.

Usage

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

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

For example, "{{Reply to|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 50 people at once. Use the following syntax:

{{reply to|User1|User2|User3|User4|User5|User6|User7|User9|User9|User10|...}} Message text. ~~~~

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

@Example and Jimbo Wales:

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=Exemplar|Example2|label2=John}}" produces "@Exemplar and John:"

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&nbsp;}}" 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 &nbsp; instead. For example:

"{{reply to|Example|p=&nbsp;–}} 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|Example2|c=or}}" produces "@Example or Example2:"
"Neither {{reply to|Example|Example2|Example3|c=nor}}" produces "Neither @Example, Example2, nor Example3:"

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

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

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, for example {{reply to|test=test}}, it will show:

Error in Template:Reply to: Username not given.

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:

{{reply to|1=test=test}}

Redirects

See also

  • Module:Reply to – the Lua module on which this template is based
  • {{user link}} – Links to a single user's page (without the @ sign and colon)
  • {{noping}} – Links a user's name without triggering the echo notification system
  • {{to}} – Uses "To " (with a space) at the beginning instead of the @ sign
  • {{talkback}} – 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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Reply to

Syntax error in JSON.