Extension:Echo
There is a stalled attempt to move this functionality into core MediaWiki; for more information, see Notifications and Requests for comment/Notifications in core. |
 État de la version : stable |
|
|---|---|
 |
|
| Implémentation | Notifier |
| Description | Fournit un système de notification intégré au wiki et pouvant ê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.43 |
| Modifie la base de données |
Oui |
| Tables | echo_email_batch echo_event echo_notification echo_subscription echo_target_page echo_push_provider echo_push_subscription echo_push_topic echo_unread_wikis |
| Licence | Licence MIT |
| Téléchargement | |
| Aide | Help:Extension:Echo/fr |
|
|
|
|
|
|
| Téléchargements trimestriels | 126 (Ranked 43rd) |
| Utilisé par les wikis publics | 2,698 (Ranked 187th) |
| Traduire l’extension Echo sur translatewiki.net si elle y est disponible | |
| 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 DiscussionTools sont deux extensions MediaWiki qui utilisent Echo.
Installation
- L'utilisateur de la base de données doit avoir les droits « REFERENCES » sur la base. 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). - Téléchargez et placez le(s) fichier(s) dans un répertoire appelé
Echodans votre dossierextensions/.
Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo - Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
wfLoadExtension( 'Echo' );
- Exécutez le script de mise à jour qui va créer automatiquement les tables de base de données dont cette extension a besoin.
- Configurer à votre convenance si nécessaire.
Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Pour permettre au résumé des notifications, qu'il soit quotidien ou hebdomadaire, d'être envoyé par courriel (pour les utilisateurs qui ont choisi cela dans leur préférences), le script suivant du répertoire de l'extension Echo doit être exécuté sur une base quotidienne, ce qui peut se faire en déclarant une tâche de cron :
maintenance/processEchoEmailBatch.php
Configuration
Il est possible d'utiliser options utilisateur conditionnelles pour définir différentes préférences de notification pour les nouveaux utilisateurs, sans affecter les utilisateurs existants.
Voir Special:DisplayNotificationsConfiguration pour les détails locaux.
Paramètres
| Paramètre | Par défaut | Commentaire |
|---|---|---|
$wgEchoEnableEmailBatch
|
true
|
Activation ou non de la fonction de traitement par lots des courriels |
$wgEchoUseJobQueue
|
false
|
|
$wgEchoEmailFooterAddress
|
'' | L'adresse de l'organisation (ou le texte à afficher dans le pied de page des notifications par courriel). 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 pour "de" sur les notifications par courriel. Doit être défini en LocalSettings.php |
$wgNotificationReplyName
|
No Reply | Nom pour "répondre à" dans les notifications par courriel. Doit être défini en LocalSettings.php |
$wgEchoCluster
|
false
|
Utilisez la base de données principale si la valeur est à 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 inter wiki non lues; false pour ne pas les suivre du tout
|
$wgEchoSharedTrackingCluster
|
false
|
Cluster sur lequel se trouve la base de données de suivi partagée ; false s'il est sur le principal. Doit être une clé définie dans $wgExternalServers
|
$wgEchoMaxUpdateCount
|
2000 | Nombre maximal de notifications autorisées 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. |
$wgNotifyTypeAvailabilityByCategory
|
[
// Sinon un courriel user->user pourrait générer une notification de courriel supplémentaire et redondante.
'emailuser' => [
'web' => true,
'email' => false,
],
'mention-failure' => [
'web' => true,
'email' => false,
],
'mention-success' => [
'web' => true,
'email' => false,
],
]
|
Définit les types de notifications disponibles pour chaque catégorie de notification. Si des types de notifications 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 la classe EchoNotificationController. |
$wgEchoAgentBlacklist
|
[] | Liste des noms d'utilisateurs qui ne déclenchent pas les notifications |
$wgEchoOnWikiBlacklist
|
Echo-blacklist | Emplacement de la page de la liste noire maintenue par la communauté dans NS_MEDIAWIKI, avec un nom d'utilisateur par ligne, qui ne déclenche pas les notifications. Mettre à null pour désactiver. |
$wgEchoPerUserWhitelistFormat
|
%s/Echo-whitelist | Format sprintf de l'emplacement de la liste blanche par utilisateur, de l'agent de notification, dans l'espace de noms NS_USER. %s est remplacé par le nom des utilisateurs. Les listes blanches doivent avoit un nom d'utilisateur par ligne pour toujours déclencher les notifications et cela indépendamment du contenu de la liste noire. Mettre à null pour désactiver.
|
$wgEchoCrossWikiNotifications
|
false
|
Indique si la fonctionnalité des notifications inter-wiki doit être activée. Pour activer cette fonctionnalité, vous devez :
|
$wgEchoUseCrossWikiBetaFeature
|
false
|
Indicateur de fonction pour la fonctionnalité bêta de notification inter wikis
Si la valeur est à Cela ne contrôle pas si les notifications inter-wiki sont activées par défaut.
Pour cela, utilisez |
$wgEchoNotificationCategories
|
Voir extension.json | Définit 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 :
Si un type de notifications n'a pas de paramètre de catégorie, on lui assigne automatiquement la catégorie |
$wgEchoNotificationIcons
|
Voir extension.json | Définit les icônes, qui sont des images de 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 la clé de leur icône. Un exemple est myextension-name. Cela aide à éviter les conflits d'espaces de noms.
Vous pouvez utiliser un chemin ou une URL mais pas les deux. 'path' est un chemin relatif à 'url' doit être la valeur d'une URL. Vous devez personnaliser l'URL de l'icône du site qui est : |
$wgEchoNotifications
|
Voir extension.json | Définit les types d'événements pour echo. La définition des événements est du type 'nom d'événement' => [ ... ].
|
$wgEchoConfig
|
Voir extension.json | Configuration pour EventLogging. Les schémas individuels peuvent être désactivés. |
$wgEchoPerUserBlacklist
|
null
|
Booléen qui a activé la liste noire par utilisateur. |
Préférences utilisateur
| Préférences | Valeur par défaut | Commentaire |
|---|---|---|
$wgDefaultUserOptions['echo-email-frequency']
|
0 | Fréquence d'envoi des courriels, par défaut :
|
$wgDefaultUserOptions['echo-email-format']
|
Dépend de $wgAllowHTMLEmail
|
Préférence par défaut de l'utilisateur pour l'utilisation de la messagerie HTML ou texte Either html or plain-text.
|
$wgDefaultUserOptions["echo-subscriptions-email-{$category}"]
|
false pour la plupart des catégories mais cela dépend.
|
Préférence utilisateur par défaut pour indiquer si une notification par e-mail pour une catégorie particulière doit être faite |
$wgDefaultUserOptions["echo-subscriptions-web-{$category}"]
|
true pour la plupart des catégories mais cela dépend.
|
Préférence utilisateur par défaut pour indiquer s'il faut notifier via le web pour une catégorie donnée |
Architecture
Consultez la section architecture de la page de fonctionnalités.
Utilisation
- Liste négative / positive des notifications
Il existe de temps en temps des utilisateurs spécifiques tels que les robots, qui exécutent des tâches de maintenance pour lesquelles on ne devrait pas générer de notifications. Pour résoudre ces situations, les utilisateurs peuvent être globalement bannis dans le fichier LocalSettings.php (ou InitialiseSettings.php dans le cas des wikis WMF) :
$wgEchoAgentBlacklist = [ 'SampleBot', 'SampleUser' ];
Il existe par ailleurs une liste noire au niveau du wiki, pouvant être maintenue par la communauté du wiki. La liste noire globale du wiki est par défaut MediaWiki:Echo-blacklist. Les utilisateurs peuvent redéfinir individuellement la liste noire en créant une liste blanche. La liste blanche est par défaut Special:MyPage/Echo-whitelist. Toutes les listes qui se trouvent au niveau du wiki sont construites avec un nom particulier d'utilisateur par ligne, sans aucune balise ni préfixe. Par exemple :
SampleBot SampleUser
- L'option « Mention »
Un des types de notification que cette extension autorise est quand une personne vient de faire référence à ma page utilisateur : « Me prévenir quand un quelqu’un fait référence à ma page utilisateur ». Cela pourrait paraître obscur à certains utilisateurs mais cette notification particulière ne fonctionne que si la personne qui pointe vers la page utilisateur d'une autre, signe également (~~~~) son billet.
Après installation de l'extension, un nouvel onglet « Notifications » apparaît dans la page Special:Preferences de l'utilisateur. Dans la section « Me prévenir de ces événements » , pour l'option « Mention » , le survol de l'icône d'information indique : « Me prévenir quand un quelqu’un fait référence à ma page utilisateur ». Si un administrateur estime, que le besoin de signer le billet n'est pas fondamentalement nécessaire dans ce texte d'aide, il peut modifier ce dernier en changeant le texte dans la page MediaWiki:Echo-pref-tooltip-mention du Wiki.
Terminologie
- notification - Tout avis individuel qui est livré par Echo
- message - Une notification sur l'activité dans une discussion Flow
- alerte - Toute notification autre qu'un message
Voir aussi
- Notifications/API
- Manuel:Echo - pour plus de détails sur les exigences de la mention
- Extension:Echo/Creating a new notification type (actuel)
- Notifications/Developer_guide (obsolète)
| Cette extension est utilisée par au moins un des projets Wikimédia. Cela signifie probablement que l’extension est assez stable et fonctionnelle pour être utilisée sur des sites à fort trafic. Recherchez le nom de cette extension dans le CommonSettings.php de Wikimédia et dans le fichier de configuration InitialiseSettings.php pour situer les endroits où elle est installée. Une liste complète des extensions installées sur un Wiki donné peut être visualisée sur la page Special:Version de ce wiki. |
| Cette extension est incluse dans les fermes de wikis ou les hôtes suivants et / ou les paquets : Cette liste ne fait pas autorité. Certaines fermes de wikis ou hôtes et / ou paquets peuvent contenir cette extension même s'ils ne sont pas listés ici. Vérifiez toujours cela avec votre ferme de wikis ou votre hôte ou votre paquet avant de confirmer. |