Extension:Echo

From mediawiki.org
Jump to navigation Jump to search
This page is a translated version of the page Extension:Echo and the translation is 100% complete.
Manuel des extensions MediaWiki
OOjs UI icon advanced-invert.svg
Echo
État de la version : stable
Screenshot of Echo notification extension.png
Implémentation Notifier
Description Fournit un système de notification in-wiki qui peut être utilisé par d'autres extensions.
Auteur(s)
Dernière version mises à jour continues
Politique de compatibilité Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
MediaWiki 1.32+
Modifie la base
de données
Oui
Tables echo_email_batch
echo_event
echo_notification
echo_subscription
echo_push_provider
echo_push_subscription
echo_push_topic
Licence Licence MIT
Téléchargement
Aide Help:Extension:Echo/fr
  • $wgEchoNotificationCategories
  • $wgEchoEventLoggingSchemas
  • $wgEchoMaxMentionsCount
  • $wgEchoPerUserWhitelistFormat
  • $wgEchoPushMaxSubscriptionsPerUser
  • $wgEchoMentionOnChanges
  • $wgEchoPollForUpdates
  • $wgEchoUseJobQueue
  • $wgEchoBundleEmailInterval
  • $wgEchoMentionsOnMultipleSectionEdits
  • $wgDefaultNotifyTypeAvailability
  • $wgEchoSecondaryIcons
  • $wgEchoCacheVersion
  • $wgEchoMaxUpdateCount
  • $wgEchoNotifiers
  • $wgEchoAgentBlacklist
  • $wgEchoSharedTrackingCluster
  • $wgEchoEnablePush
  • $wgEchoPerUserBlacklist
  • $wgEchoEnableEmailBatch
  • $wgEchoWatchlistNotifications
  • $wgNotifyTypeAvailabilityByCategory
  • $wgEchoMaxMentionsInEditSummary
  • $wgEchoNotifications
  • $wgEchoPushServiceBaseUrl
  • $wgEchoCluster
  • $wgEchoWatchlistEmailOncePerPage
  • $wgAllowArticleReminderNotification
  • $wgEchoEventLoggingVersion
  • $wgEchoNotificationIcons
  • $wgEchoSharedTrackingDB
  • $wgEchoOnWikiBlacklist
  • $wgEchoSeenTimeCacheType
  • $wgEchoMentionStatusNotifications
  • $wgEchoCrossWikiNotifications
  • $wgEchoEmailFooterAddress
  • manage-all-push-subscriptions
Traduire l’extension Echo sur translatewiki.net si elle y est disponible

Vérifier la matrice des utilisations et des versions.

Problèmes Tâches ouvertes · Signaler un bogue

L'extension Echo fournit un système de notification in-wiki qui peut être utilisé par d'autres extensions. Thanks et StructuredDiscussions sont deux extensions MediaWiki qui utilisent Echo. Voir Notifications pour une description complète de ce que cette extension fait.

Téléchargement

Cette extension peut être récupérée directement depuis Git [?]:

  • Naviguer dans le code
  • Certaines extensions étiquettent les versions stables.
  • Chaque branche correspond à une version antérieure de MediaWiki. Il y a aussi une branche master (maître) qui contient la dernière version alpha (elle peut nécessiter une version alpha de MediaWiki)

Décompressez l'instantané et placez-le dans le répertoire extensions/Echo/ de votre installation MediaWiki.

Si vous êtes familier de Git et si vous avez un accès au shell de votre serveur, vous pouvez aussi obtenir l'extension de la manière suivante:

cd extensions/ git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo.git

La branche master de cette extension ne prend en charge que la branche master du noyau de MediaWiki (actuellement 1.36+). Pour utiliser avec 1.32–1.35, vous devez passer à une branche correspondante (par exemple Echo REL1_35 avec core REL1_35).

Installation

Pour les utilisateurs de MediaWiki 1.28 ou précédents :

Les instructions ci-dessus décrivent la nouvelle procédure pour installer cette extension en utilisant wfLoadExtension(). Si vous avez besoin d'installer cette extension sur les précédentes versions de MediaWiki (1.28 ou antérieur), à la place de wfLoadExtension( 'Echo' );, vous devez utiliser :

require_once "$IP/extensions/Echo/Echo.php";

Configuration

En plus de définir les préférences utilisateur par défaut, vous pouvez également utiliser le hook AddNewAccount pour modifier les préférences utilisateur lors de l'inscription. Cela permet de définir différentes préférences utilisateur à l'avenir sans affecter les utilisateurs existants.

Voir Special:DisplayNotificationsConfiguration pour plus de détails.

Paramètres

Paramètres de configuration (par défaut définis dans extension.json)
Paramètre Par défaut Commentaire
$wgEchoEnableEmailBatch true Activation ou non de la fonction de traitement par lots des e-mails
$wgEchoUseJobQueue false
  • true - Différer la livraison des notifications par e-mail et par le Web via la file d'attente des travaux.
  • false - Remettre immédiatement les notifications
$wgEchoEmailFooterAddress '' L'adresse de l'organisation (ou le texte à afficher dans le pied de page des notifications par e-mail). Doit être défini en LocalSettings.php
$wgNotificationSender $wgPasswordSender L'adresse e-mail pour les notifications par e-mail "de" et "réponse à". Doit être défini en LocalSettings.php
$wgNotificationSenderName Message "emailsender" (MediaWiki) Nom de "de" sur les notifications par e-mail. Doit être défini en LocalSettings.php
$wgNotificationReplyName No Reply Nom de la réponse aux notifications par e-mail. Doit être défini en LocalSettings.php
$wgEchoCluster false Utilisez la base de données principale si elle a la valeur false, pour utiliser une base de données externe spécifique, utilisez n'importe quelle clé définie dans $wgExternalServers
$wgEchoSharedTrackingDB false Base de données partagée à utiliser pour suivre les notifications non lues de wiki croisé ; faux pour ne pas le suivre du tout
$wgEchoSharedTrackingCluster false Cluster sur lequel se trouve la base de données de suivi partagée ; faux s'il est sur le principal. Doit être une clé définie dans $wgExternalServers
$wgEchoMaxUpdateCount 2000 Le nombre maximal de notifications autorisé pour un utilisateur à effectuer une mise à jour en direct, c'est également le nombre maximal de notifications autorisé pour un utilisateur.
$wgEchoMaxMentionsCount 50 Nombre maximal de notifications de mention pouvant être envoyées simultanément par un utilisateur
$wgEchoMentionStatusNotifications false Activer les notifications de réussite/échec de la mention
$wgEchoMentionsOnMultipleSectionEdits true Mentions de déclencheur pour les modifications à plusieurs sections
$wgEchoMentionOnChanges true Mentions de déclencheur pour les modifications de commentaires existants, à condition qu'une signature soit ajoutée dans la même section
$wgEchoMaxMentionsInEditSummary 0 Nombre maximal d'utilisateurs qui seront avertis qu'ils ont été liés à partir d'un récapitulatif de modification ou 0 pour l'absence de notifications
$wgEchoBundleEmailInterval 0 L'intervalle de temps entre chaque e-mail groupé en secondes ; définissez un petit nombre pour les wikis de test. La valeur 0 doit être affectée à cette option pour désactiver le groupage de messages électroniques si aucune file d'attente de retard n'est prise en charge
$wgEchoNewMsgAlert true Indique si une nouvelle alerte de message de page de conversation doit être activée pour les utilisateurs connectés.
$wgEchoShowFooterNotice false Afficher ou non l'avis d'évaluation du pied de page dans le menu contextuel des notifications
$wgEchoFooterNoticeURL '' URL de l'enquête qui apparaît dans l'avis de commentaires de pied de page dans le menu contextuel de notification
$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,
	],
]
Définissez les types de notification disponibles pour chaque catégorie de notification. Si des types de notification sont omis, la valeur par défaut est $wgDefaultNotifyTypeAvailability.
$wgEchoNotifiers
[
	'web' => [ 'EchoNotifier', 'notifyWithNotification' ],
	'email' => [ 'EchoNotifier', 'notifyWithEmail' ],
]
Définitions des différents types de remise de notification possibles. Chaque définition comprend un nom de classe et un nom de fonction. Voir aussi EchoNotificationController classe.
$wgEchoAgentBlacklist [] Liste des noms d'utilisateurs qui ne déclenchent pas de notifications
$wgEchoOnWikiBlacklist Echo-blacklist Emplacement de la page de la communauté tenue à jour liste noire dans NS_MEDIAWIKI contenant un nom d'utilisateur par ligne qui ne déclenchera pas de notifications. Définir à null pour désactiver.
$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 Indique si la fonctionnalité de notifications inter-wiki doit être activée. Pour activer cette fonctionnalité, vous devez :
  • ont un système utilisateur global (par exemple, CentralAuth ou une table utilisateur partagée)
  • avoir $wgMainStash et $wgMainWANCache partagés entre les wikis
  • configurer $wgEchoSharedTrackingDB
$wgEchoUseCrossWikiBetaFeature false Indicateur de fonction pour la fonctionnalité bêta des notifications de wiki croisé

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.

Cela ne contrôle pas si les notifications inter-wiki sont activées par défaut. Pour cela, utilisez $wgDefaultUserOptions['echo-cross-wiki-notifications'] = true;

$wgEchoNotificationCategories See extension.json Définissez les catégories auxquelles les notifications peuvent appartenir. Les catégories peuvent être affectées aux paramètres suivants. Tous les paramètres sont facultatifs :
  • priority - Contrôle l'ordre dans lequel les notifications sont affichées dans les préférences et les e-mails par lot. La priorité va de 1 à 10. Si la priorité n'est pas spécifiée, la valeur par défaut est 10, qui est la plus faible.
  • no-dismiss - désactive la révocabilité des notifications dans la catégorie. Il peut être défini sur un tableau de formats de sortie (voir $wgEchoNotifiers) ou un tableau contenant '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 Définit les icônes, qui sont des images 30x30. Ceci est passé à BeforeCreateEchoEvent afin que les extensions puissent définir leurs propres icônes avec la même structure. Il est recommandé que les extensions préfixent leur clé d'icône. Un exemple est mon nom-extension. Cela aidera à éviter les conflits d'espace de noms.

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 - Définir quels formats de sortie sont disponibles pour le groupage.
  • presentation-model - Définir la classe utilisée pour rendre les messages de notification et les liens des panneaux de notification, des pages spéciales et des courriels. Il doit s'étendre sur EchoEventPresentationModel.
$wgEchoConfig See extension.json Configuration for EventLogging. Individual schemas can be disabled.
$wgEchoPerUserBlacklist null Booléen qui a activé la liste noire par utilisateur.

Préférences utilisateur

Paramètres des préférences (par défaut définis dans extension.json)
Préférences Valeur par défaut Commentaire
$wgDefaultUserOptions['echo-show-alert'] true Préférence utilisateur par défaut pour l'affichage de la barre d'alerte de la page de discussion spéciale
$wgDefaultUserOptions['echo-email-frequency'] 0 Fréquence d'envoi des e-mails, par défaut. Par défaut, envoyez des e-mails pour chaque notification dès qu'ils arrivent
$wgDefaultUserOptions['echo-dismiss-feedback-alert'] 0 S'assure que l'alerte de rétroaction est visible par défaut. Ne pas changer; pour désactiver, utilisez $wgEchoShowFooterNotice.
$wgDefaultUserOptions['echo-email-format'] Depends on $wgAllowHTMLEmail Préférence par défaut de l'utilisateur pour l'utilisation de la messagerie HTML ou texte
$wgDefaultUserOptions["echo-subscriptions-email-{$category}"] false for most categories; depends Préférence utilisateur par défaut pour indiquer si une notification par e-mail pour une catégorie particulière est effectuée
$wgDefaultUserOptions["echo-subscriptions-web-{$category}"] true for most categories; depends Préférence utilisateur par défaut pour indiquer si une notification via le web pour une catégorie particulière

Architecture

Consultez la section architecture de la page de fonctionnalités .

Utilisation

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.

Terminologie

  • notification - Tout avis individuel qui est livré par Echo
  • message - Une notification sur l'activité dans une discussion de flux
  • alerte - Toute notification autre qu'un message

Voir aussi