Расширение:Echo
Outdated translations are marked like this.
This extension comes with MediaWiki 1.40 and above. Таким образом, вам не нужно загружать его снова. Тем не менее, вы всё равно должны следовать другим инструкциям.
There is a stalled attempt to move this functionality into core MediaWiki; for more information, see Уведомления and Requests for comment/Notifications in core. |
 Статус релиза: стабильно |
|
|---|---|
 |
|
| Реализация | Уведомлять |
| Описание | Предоставляет встроенную систему уведомлений вики, которая может использоваться другими расширениями. |
| Автор(ы) | |
| Последняя версия | постоянные обновления |
| Политика совместимости | Снэпшоты выходят вместе с MediaWiki. Мастер не имеет обратной совместимости. |
| MediaWiki | >= 1.43 |
| Изменения в БД | Да |
| Таблицы | echo_email_batch echo_event echo_notification echo_subscription echo_target_page echo_push_provider echo_push_subscription echo_push_topic echo_unread_wikis |
| Лицензия | MIT License |
| Скачать | |
|
|
|
|
|
|
| Ежеквартальные загрузки | 128 (Ranked 45th) |
| Использование общедоступными вики | 2,698 (Ranked 187th) |
| Переведите расширение Echo, если оно доступно на translatewiki.net | |
| Проблемы | Открытые задачи · Сообщить об ошибке |
Расширение Echo предоставляет встроенную систему уведомлений вики, которая может использоваться другими расширениями. Thanks и DiscussionTools это два расширения MediaWiki, которые используют Echo.
Установка
- The database user must have been granted the "REFERENCES" right for the database. How you check this depends on how you set up the database in the first place. For example, if you used a control panel application, then that interface should provide a way to check and change the privileges of the database user (
$wgDBuserin LocalSettings.php). - Скачайте и распакуйте файл(ы) в папку с названием
Echoв вашей папкеextensions/.
Вместо этого разработчикам и соавторам кода следует установить расширение из Git, используя:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo - Добавьте следующий код в конце вашего файла LocalSettings.php:
wfLoadExtension( 'Echo' );
- Выполните скрипт обновления, который автоматически создаст необходимые таблицы, используемые расширением.
- Можно настроить позже, если необходимо что-то поменять из этого.
Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.
To allow daily or weekly summary notifications to be delivered by mail (for users that choose that in preferences), the following script inside the Echo extension directory needs to be run on a daily basis, which can be scheduled in a cron job:
maintenance/processEchoEmailBatch.php
Настройка
It is possible to use conditional user options to set different notification preferences for new users, without affecting existing users.
Смотрите Special:DisplayNotificationsConfiguration для получения локальных сведений.
Параметры
| Параметр | По умолчанию | Комментарий |
|---|---|---|
$wgEchoEnableEmailBatch
|
true
|
Следует ли включить функцию пакетной отправки электронной почты |
$wgEchoUseJobQueue
|
false
|
|
$wgEchoEmailFooterAddress
|
'' | Адрес организации (или любой другой текст, который вы хотите видеть в нижнем колонтитуле уведомлений по электронной почте). Должно быть определено в LocalSettings.php |
$wgNotificationSender
|
$wgPasswordSender
|
Адрес электронной почты для обоих "от" и "ответить на" в уведомлениях по электронной почте. Должно быть определено в LocalSettings.php |
$wgNotificationSenderName
|
сообщение "emailsender" (MediaWiki) | Имя для "от" на уведомления по электронной почте. Должно быть определено в LocalSettings.php |
$wgNotificationReplyName
|
No Reply | Имя для "ответа на" в уведомлениях по электронной почте. Должно быть определено в LocalSettings.php |
$wgEchoCluster
|
false
|
Использует основную БД если это значение равно false; для использования конкретной внешней БД достаточно использовать любой ключ, определенный в $wgExternalServers |
$wgEchoSharedTrackingDB
|
false
|
Общая база данных для использования отслеживания непрочитанных уведомлений кросс-вики; false, чтобы не отслеживать это вообще |
$wgEchoSharedTrackingCluster
|
false
|
Кластер, в котором находится общая база данных отслеживания; false, если он находится на главном. Должен быть ключ, определенный в $wgExternalServers |
$wgEchoMaxUpdateCount
|
2000 | Максимальное количество уведомлений, разрешенных для пользователя, чтобы сделать живое обновление, это также число максимальных уведомлений, разрешенных для пользователя. |
$wgEchoMaxMentionsCount
|
50 | Максимальное количество упоминаний об уведомлениях, которые пользователь может отправить одновременно |
$wgEchoMentionStatusNotifications
|
false
|
Включить упоминания об успешных/сбойных уведомлениях |
$wgEchoMentionsOnMultipleSectionEdits
|
true
|
Триггер упоминает многосекционные правки |
$wgEchoMentionOnChanges
|
true
|
Триггер упоминает редактирования существующих комментариев, если в том же разделе добавлена подпись |
$wgEchoMaxMentionsInEditSummary
|
0 | Максимальное число участников, которым придут уведомления, о то, что их упомянули в описании правки или 0 для выключения |
$wgEchoBundleEmailInterval
|
0 | Интервал времени между каждым пакетом электронной почты в секундах; установите небольшое число для тестовых вики. Это должно быть установлено в 0, чтобы отключить пакетирование электронной почты, если нет поддержки задержки очереди почты |
$wgEchoNewMsgAlert
|
true
|
Включение или отключение оповещения о новом сообщении на странице обсуждения для зарегистрированных пользователей. |
$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,
],
]
|
Определяет, какие типы уведомлений доступны для каждой категории. Если какие-то типы уведомлений опущены, то по умолчанию используется $wgDefaultNotifyTypeAvailability. |
$wgEchoNotifiers
|
[
'web' => [ 'EchoNotifier', 'notifyWithNotification' ],
'email' => [ 'EchoNotifier', 'notifyWithEmail' ],
]
|
Определения различных возможных типов доставки уведомлений. Каждое определение состоит из имени класса и имени функции. См. также класс EchoNotificationController. |
$wgEchoAgentBlacklist
|
[] | Список имён пользователей, которые не будут вызывать уведомления. |
$wgEchoOnWikiBlacklist
|
Echo-blacklist | Расположение поддерживаемой сообществом страницы в пространстве NS_MEDIAWIKI, на которой содержится чёрный список имён участников по одному в строку, которые не будут вызывать уведомления. Чтобы выключить, установите в null. |
$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
|
Включать ли опцию кросс-вики уведомлений. Чтобы включить эту возможность, необходимо:
|
$wgEchoUseCrossWikiBetaFeature
|
false
|
Feature flag for the cross-wiki notifications beta feature
If this is 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. Все параметры необязательны:
If a notifications type doesn't have a category parameter, it is automatically assigned to the |
$wgEchoNotificationIcons
|
See extension.json | Определяет иконки, изображения 30x30. Эта опция передаётся BeforeCreateEchoEvent, поэтому расширения могут определять свои собственные иконки с той же структурой. Рекомендуется использовать префикс с именем расширения для ключей иконок. Например, myextension-name. Это поможет избежать конфликтов пространств имён.
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. |
Пользовательские настройки
| Настройки | По умолчанию | Комментарий |
|---|---|---|
$wgDefaultUserOptions['echo-email-frequency']
|
0 | How often to send emails, by default:
|
$wgDefaultUserOptions['echo-email-format']
|
Depends on $wgAllowHTMLEmail
|
Default user preference for whether to use HTML or text email. Either html or plain-text.
|
$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 = [ 'SampleBot', 'SampleUser' ];
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:
SampleBot SampleUser
"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 - любое индивидуальное уведомление, которое доставляется Echo
- message - уведомление об активности в потоковом (Flow) обсуждении
- alert - любое уведомление, кроме сообщения (message)
Смотри также
- Notifications/API
- Руководство:Echo - для получения подробной информации о требованиях упоминания
- Extension:Echo/Creating a new notification type (текущий)
- Notifications/Developer_guide (устарело)
| Это расширение используется в одном или нескольких проектах Викимедиа. Вероятно, это означает, что расширение стабильно и работает достаточно хорошо, чтобы использоваться такими сайтами с высоким трафиком. Найдите название этого расширения в файлах конфигурации Викимедиа CommonSettings.php и InitialiseSettings.php, чтобы узнать, где оно установлено. Полный список расширений, установленных на конкретной вики, можно увидеть на странице Special:Version wiki. |
| Это расширение включено в следующие вики-фермы/хостинги и/или пакеты: Это не исчерпывающий список. Некоторые вики-фермы/хостинги и/или пакеты могут содержать это расширение, даже если они не перечислены здесь. Всегда сверяйтесь со своими вики-фермами/хостингами или комплектами/бандлами для подтверждения. |