Module:Reply to/doc: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
(Import module documentation)
 
(Wikilink reference to 'Echo' MediaWiki extension)
 
Line 1: Line 1:
This module is used by {{Tl|Reply to}} to trigger a notification to one or more registered user(s) that you are attempting to communicate with directly in a discussion taking place on-Wiki.
This module is used by {{Tl|Reply to}} to trigger a notification to one or more registered user(s) that you are attempting to communicate with directly in a discussion taking place on-wiki.


== Usage ==
== Usage ==
This module cannot be used directly from wikitext. Please use the {{Tl|Reply to}} template instead.
This module cannot be used directly from wikitext. Please use the {{Tnull|Reply to}} template instead.


== Template usage ==
== Template usage ==
<code><nowiki>{{#invoke:Reply to|replyto|<noinclude></nowiki>example=''example name''<nowiki></noinclude></nowiki>|max=''maximum number of names''}}</code>
<div class="center" style="margin: 2em auto 0;"><code style="font-size: 115%; font-weight: 600;"><nowiki>{{#invoke:Reply to|replyto|<noinclude></nowiki>example=''example name''<nowiki></noinclude></nowiki>|max=''maximum number of names''}}</code></div>


* The {{Para|example}} parameter sets the name that will show when the template page is viewed. This parameter should be surrounded by {{Tag|noinclude}} so that it is not transcluded with the parent template. The parent template will show an error message if no names are specified.
=== Available parameters ===
* The {{Para|max}} parameter sets the maximum number of names that the template will accept. If not specified, the module defaults to a value of 50 (which is the maximum number that Echo currently supports. If this number of names is exceeded, as before, the parent template will return an error message.
{{Glossary}}
:{{Term|1=example|2={{Para|example}}|style=margin-left: 2em;}}
:{{Defn|This parameter sets the username that will be shown when the template page itself is viewed, showing an example of how to make use of it correctly. It should be surrounded by {{Tag|noinclude}} tags so that it is not transcluded with the parent template. Without this function, the attempt at demonstration would show an error message as would happen if the template were used with no usernames specified.|style=margin-left: 5em;}}
:{{Term|1=max|2={{Para|max}}|style=margin-left: 2em;}}
:{{Defn|This parameter sets the maximum number of names that the template will accept within a single transclusion. If not specified, the module defaults to a value of 50 (which is the maximum number that the [[mw:Extension:Echo|Echo]] extension currently supports as part of the default MediaWiki installation, where it is stored as the value <code>$wgEchoMaxMentionsCount</code>). If this number of names is exceeded, as before, the parent template will return an error message.|style=margin-left: 5em;}}
{{Glossary end}}

Latest revision as of 10:00, 17 October 2021

This module is used by {{Reply to}} to trigger a notification to one or more registered user(s) that you are attempting to communicate with directly in a discussion taking place on-wiki.

Usage

This module cannot be used directly from wikitext. Please use the {{reply to}} template instead.

Template usage

{{#invoke:Reply to|replyto|<noinclude>example=example name</noinclude>|max=maximum number of names}}

Available parameters

|example=
This parameter sets the username that will be shown when the template page itself is viewed, showing an example of how to make use of it correctly. It should be surrounded by <noinclude>...</noinclude> tags so that it is not transcluded with the parent template. Without this function, the attempt at demonstration would show an error message as would happen if the template were used with no usernames specified.
|max=
This parameter sets the maximum number of names that the template will accept within a single transclusion. If not specified, the module defaults to a value of 50 (which is the maximum number that the Echo extension currently supports as part of the default MediaWiki installation, where it is stored as the value $wgEchoMaxMentionsCount). If this number of names is exceeded, as before, the parent template will return an error message.