扩展名:Echo

来自MediaWiki.org
跳转到导航 跳转到搜索
其他语言:
英语 • ‎蒂尔克çe • ‎丹麦语 • ‎西班牙 • ‎法国 • ‎русский • ‎中文 • ‎日本語 • ‎한국어
MediaWiki扩展手册
OOjs UI icon advanced.svg
回声
发布状态: 稳定的
png.Echo通知的屏幕截图
实施 通知
说明 提供可由其他扩展使用的wiki内通知系统。
作者
最新版本 持续更新
兼容性策略 释放分支
维基百科 1.32个+
数据库更改 是的
桌子 回显电子邮件批处理
回声事件
回显通知
echo\u订阅
回显目标页面
许可证 麻省理工学院执照
下载
  • $wgeNotificationCategories类别
  • $wgEchoEventLoggingSchemas
  • $WgechomaxEntertionScont公司
  • $wgEchoPerUserWhitelistFormat
  • $wgecho提到更改
  • $wgechopollFor更新
  • $wgEchoUseJobQueue
  • $wgEchoBundleEmailInterval
  • $wgechontinsonMultipleSectionEdits
  • $wgDefaultNotifyTypeAvailability
  • $wgechosecondary图标
  • $wgEchoCacheVersion
  • 更新最大值
  • $wgEchoNotifiers
  • $wgehoagentblacklist美元
  • $wgechorsharedtrackingcluster
  • $WgEchoonablepush美元
  • $wgEchoPerUserBlacklist美元
  • $WgEchoonableMailBatch
  • $wgEchoWatchlistNotifications
  • 类别可用性通知
  • $wgechomaxEntertionEditSummary美元
  • $wgEchoNotifications美元
  • $wgEchoPushServiceBaseUrl
  • $wgEchoCluster美元
  • $wgehowatchListMailOncePage
  • $wgallowarticel提醒通知
  • $wghechoEventLoggingVersion
  • $wgEchoNotificationIcons
  • $wgechorsharedtrackingdb
  • $wgechonWiki黑名单
  • $wgEchoSeenTimeCacheType
  • $wgechornetingStatusNotifications
  • $wgEchoCrossWikiNotifications
  • $WgEchooMailFooterAddress
转换回显扩展如果在translatewiki.net上有
检查使用情况和版本矩阵。
问题 打开的任务·报告错误

这个回声扩展提供了一个wiki内的通知系统,可供其他扩展使用。谢谢 结构描述 是两个利用Echo的MediaWiki扩展通知 对这个扩展做了什么的完整描述。

下载[编辑]

可以直接从Git检索扩展[?]:

  • 浏览代码
  • 一些扩展有稳定版本的标签。
  • 每个分支都与以前的MediaWiki版本相关联。还有一个“主”分支包含最新的alpha版本(可能需要MediaWiki的alpha版本)。

提取快照并将其放入扩展/回声/MediaWiki安装目录。

如果您熟悉git,并且对您的服务器具有shell访问权限,您还可以获得如下扩展名:

cd扩展名/
 git克隆https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo.git
此扩展的主分支仅支持MediaWiki核心的主分支(当前为1.34+)。要与1.32–1.33一起使用,必须切换到匹配的分支(例如Echo REL1_33 with core REL1_33)。

安装[编辑]

  • 下载并将文件放入名为回声在你的扩展/文件夹。

对于运行MediaWiki 1.28或更早版本的用户:

上面的说明描述了使用wfLoadExtension(). 如果您需要在这些早期版本(MediaWiki 1.28及更早版本)上安装此扩展,而不是wfLoadExtension( “回声” );,您需要使用:

只需要一次 "美元IP/扩展名/Echo/Echo.php“;

配置[编辑]

除了设置默认用户首选项外,还可以使用添加新帐户 钩子可以在注册时更改用户首选项。 这允许在不影响现有用户的情况下设置不同的用户偏好。

看到了吗特殊:显示通知配置了解当地细节。

设置中定义的默认值扩展名.json)
参数 违约 评论
$WgEchoonableMailBatch 是的 是否开启邮件批处理功能
$wgEchoUseJobQueue
  • 是的:通过作业队列延迟web和电子邮件通知传递。
  • :立即传递通知
$WgEchooMailFooterAddress '' 组织地址(或任何要显示在电子邮件通知页脚的文本)。应该在LocalSettings.php中定义
$wgNotificationSender $wgPasswordSender 电子邮件通知中“发件人”和“答复”的电子邮件地址。应该在LocalSettings.php中定义
$wgNotificationSenderName “emailsender”消息(MediaWiki) 电子邮件通知中“发件人”的名称。应该在LocalSettings.php中定义
$wgNotificationReplyName 没有答复 电子邮件通知中“回复”的名称。应该在LocalSettings.php中定义
回声团 如果设置为false,则使用主数据库;要使用特定的外部数据库,只需使用中定义的任何键$wgExternalServers(外部服务器)
$wgechorsharedtrackingdb 保持维基百科的未读通知,以保持所有未读数据库的错误
集群共享跟踪 群集共享跟踪数据库所在的位置;如果位于主数据库上,则为false。必须是中定义的键外部服务器
$wgEchoMaxUpdateCount 2000 允许用户进行实时更新的最大通知数,这也是允许用户拥有的最大通知数。
$WgechomaxEntertionScont公司 50 允许用户一次发送的最大提及通知数
$wgechornetingStatusNotifications 启用提及成功/失败通知
$wgechontinsonMultipleSectionEdits 是的 触发多节编辑的引用
$wgecho提到更改 是的 只要在同一节中添加签名,就可以触发对现有注释的编辑
$wgechomaxEntertionEditSummary美元 0 最多有0个用户将收到来自编辑摘要的通知
BundleEchoInterval$集束 0 每个捆绑电子邮件之间的时间间隔(以秒为单位);为测试Wiki设置一个较小的数字。如果不支持此电子邮件绑定,则应将0设置为“禁用”
$wgEchoNewMsgAlert公司 是的 是否为已登录用户启用新的通话页消息警报。
$wgechoshowfooter通知 是否在通知弹出窗口中显示页脚反馈通知
$wgEchoFooterNoticeURL美元 '' 显示在通知弹出窗口的页脚反馈通知中的调查的URL
$wgNotifyTypeAvailabilityByCategory
[
    //否则,用户->用户电子邮件可能会触发额外的冗余通知电子邮件。
    '电子邮件用户' => [
        “网络” => 是的,
        '电子邮件' => ,
    ],
    '提到失败' => [
        “网络” => 是的,
        '电子邮件' => ,
    ],
    '提到成功' => [
        “网络” => 是的,
        '电子邮件' => ,
    ],
]
可为每个类别定义通知类型。如果省略了任何通知类型,则默认为$wgfaultnotifytypeavailability。
$wgEchoNotifiers
[
    “网络” => [ “EchoNotifier”, '通知与通知' ],
    '电子邮件' => [ “EchoNotifier”, '通过电子邮件通知' ],
]
可能的不同类型通知传递的定义。每个定义都由类名和函数名组成。另请参阅:EchoNotificationController类。
$wgehoagentblacklist美元 [] 不会触发通知的用户名列表
$wgechonWiki黑名单 回声黑名单 社区维护的黑名单的页面位置,在NS_numediawiki中,每行包含一个用户名,不会触发通知。设置为空以禁用。
$wgEchoPerUserWhitelistFormat %s/Echo白名单 每用户通知代理白名单在NS\u用户命名空间中的位置的sprintf格式。%s将替换为用户名。白名单每行必须包含一个用户名,无论黑名单中是否存在通知,都将始终触发通知。设置为空以禁用。
$wgEchoCrossWikiNotifications 是否启用跨wiki通知功能。要启用此功能,您需要:
  • 拥有一个全局用户系统(例如CentralAuth或共享用户表)
  • 在wiki之间共享$wgMainStash和$wgMainWANCache
  • 配置$wgechorsharedtrackingdb
$wgEchoUseCrossWikiBetaFeature 跨wiki通知测试版功能的功能标志

如果这是真的,那么跨wiki通知首选项将出现在BetaFeatures部分;如果为false,它将出现在notifications部分。

这并不控制默认情况下是否启用跨wiki通知。为此,使用$wgdaultuseroptions['echo-cross-wiki-notifications']=true;

$wgeNotificationCategories类别 看到了吗扩展名.json 定义通知可以属于的类别。可以为类别分配以下参数。所有参数都是可选的:
  • 优先:控制通知在首选项和批处理电子邮件中的显示顺序。优先级从1到10。如果未指定优先级,则默认为10,这是最低的。
  • 不解雇:禁用类别中通知的可解除性。它可以设置为输出格式的数组(请参见$wgEchoNotifiers)或包含“all”的数组。
  • 用户组:指定有资格接收类别中通知的用户组数组。如果未指定usergroups参数,则所有组都符合条件。

如果通知类型没有类别参数,则会自动将其分配给其他优先级最低且没有首选项或可忽略项的类别。

$wgEchoNotificationIcons 看到了吗扩展名.json 定义图标,即30x30图像。它被传递给BeforeCreateEchoEvent,以便扩展可以用相同的结构定义自己的图标。建议扩展为其图标键加前缀。例如myextension name。这将有助于避免命名空间冲突。

您可以使用路径或url,但不能同时使用这两种方法。“path”的值相对于$wgExtensionAssetsPath.

“url”的值应为url。

您应该自定义站点图标URL,即:$wgEchoNotificationIcons['site']['url']

$wgEchoNotifications美元 看到了吗扩展名.json 定义echo的事件类型。事件定义的形式为“事件名称”=>[。。。].
  • 类别:定义事件所属的类别。默认为“其他”。
  • :默认为“中性”。
  • :定义可用于绑定的输出格式。
  • 演示模型:定义用于呈现通知消息和通知面板、特殊页面和电子邮件的链接的类。它必须延伸回声显示模型.
$wgDefaultUserOptions['echo-show-alert'] 是的 显示特殊谈话页面警报栏的默认用户首选项
$wgDefaultUserOptions['echo-email-frequency'] 0 默认情况下,发送电子邮件的频率。默认情况下,在每个通知到达时发送电子邮件
$wgDefaultUserOptions['echo-dismission-feedback-alert'] 0 确保反馈警报在默认情况下可见。不要更改;要禁用,请使用$wgechoshowfooter通知.
$wgDefaultUserOptions['echo-email-format'] 取决于$wgAllowHTMLEmail美元 是否使用HTML或文本电子邮件的默认用户首选项
$wgDefaultUserOptions[“回显订阅电子邮件-{$category}”] 大多数种类都是假的;视情况而定 是否通过电子邮件通知特定类别的默认用户首选项
$wgDefaultUserOptions[“回显订阅web-{$category}”] 大多数类别都适用;视情况而定 是否通过web通知特定类别的默认用户首选项
$wgEchoConfig配置 看到了吗扩展名.json 事件日志的配置。可以禁用单个架构。
$wgEchoPerUserBlacklist美元 无效的 启用每个用户黑名单的布尔值。

建筑[编辑]

看到了吗功能页的架构部分 .

使用[编辑]

通知黑名单/白名单

偶尔会有特定的用户(通常是机器人程序)执行不应生成通知的维护任务。 要处理这些情况,可以从LocalSettings.php文件(对于WMF wiki,则为initialisettings.php)将用户列入全局黑名单:

 $wgehoagentblacklist美元 = [ “GonzoBot”, “疯狂的家伙” ];

还有一个wiki上的黑名单,可以由wiki的社区维护MediaWiki:回声黑名单. 个人用户可以通过创建白名单来覆盖黑名单。 白名单位置默认为特别:MyPage/Echo白名单. All on-wiki lists expect to receive one case-specific username per line with no special markup or prefixes. For example:

GonzoBot 
疯狂古伊
“提及”选项

此扩展允许的一种通知类型是:“当有人链接到我的用户页面时通知我”。对于某些用户来说,这可能不明显,但只有当链接到另一个用户页面的人也在帖子上签名(~~~~)时,此通知才起作用。

安装扩展后,在用户的特殊:首选项第页。在“Notify me about these events”(通知我有关这些事件的信息)部分,在“Notify me when someone links to my user page”(当有人链接到我的用户页面时通知我)部分下,如果管理员认为签名帖子的要求在本帮助文本中并不明显,可以通过更改Wiki中的文本来修改MediaWiki:Echo pref工具提示提及第页。

(2016年3月15日在MediaWiki v1.26.2上测试)

术语[编辑]

  • 通知-Echo发送的任何单独通知
  • 消息-关于流讨论中活动的通知
  • 警报-除消息外的任何通知

另请参见[编辑]