扩展:Echo
 发布状态： 稳定版 |
|
|---|---|
 |
|
| 实现 | 通知 |
| 描述 | 提供了一个wiki内部可以供其他扩展使用的通知系统。 |
| 作者 | |
| 最新版本 | 持续更新 |
| 兼容性方针 | Snapshots releases along with MediaWiki. Master is not backward compatible. |
| MediaWiki | 1.32+ |
| 数据庫更改 | 是 |
| 表 | echo_email_batch echo_event echo_notification echo_subscription echo_target_page |
| 许可协议 | MIT授權條款 |
| 下载 | |
|
|
|
|
|
|
| 翻譯Echo擴充功能如在translatewiki.net可用 | |
| 问题 | 尚未完成的工作 · 回報錯誤 |
Echo扩展提供了一个wiki内部可以供其他扩展使用的通知系统。 扩展:感谢和扩展:结构式讨论是两个使用了Echo的MediaWiki扩展。 通知里描述了这个扩展能做的事情的完整描述。
下载
此扩展可直接从Git检索到 [?]:
- 浏览代码
- 部分扩展有稳定版本标签。
- 浏览标签
- 选择标签
- 点击“快照”
- 每个分支与过去的MediaWiki发布版本相关联。 这里也有一个“主线”分支，包含最新alpha版本（可能需要MediaWiki的alpha版本）。
- 浏览分支
- 选择一个分支名称
- 点击“继续”
提取快照，并将它放置在您的MediaWiki安装副本的extensions/Echo/目录中。
如果您对git熟悉，并且拥有您服务器的shell访问权，您也可以通过以下方法获得扩展：
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo.git
安装
- 下载文件，并将其放置在您
extensions/文件夹中的Echo目录内。 - 将下列代码放置在您的LocalSettings.php的底部：
wfLoadExtension( 'Echo' );
- 运行更新脚本，它将自动创建此扩展必须依赖的数据库表。
- 在您方便的时候配置即可
完成 – 在您的wiki上导航至Special:Version，以验证扩展已成功安装。
致使用MediaWiki 1.28或更早版本的用户：
上面的说明介绍的是安装此扩展的新方法，它使用wfLoadExtension()。
如果您需要在早期版本（MediaWiki 1.28和更早版本）中安装此扩展，而不是wfLoadExtension( 'Echo' );，您需要使用：
require_once "$IP/extensions/Echo/Echo.php";
配置
除了设置默认的用户偏好之外，您也可以使用AddNewAccount钩子在注册的时候更改用户偏好。 这允许设置以后用户不同的偏好，而不会影响已有用户。
有关更多详细信息，请参见Special:DisplayNotificationsConfiguration。
Parameters
| Parameter | 默认 | 评论 |
|---|---|---|
$wgEchoEnableEmailBatch
|
true
|
Whether to turn on email batch function |
$wgEchoUseJobQueue
|
false
|
|
$wgEchoEmailFooterAddress
|
'' | The organization address (or whatever text you want to appear in the footer of the email notifications). Should be defined in LocalSettings.php |
$wgNotificationSender
|
$wgPasswordSender
|
The email address for both "from" and "reply to" on email notifications. Should be defined in LocalSettings.php |
$wgNotificationSenderName
|
"emailsender" message (MediaWiki) | Name for "from" on email notifications. Should be defined in LocalSettings.php |
$wgNotificationReplyName
|
No Reply | Name for "reply to" on email notifications. Should be defined in LocalSettings.php |
$wgEchoCluster
|
false
|
Use the main db if this is set to false, to use a specific external db, just use any key defined in $wgExternalServers |
$wgEchoSharedTrackingDB
|
false
|
Shared database to use for keeping track of cross-wiki unread notifications; false to not keep track of it at all |
$wgEchoSharedTrackingCluster
|
false
|
Cluster the shared tracking database is located on; false if it is on the main one. Must be a key defined in $wgExternalServers |
$wgEchoMaxUpdateCount
|
2000 | The max number of notifications allowed for a user to do a live update, this is also the number of max notifications allowed for a user to have. |
$wgEchoMaxMentionsCount
|
50 | The max number of mention notifications allowed for a user to send at once |
$wgEchoMentionStatusNotifications
|
false
|
Enable mention success/failure notifications |
$wgEchoMentionsOnMultipleSectionEdits
|
true
|
Trigger mentions for multiple-section edits |
$wgEchoMentionOnChanges
|
true
|
Trigger mentions for edits to existing comments, as long as a signature is added in the same section |
$wgEchoMaxMentionsInEditSummary
|
0 | Maximum number of users that will be notified that they were linked from an edit summary or 0 for no notifications |
$wgEchoBundleEmailInterval
|
0 | The time interval between each bundle email in seconds; set a small number for test wikis. This should be set to 0 to disable email bundling if there is no delay queue support |
$wgEchoNewMsgAlert
|
true
|
Whether or not to enable a new talk page message alert for logged in users. |
$wgEchoShowFooterNotice
|
false
|
Whether or not to show the footer feedback notice in the notifications popup |
$wgEchoFooterNoticeURL
|
'' | A URL for the survey that appears in the footer feedback notice in the notification popup |
$wgNotifyTypeAvailabilityByCategory
|
[
// Otherwise, a user->user email could trigger an additional redundant notification email.
'emailuser' => [
'web' => true,
'email' => false,
],
'mention-failure' => [
'web' => true,
'email' => false,
],
'mention-success' => [
'web' => true,
'email' => false,
],
]
|
Define which notify types are available for each notification category. If any notify types are omitted, it defaults to $wgDefaultNotifyTypeAvailability. |
$wgEchoNotifiers
|
[
'web' => [ 'EchoNotifier', 'notifyWithNotification' ],
'email' => [ 'EchoNotifier', 'notifyWithEmail' ],
]
|
Definitions of the different types of notification delivery that are possible. Each definition consists of a class name and a function name. See also EchoNotificationController class. |
$wgEchoAgentBlacklist
|
[] | List of usernames which will not trigger notifications |
$wgEchoOnWikiBlacklist
|
Echo-blacklist | Page location of community maintained blacklist within NS_MEDIAWIKI containing one username per line which will not trigger notifications. Set to null to disable. |
$wgEchoPerUserWhitelistFormat
|
%s/Echo-whitelist | An sprintf format of the location of the per-user notification agent whitelist within the NS_USER namespace. %s will be replaced with the users name. The whitelists must contain one username per line which will always trigger notifications regardless of their existence in the blacklists. Set to null to disable. |
$wgEchoCrossWikiNotifications
|
false
|
Whether to enable the cross-wiki notifications feature. To enable this feature you need to:
|
$wgEchoUseCrossWikiBetaFeature
|
false
|
Feature flag for the cross-wiki notifications beta feature
If this is true, the cross-wiki notifications preference will appear in the BetaFeatures section; if this is false, it'll appear in the Notifications section instead. This does not control whether cross-wiki notifications are enabled by default.
For that, use |
$wgEchoNotificationCategories
|
See extension.json | Define the categories that notifications can belong to. Categories can be assigned the following parameters. All parameters are optional:
If a notifications type doesn't have a category parameter, it is automatically assigned to the |
$wgEchoNotificationIcons
|
See extension.json | Defines icons, which are 30x30 images. This is passed to BeforeCreateEchoEvent so extensions can define their own icons with the same structure. It is recommended that extensions prefix their icon key. An example is myextension-name. This will help avoid namespace conflicts.
You can use either a path or a url, but not both. The value of 'path' is relative to The value of 'url' should be a URL. You should customize the site icon URL, which is: |
$wgEchoNotifications
|
See extension.json | Define the event types for echo. Event definitions are in the form of 'event-name' => [ ... ].
|
$wgEchoConfig
|
See extension.json | Configuration for EventLogging. Individual schemas can be disabled. |
$wgEchoPerUserBlacklist
|
null
|
Boolean that enabled Per User Blacklist. |
User preferences
| Preference | Default | Comment |
|---|---|---|
$wgDefaultUserOptions['echo-show-alert']
|
true
|
Default user preference for showing the special talk page alert bar |
$wgDefaultUserOptions['echo-email-frequency']
|
0 | How often to send emails, by default. By default, send emails for each notification as they come in |
$wgDefaultUserOptions['echo-dismiss-feedback-alert']
|
0 | Ensures the feedback alert is visible by default. Do not change; to disable, use $wgEchoShowFooterNotice.
|
$wgDefaultUserOptions['echo-email-format']
|
Depends on $wgAllowHTMLEmail
|
Default user preference for whether to use HTML or text email |
$wgDefaultUserOptions["echo-subscriptions-email-{$category}"]
|
false for most categories; depends | Default user preference for whether to notify via email for a particular category |
$wgDefaultUserOptions["echo-subscriptions-web-{$category}"]
|
true for most categories; depends | Default user preference for whether to notify via web for a particular category |
架构
用法
- Notification negative list / positive list
There are occasionally specific users, typically bots, which perform maintenance tasks that should not generate notifications. To handle these cases, users can be globally blacklisted from the LocalSettings.php file (or InitialiseSettings.php in the case of WMF wikis):
$wgEchoAgentBlacklist = [ 'GonzoBot', 'CrazyGuy' ];
There is also an on-wiki blacklist that can be maintained by the wiki's community. The location of the global on-wiki blacklist defaults to MediaWiki:Echo-blacklist. Individual users can override the blacklist by creating a whitelist. The whitelist location defaults to Special:MyPage/Echo-whitelist. All on-wiki lists expect to receive one case-specific username per line with no special markup or prefixes. For example:
GonzoBot CrazyGuy
- "Mention" option
One of the notification types that this extension allows is: "Notify me when someone links to my user page." It might not be obvious to some users, but this particular notification only works when the person linking to another user's page also signs (~~~~) the post.
After installation of the extension, a new tab "Notifications" is created in a user's Special:Preferences page. Under the section "Notify me about these events", in front of the "Mention" option, the hoverbox states: "Notify me when someone links to my user page." If an administrator feels, that the requirement for signing the post isn't obvious in this help text, it can be modified by changing the text in the Wiki's MediaWiki:Echo-pref-tooltip-mention page.
术语
- notification - Any individual notice that is delivered by Echo
- message - A notification about activity in a Flow discussion
- alert - Any notification other than a message
参见
- Notifications/API
- 手册:Echo - 有关提及要求的详细信息
- Extension:Echo/Creating a new notification type (当前)
- Notifications/Developer_guide (过时)
| 此扩展被用于一个或多个维基媒体项目上。 这可能意味着扩展稳定且工作良好，足以用在同等高流量的网站上。 请在维基媒体的CommonSettings.php和InitialiseSettings.php配置文件中寻找此扩展名称以查看安装它的网站。 详细的已安装扩展的完整列表可在wiki的Special:Version页面找到。 |