Manual:Echo
(Redirected from Help:Echo)
![]() | This page is outdated. |
Extension:Echo provides another notification system for MediaWiki.
Mentions[edit]
Echo can send notifications to users mentioned in discussions; this feature is often referred to as "pinging". Linking to a user's page in a signed message, either directly or through a template, will trigger a mention notification for them. The technical details of this are laid out below.
Technical details[edit]
When generating mention events, Echo processes revision diffs chunk by chunk, to check when a user has added a new comment which should be searched for mentioned users to ping. As of this writing, for user mention notifications to work:
- The diff chunk must be recognised as an addition of new lines of text, not a change to existing lines.
- The user must sign their message.[1]
- The signature must contain a plain wiki link (
[[ ]]
) to the user's page, user talk page, or contributions page, on the local wiki; the signature cannot be embedded in a template.[2] - In order for the signature to be recognised, the post must contain the exact same markup that writing
~~~
(and~~~~
) generates.[3]
- The signature must contain a plain wiki link (
- The comment must either belong in its entirety to existing sections (the diff chunk of added lines must not contain new section headers)[4][5], or start a new section (diff chunk starts with a new section header).[6][7] Only sections of level 2 and above count.[8]
- Links to mentioned users' pages may be embedded in templates or not, since the diff is template-expanded[9]
- The
{{REVISIONID}}
and{{REVISIONUSER}}
variables expand to the empty string when Echo parses the diff.
- The
- If the number of detected to-be-pinged users exceeds 50, no notifications will be delivered.[10]
Also, all markup is parsed with regular expressions; sufficiently tricky markup can trigger bogus results.
References[edit]
- ↑ DiscussionParser.php,
EchoDiscussionParser::interpretDiff
- ↑ DiscussionParser.php,
EchoDiscussionParser::getUserFromLine
- ↑ DiscussionParser.php,
EchoDiscussionParser::getUserFromLine
- ↑ DiscussionParser.php,
EchoDiscussionParser::interpretDiff
- ↑ DiscussionParser.php,
EchoDiscussionParser::generateEventsForRevision
- ↑ DiscussionParser.php,
EchoDiscussionParser::interpretDiff
- ↑ DiscussionParser.php,
EchoDiscussionParser::generateEventsForRevision
- ↑ DiscussionParser.php,
EchoDiscussionParser::HEADER_REGEX
- ↑ DiscussionParser.php,
EchoDiscussionParser::generateMentionEvents
- ↑ $wgEchoMaxMentionsCount in DiscussionParser.php,
EchoDiscussionParser::generateMentionEvents