Template:Reply to/doc

From Official Kodi Wiki
< Template:Reply to
Revision as of 23:20, 29 April 2022 by RogueScholar (talk | contribs) (Create template documentation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This template is used to link one or more users' names, in the form "@Username:", triggering a 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 Kodi Wiki namespace page and is particularly helpful in discussions with many participants, to cut through crosstalk and indicate which user's comment you're referencing or responding to.

You cannot directly type the "@" symbol to notify a user of your reply, you must use the template as documented here or manually create a wikilink to their user page.
The "@" symbol is used by this template for display purposes only.


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

The edit that adds this template must meet the following requirement for notifications to work:

  1. The edit must add new lines of text, not just edit existing lines.
  2. The edit must be signed by adding ~~~~ to the end of the message.
    • If you have specified a custom signature, it must contain a plain wiki link ([[ ]]) to your user page, user talk page, or contributions page; it cannot be embedded in a template.
  3. The edit must either be entirely within an existing sections (it cannot have new section headers in the middle) or start a new section (starts with a new section header).
    • Only sections of level 2 and below count, i.e. those surrounded by two or more equality symbols (=) on each side.
  4. If the number of to-be-pinged users exceeds 50, no notifications will be delivered (as an anti-spam measure).

It is not necessary to use this template to ping the user if you are already linking to their username from your post, neither is it necessary when posting on their own talk page.

Note: Kodi Wiki does not support using the "@" sign in a reply to notify the user you are replying to, as many online discussion boards do. While the results of using this template appear with an "@" sign, you must either use this template or directly link to the user's user page to ping them. Thusly,

WORKS: [[User:Example|@Example]]

DOES NOT WORK: @Username Message text. ~~~~


Single user

Use the following syntax:

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

For example, {{Reply to|Karellen}} generates "@Karellen:" and notifies Karellen of your edit.

The comment must be signed and belong to a named section of a "Talk" or "Official Kodi Wiki" namespace page in order for the notification to work.

Multiple users

You can reply to up to 50 people at once.

⚠ Warning: If the total number of 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.

Use the following syntax:

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

For example, {{Reply to|Example|Karellen}} will produce:

{{safesubst:#invoke:Reply to|replyto||max=50}}

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 "{{safesubst:#invoke:Reply to|replyto||max=50}}"

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

"{{Reply to|Example|label=John}}" produces "{{safesubst:#invoke:Reply to|replyto||max=50}}"

Formatting parameters

Specify a prefix

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

"{{Reply to|Example|prefix=Hello&nbsp; }}" produces "{{safesubst:#invoke:Reply to|replyto||max=50}}"

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

"{{Reply to|Example|prefix=}}" produces "{{safesubst:#invoke:Reply to|replyto||max=50}}"

Customize the 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 "{{safesubst:#invoke:Reply to|replyto||max=50}}"

The parameter omits leading or trailing spaces; to force their presence use &nbsp; instead. For example:

"{{Reply to|Example|p=&nbsp;–}} Text message" produces "{{safesubst:#invoke:Reply to|replyto||max=50}} Text message"

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

"{{Reply to|Example|p=}}" produces "{{safesubst:#invoke:Reply to|replyto||max=50}}"

Customize the 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 "{{safesubst:#invoke:Reply to|replyto||max=50}}"
"Neither {{Reply to|Example|Example2|Example3|c=nor}}" produces "Neither {{safesubst:#invoke:Reply to|replyto||max=50}}"

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

"{{Reply to|Example|Example2|c=}}" produces "{{safesubst:#invoke:Reply to|replyto||max=50}}"

Error messages

Username not given

Sometimes, when the recipient's username contains an equality symbol (=), for example {{Reply to|test=test}}, it will show:

{{safesubst:#invoke:Reply to|replyto||max=50}}

To fix this, simply add |1= at the beginning of the first/only username, |2= before the second username, |3= before the third username, and so on:

{{Reply to|1=test=test}}

More than 50 names specified

If more than 50 names are specified in the template, it will show:

{{safesubst:#invoke:Reply to|replyto||max=50}}

This is a limitation of the notification system, as documented at mw:Manual:Echo. Note that the system limitation is per edit, so while splitting a longer list between two templates will avoid this error message, none of the notifications will be sent. In the rare case you need to notify more than 50 people, it will need to be done in multiple edits.


See also

  • Manual:Echo – the manual page for the underlying Echo feature that provides the notifications