扩展:Echo

MediaWiki扩展手册

Echo 发布状态： 稳定版
实现	Notify
描述	Provides an in-wiki notification system that can be used by other extensions.
作者	Andrew Garrett Ryan Kaldari Benny Situ
最新版本	持续更新
兼容性方针	发行分支
MediaWiki	1.29+. Echo master is only supported with core's master; otherwise, use matching branches (e.g. Echo REL1_27 with core REL1_27, or matching WMF release branches).
数据更新	是
表格	echo_email_batch echo_event echo_notification echo_target_page
许可协议	MIT License
下载	下载扩展 Git [?]: 下载Git主线 浏览存储库 (GitHub) 提交历史 代码复核
参数 $wgEchoEnableEmailBatch $wgEchoUseJobQueue $wgEchoEmailFooterAddress $wgNotificationSenderName $wgNotificationReplyName $wgEchoCluster $wgEchoSharedTrackingDB $wgEchoSharedTrackingCluster $wgEchoSectionTransition $wgEchoBundleTransition $wgEchoMaxUpdateCount $wgEchoMaxMentionsCount $wgEchoMentionStatusNotifications $wgEchoMentionsOnMultipleSectionEdits $wgEchoMentionOnChanges $wgEchoBundleEmailInterval $wgEchoNewMsgAlert $wgEchoShowFooterNotice $wgEchoNoticeURL $wgDefaultNotifyTypeAvailability $wgNotifyTypeAvailabilityByCategory $wgEchoNotifiers $wgEchoAgentBlacklist $wgEchoOnWikiBlacklist $wgEchoPerUserWhitelistFormat $wgEchoCrossWikiNotifications $wgEchoUseCrossWikiBetaFeature $wgEchoNotificationCategories $wgEchoNotificationIcons $wgEchoNotifications $wgEchoCacheVersion $wgEchoEventLoggingVersion $wgEchoEventLoggingSchemas
使用的钩子 LoadExtensionSchemaUpdates GetPreferences PersonalUrls BeforePageDisplay MakeGlobalVariablesScript ResourceLoaderRegisterModules EventLoggingRegisterSchemas ResourceLoaderTestModules UserGroupsChanged UserLoadOptions UserSaveOptions UserClearNewTalkNotification ParserTestTables EmailUserComplete LoginFormValidErrorMessages OutputPageCheckLastModified ArticleDeleteComplete ArticleUndelete UserMergeAccountFields MergeAccountFromTo UserMergeAccountDeleteTables EchoGetBundleRules EchoAbortEmailNotification PageContentSaveComplete LocalUserCreated ArticleRollbackComplete UserSaveSettings AbortTalkPageEmailNotification SendWatchlistEmailNotification GetNewMessagesAlert LinksUpdateAfterInsert GetBetaFeaturePreferences ResourceLoaderGetConfigVars
翻译Echo扩展如果在translatewiki.net可用
检查使用和版本矩阵。
问题	开放的工作 · 报告错误

The Echo extension provides an in-wiki notification system that can be used by other extensions. 扩展:感谢 and StructuredDiscussions are two MediaWiki extensions that make use of Echo. See Notifications for a full description of what this extension does.

Contents

Download

此扩展可直接从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";

配置

In addition to setting default user preferences, you can also use the AddNewAccount hook to change user preferences on signup. That allows setting different user preferences going forward without affecting existing users.

See the release notes when upgrading.

See Special:DisplayNotificationsConfiguration for local details.

Configuration settings (defaults defined in extension.json)

Parameter	默认	评论
$wgEchoEnableEmailBatch	true	Whether to turn on email batch function
$wgEchoUseJobQueue	false	true: Defer web and email notification delivery via job queue. false: Deliver notifications immediately
$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 nubmer 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: have a global user system (e.g. CentralAuth or a shared user table) have $wgMainStash and $wgMainWANCache shared between wikis configure $wgEchoSharedTrackingDB
$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 $wgDefaultUserOptions['echo-cross-wiki-notifications'] = true;
$wgEchoNotificationCategories	See extension.json	Define the categories that notifications can belong to. Categories can be assigned the following parameters. All parameters are optional: priority: Controls the order in which notifications are displayed in preferences and batch emails. Priority ranges from 1 to 10. If the priority is not specified, it defaults to 10, which is the lowest. no-dismiss: disables the dismissability of notifications in the category. It can either be set to an array of output formats (see $wgEchoNotifiers) or an array containing 'all'. usergroups: Specifies an array of usergroups eligible to receive the notifications in the category. If no usergroups parameter is specified, all groups are eligible. If a notifications type doesn't have a category parameter, it is automatically assigned to the other category which is lowest priority and has no preferences or dismissibility.
$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 $wgExtensionAssetsPath. The value of 'url' should be a URL. You should customize the site icon URL, which is: $wgEchoNotificationIcons['site']['url']
$wgEchoNotifications	See extension.json	Define the event types for echo. Event definitions are in the form of 'event-name' => [ ... ]. category: Defines the category the event belongs to. Defaults to 'other'. group: Defaults to 'neutral'. bundle: Define which output formats are available for bundling. presentation-model: Define which class is used to render notification messages and links for notification panels, special page and emails. It must extend EchoEventPresentationModel.
$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
$wgEchoConfig	See extension.json	Configuration for EventLogging. Individual schemas can be disabled.
$wgEchoPerUserBlacklist	null	Boolean that enabled Per User Blacklist.

架构

See the architecture section of the feature page .

用法

Notification blacklist/whitelist

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.

(Tested on MediaWiki v1.26.2 on March 15, 2016)

术语

• 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 (过时)