RogueScholar: Create template documentation

2022-04-29T23:20:37Z

Create template documentation

New page

{{Documentation subpage}}
This template is used to link one or more users' names, in the form "<kbd>@Username:</kbd>", 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.'''

== Usage ==
<nowiki>{{</nowiki>Reply to|<var>Username</var><nowiki>}} Message text. ~~~~</nowiki>

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

# The edit must add new lines of text, not just edit existing lines.
# The edit must be signed by adding <code><nowiki>~~~~</nowiki></code> to the end of the message.
#* If you have specified a custom signature, it must contain a plain wiki link (<code>[[ ]]</code>) to your user page, user talk page, or contributions page; it cannot be embedded in a template.
# 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 (<code>=</code>) on each side.
# 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:''''' <code style="background-color: #3abf55; padding: 0.25em;"><nowiki>[[User:Example|@Example]]</nowiki></code>

'''''DOES NOT WORK:''''' <code style="background-color: #ff3e3e; padding: 0.25em;"><nowiki>@Username Message text. ~~~~</nowiki></code>

=== Recipients ===
==== Single user ====
Use the following syntax:
<nowiki>{{</nowiki>Reply to|<var>Username</var><nowiki>}} Message text. ~~~~</nowiki>

For example, <code><nowiki>{{Reply to|Karellen}}</nowiki></code> generates "[[User:Karellen|@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.

[[File:Important icon.png|20px|link=|alt=⚠]] '''''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:
<nowiki>{{</nowiki>Reply to|<var>User1</var>|<var>User2</var>|<var>User3</var>|<var>User4</var>|<var>User5</var>|<var>User6</var>|<var>User7</var>|<var>User8</var>|<var>User9</var>|<var>User10</var>| … <nowiki>}} Message text. ~~~~</nowiki>

For example, <code><nowiki>{{Reply to|Example|Karellen}}</nowiki></code> will produce:

{{Reply to|Example|Karellen}}

==== Specify a nickname ====
You can display any text in place of a username by using {{Para|labelX}}, where X is the index of a positional parameter, counting from 1. For example:
:"<code><nowiki>{{Reply to|Example|label1=Exemplar|Example2|label2=John}}</nowiki></code>" produces "{{Reply to|Example|label1=Exemplar|Example2|label2=John}}"

You can also use {{Para|label}} in place of {{Para|label1}}. For example:
:"<code><nowiki>{{Reply to|Example|label=John}}</nowiki></code>" produces "{{Reply to|Example|label=John}}"

=== Formatting parameters ===
==== Specify a prefix ====
To change the "@" prefix, use {{Para|prefix|''custom prefix''}}. For example:
:"<code><nowiki>{{Reply to|Example|prefix=Hello&nbsp; }}</nowiki></code>" produces "{{Reply to|Example|prefix=Hello }}"
Or you can remove the prefix entirely by using {{Para|prefix}}. For example:
:"<code><nowiki>{{Reply to|Example|prefix=}}</nowiki></code>" produces "{{Reply to|Example|prefix=}}"

==== Customize the punctuation ====
By default, the template will insert a colon after the final name. To change this, specify the required character using the {{Para|p}} parameter. For example:
:"<code><nowiki>{{Reply to|Example|p=—}}</nowiki></code>" produces "{{Reply to|Example|p=—}}"

The parameter omits leading or trailing spaces; to force their presence use <code>&nbsp;</code> instead. For example:
:"<code><nowiki>{{Reply to|Example|p=&nbsp;–}}</nowiki> Text message</code>" produces "{{Reply to|Example|p= –}} Text message"

To simply remove the colon, use the {{Para|p}} parameter with an empty value:
:"<code><nowiki>{{Reply to|Example|p=}}</nowiki></code>" produces "{{Reply to|Example|p=}}"

==== Customize the conjunction ====
By default, the template will use the word "and" between multiple names. To change this, specify the required conjunction using the {{Para|c}} parameter. For example:
:"<code><nowiki>{{Reply to|Example|Example2|c=or}}</nowiki></code>" produces "{{Reply to|Example|Example2|c=or}}"
:"<code>Neither <nowiki>{{Reply to|Example|Example2|Example3|c=nor}}</nowiki></code>" produces "Neither {{Reply to|Example|Example2|Example3|c=nor}}"

To simply remove the conjunction, use the {{Para|c}} parameter with an empty value:
:"<code><nowiki>{{Reply to|Example|Example2|c=}}</nowiki></code>" produces "{{Reply to|Example|Example2|c=}}"

== Error messages ==
=== Username not given ===
Sometimes, when the recipient's username contains an equality symbol (<code>=</code>), for example <code><nowiki>{{Reply to|test=test}}</nowiki></code>, it will show: 

{{Reply to|test=test}}
 

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

<code><nowiki>{{Reply to|1=test=test}}</nowiki></code>

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

{{reply to|1|2|3|4|5|6|7|8|9|10|11|12|13|14|15|16|17|18|19|20|21|22|23|24|25|26|27|28|29|30|31|32|33|34|35|36|37|38|39|40|41|42|43|44|45|46|47|48|49|50|51}}

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.

== TemplateData ==
{{Collapse top|TemplateData}}
{{TemplateData header}}
<templatedata>{
"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",
"8",
"9",
"10",
"label1",
"label2",
"label3",
"label4",
"label5",
"label6",
"label7",
"label8",
"label9",
"label10",
"p",
"c",
"prefix"
],
"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"
},
"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"
},
"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"
},
"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"
},
"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": "@"
}
}
}</templatedata>
{{Collapse bottom}}

== See also ==
* [[:mediawikiwiki:Manual:Echo|Manual:Echo]] – the manual page for the underlying ''Echo'' feature that provides the notifications
<includeonly>

[[Category:Wiki templates]]</includeonly>

Template:Reply to/doc - Revision history

RogueScholar: Create template documentation