Extension:Echo/nl

From mediawiki.org
This page is a translated version of the page Extension:Echo and the translation is 100% complete.
Deze extensie is meegeleverd met MediaWiki 1.40 en nieuwer. Het is dus niet nodig om deze opnieuw te downloaden. De andere instructies hier beneden moeten nog wel gevolgd worden.
MediaWiki Handleiding extensies
Echo
Release status: stabiel
Implementatie Inlichten
Beschrijving Biedt een intern wiki meldingssysteem dat kan worden gebruikt door andere extensies.
Auteur(s)
Laatste versie voortdurend updates
Compatibiliteit beleid Snapshots releases samen met MediaWiki. Master is niet achterwaarts compatibel.
MediaWiki >= 1.42.0
Database wijzigingen Ja
Tabellen echo_email_batch
echo_event
echo_notification
echo_subscription
echo_target_page
echo_push_provider
echo_push_subscription
echo_push_topic
echo_unread_wikis
Licentie MIT Licentie
Download
  • $wgEchoNotificationCategories
  • $wgEchoMaxMentionsCount
  • $wgEchoPerUserWhitelistFormat
  • $wgEchoPushMaxSubscriptionsPerUser
  • $wgEchoMentionOnChanges
  • $wgEchoPollForUpdates
  • $wgEchoUseJobQueue
  • $wgEchoBundleEmailInterval
  • $wgEchoMentionsOnMultipleSectionEdits
  • $wgDefaultNotifyTypeAvailability
  • $wgEchoSecondaryIcons
  • $wgEchoCacheVersion
  • $wgEchoMaxUpdateCount
  • $wgEchoNotifiers
  • $wgEchoAgentBlacklist
  • $wgEchoSharedTrackingCluster
  • $wgEchoEnablePush
  • $wgEchoPerUserBlacklist
  • $wgEchoEnableEmailBatch
  • $wgEchoWatchlistNotifications
  • $wgNotifyTypeAvailabilityByCategory
  • $wgEchoMaxMentionsInEditSummary
  • $wgEchoNotifications
  • $wgEchoCluster
  • $wgEchoPushServiceBaseUrl
  • $wgEchoWatchlistEmailOncePerPage
  • $wgAllowArticleReminderNotification
  • $wgEchoNotificationIcons
  • $wgEchoSharedTrackingDB
  • $wgEchoOnWikiBlacklist
  • $wgEchoSeenTimeCacheType
  • $wgEchoMentionStatusNotifications
  • $wgEchoCrossWikiNotifications
  • $wgEchoEmailFooterAddress
  • manage-all-push-subscriptions
Downloads kwartaal 158 (Ranked 42nd)
Publieke wiki's die het gebruiken 2,698 (Ranked 187th)
Vertaal de Echo extensie indien beschikbaar op translatewiki.net
Problemen Open taken · Rapporteer een bug

De extensie Echo biedt een intern wiki meldingssysteem dat kan worden gebruikt door andere extensies. Thanks/nl en StructuredDiscussions zijn twee MediaWiki-extensies die Echo gebruiken. Zie Notifications/nl voor een volledige beschrijving van wat deze extensie doet.

Installatie

  • De gebruiker van de database moet het recht "REFERENCES" voor de database hebben gekregen.
  • Download en plaats de bestanden in de map Echo in de map extensions/.
    Ontwikkelaars en bijdragers van code moeten in plaats daarvan de extensie van Git installeren, met behulp van:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/Echo
  • Voeg de volgende code onderaan het bestand LocalSettings.php toe:
    wfLoadExtension( 'Echo' );
    
  • Voer het update script uit, dat automatisch de vereiste database-tabellen creëert die nodig zijn voor de extensie.
  • U kunt de extensie naar uw voorkeuren instellen.
  • Yes Klaar – Navigeer naar Special:Version op de wiki om te controleren dat de extensie geïnstalleerd is.

Om dagelijkse of wekelijkse samenvattende meldingen per post te laten afleveren (voor gebruikers die dat kiezen in hun voorkeuren), moet het volgende script in de Echo extensie-map dagelijks worden uitgevoerd, dat in een cron-opdracht kan worden ingepland:

maintenance/processEchoEmailBatch.php

Configuratie

Het is mogelijk om conditionele gebruikersopties te gebruiken om verschillende notificatievoorkeuren in te stellen voor nieuwe gebruikers, zonder dat dit gevolgen heeft voor bestaande gebruikers.

Zie Special:DisplayNotificationsConfiguration voor lokale details.

Parameters

Configuratie-instellingen (standaardwaarden gedefinieerd in extension.json)
Parameter Standaardwaarde Opmerking
$wgEchoEnableEmailBatch true Of de functie e-mailbatch moet worden ingeschakeld
$wgEchoUseJobQueue false
  • true - Verzorg de levering van web- en e-mailmeldingen via een wachtrij.
  • false - Meldingen onmiddellijk afleveren
$wgEchoEmailFooterAddress '' Het organisatiedres (of welke tekst u ook wilt opnemen in de voet van de e-mailmeldingen). Moet gedefinieerd worden in LocalSettings.php
$wgNotificationSender $wgPasswordSender Het e-mailadres voor zowel "van" als "antwoord op" bij e-mails. Moet gedefinieerd worden in LocalSettings.php
$wgNotificationSenderName "emailsender" bericht (MediaWiki) Naam voor "van" in e-mailmeldingen. Moet gedefinieerd worden in LocalSettings.php
$wgNotificationReplyName No Reply Naam voor "antwoord op" in e-mailmeldingen. Moet gedefinieerd worden in LocalSettings.php
$wgEchoCluster false Gebruik de hoofddatabase als deze is ingesteld op false, om een specifieke externe database te gebruiken, gebruik gewoon een key die is gedefinieerd in $wgExternalServers
$wgEchoSharedTrackingDB false Gedeelde database voor het bijhouden van niet-gelezen meldingen tussen wiki's; false om deze helemaal niet bij te houden
$wgEchoSharedTrackingCluster false Cluster waarop de gedeelde trackingdatabase is gevestigd; false als deze zich in de hoofddatabase bevindt. Moet een key zijn die gedefinieerd is in $wgExternalServers
$wgEchoMaxUpdateCount 2000 Het maximale aantal meldingen dat een gebruiker kan doen om een live update uit te voeren, is ook het maximale aantal kennisgevingen dat een user kan hebben.
$wgEchoMaxMentionsCount 50 Het maximale aantal meldingen dat een gebruiker in een keer kan verzenden
$wgEchoMentionStatusNotifications false Meldingsresultaten van succes/mislukking inschakelen
$wgEchoMentionsOnMultipleSectionEdits true Trigger vermeldingen voor bewerkingen van meerdere secties
$wgEchoMentionOnChanges true Trigger vermeldingen voor bewerkingen van bestaande opmerkingen, zolang een handtekening in hetzelfde gedeelte wordt toegevoegd
$wgEchoMaxMentionsInEditSummary 0 Maximaal aantal gebruikers die worden gemeld dat zij zijn gekoppeld aan een samenvatting van bewerkingen of 0 voor geen meldingen
$wgEchoBundleEmailInterval 0 Het tijdsinterval tussen elke e-mail in seconden; stel een klein aantal voor test-wiki's. Dit moet worden ingesteld op 0 om e-mail bundeling te deactiveren als er geen vertraging wachtrij ondersteuning is
$wgEchoNewMsgAlert true Of een nieuwe meldingswaarschuwing op de overlegpagina voor ingelogde gebruikers moet worden ingeschakeld.
$wgEchoShowFooterNotice false Of de feedbackmelding in voet van de openstaande meldingen moet worden weergegeven
$wgEchoFooterNoticeURL '' Een URL voor de enquête die in de feedbackmelding in de optie van de kennisgeving verschijnt in de voet
$wgNotifyTypeAvailabilityByCategory
[
	// Anders kan een e-mail van gebruiker>gebruiker een extra redundante meldingsmail veroorzaken.
	'emailuser' => [
		'web' => true,
		'email' => false,
	],
	'mention-failure' => [
		'web' => true,
		'email' => false,
	],
	'mention-success' => [
		'web' => true,
		'email' => false,
	],
]
Definieer welke meldingstypes beschikbaar zijn voor elke meldingscategorie. Als er meldingtypes worden weggelaten, wordt het standaard $wgDefaultNotifyTypeAvailability.
$wgEchoNotifiers
[
	'web' => [ 'EchoNotifier', 'notifyWithNotification' ],
	'email' => [ 'EchoNotifier', 'notifyWithEmail' ],
]
Definities van de verschillende meldingstypes voor het afleveren van meldingen. Elke definitie bestaat uit een classname en een functienaam. Zie ook EchoNotificationController class.
$wgEchoAgentBlacklist [] Lijst van gebruikersnamen waarvoor geen meldingen worden gegeven
$wgEchoOnWikiBlacklist Echo-blacklist Pagina locatie van de community onderhouden zwarte lijst binnen NS_MEDIAWIKI met één gebruikersnaam per rij waarvoor geen meldingen worden verzonden. Zet het op null om het uit te schakelen.
$wgEchoPerUserWhitelistFormat %s/Echo-whitelist Een sprintf-formaat van de locatie van de witte lijst van de kennisgevings-agent per gebruiker binnen de namespace NS_USER. %s wordt vervangen door de gebruikersnaam. Een wittelijst moet één gebruikersnaam per rij bevatten, die altijd tot een melding leidt ongeacht of die gebruiker in een zwartelijst zijn opgenomen. Zet het op null om het uit te schakelen.
$wgEchoCrossWikiNotifications false Of de cross-wiki-meldingsfunctie moet worden ingeschakeld. Om deze functie in te schakelen moet u:
  • heeft een wereldwijd gebruikerssysteem (bv. CentralAuth of een gedeelde gebruikerstabel)
  • hebben $wgMainStash en $wgMainWANCache gedeeld tussen wiki's
  • configureer $wgEchoSharedTrackingDB
$wgEchoUseCrossWikiBetaFeature false Functie vlag voor de beta-functie van de cross-wiki-meldingen

Als dit true is, verschijnt de voorkeur voor cross-wiki-meldingen in het gedeelte BetaFeatures. Als dit false is, verschijnt het in het gedeelte Notificaties .

Dit bepaald niet of cross-wiki-meldingen standaard zijn ingeschakeld. Daarvoor wordt $wgDefaultUserOptions['echo-cross-wiki-notifications'] = true; gebruikt

$wgEchoNotificationCategories Zie extension.json De categorieën waarin notificaties kunnen behoren, worden gedefinieerd. De volgende parameters kunnen aan de categorieën worden toegewezen. Alle parameters zijn optioneel:
  • priority - controleert de volgorde waarin de meldingen worden weergegeven in voorkeuren en batch e-mails. De prioriteit varieert van 1 tot 10. Als de prioriteit niet wordt gespecificeerd, wordt deze standaard vastgesteld op 10, wat het laagste is.
  • no-dismiss - schakelt de afwijzing van notificaties in de categorie uit. Het kan worden ingesteld op een array van uitvoerformaten (zie $wgEchoNotifiers) of een array met 'alles'.
  • usergroups - geeft een reeks gebruikersgroepen aan die in aanmerking komen voor de notificaties in de categorie te ontvangen. Indien geen gebruikersgroep parameter is gespecificeerd, komen alle groepen in aanmerking.

Als een notificatie-type geen categorieparameter heeft, wordt het automatisch toegewezen aan de categorie other die de laagste prioriteit heeft en geen voorkeuren of ontvankelijkheid heeft.

$wgEchoNotificationIcons Zie extension.json De definitie van iconen, die 30x30 afbeeldingen zijn. Dit wordt doorgestuurd naar BeforeCreateEchoEvent zodat extensies hun eigen iconen met dezelfde structuur kunnen definiëren. Het wordt aanbevolen dat extensies vooraf hun icoon-key geven. Een voorbeeld is myextension-name. Dit zal helpen om conflicten in de namespace te voorkomen.

U kunt een pad of een URL gebruiken, maar niet allebei. De waarde van 'path' is relatief tot $wgExtensionAssetsPath.

De waarde van 'url' moet een URL zijn.

U moet de site-icon URL aanpassen, dat is: $wgEchoNotificationIcons['site']['url']

$wgEchoNotifications Zie extension.json Definieer de gebeurtenistypes voor echo. De definities van gebeurtenissen zijn in de vorm van 'event-name' => [ ... ].
  • category - De categorie waarin het gebeurtenis hoort, wordt gedefinieerd. Standaardwaarde is 'other'.
  • group - Standaardwaarde is 'neutral'.
  • bundle - definieert welke uitvoerformaten beschikbaar zijn voor bundeling.
  • presentation-model - definieert welke klasse wordt gebruikt om meldingen en links voor meldingspanelen, speciale pagina's en e-mails weer te geven. Het moet EchoEventPresentationModel uitbreiden.
$wgEchoConfig Zie extension.json Configuratie voor EventLogging. Individuele schema's kunnen worden uitgeschakeld.
$wgEchoPerUserBlacklist null Boolean die de 'Per User Blacklist' inschakelt.

Gebruikersvoorkeuren

Voorkeursinstellingen (standaard gedefinieerd in extension.json)
Voorkeur Standaardwaarde Opmerkingen
$wgDefaultUserOptions['echo-show-alert'] true Gebruikersvoorkeur voor het weergeven van de speciale waarschuwingsbalk van de overlegpagina
$wgDefaultUserOptions['echo-email-frequency'] 0 Hoe vaak moeten e-mails verstuurd worden, standaard:
  • 0 - e-mails versturen voor elke notificatie wanneer die binnenkomt (standaard)
  • -1 - stuur geen e-mails
  • 1 - elke dag
  • 7 - elke 7 dagen
  • ...
$wgDefaultUserOptions['echo-dismiss-feedback-alert'] 0 Zorgt ervoor dat de feedbackmelding standaard zichtbaar is. Verander dit niet; om het te uitschakelen, gebruik $wgEchoShowFooterNotice.
$wgDefaultUserOptions['echo-email-format'] Afhankelijk van $wgAllowHTMLEmail Standaard gebruikersvoorkeur voor het gebruik van HTML of tekst-e-mail. Either html or plain-text.
$wgDefaultUserOptions["echo-subscriptions-email-{$category}"] false voor de meeste categorieën; afhankelijk Standaard gebruikersvoorkeur voor het notificeren via e-mail voor een bepaalde categorie
$wgDefaultUserOptions["echo-subscriptions-web-{$category}"] true voor de meeste categorieën; afhankelijk Standaard gebruikersvoorkeur voor het notificeren via web voor een bepaalde categorie

Architectuur

Zie de architectuursectie van de functiepagina .

Gebruik

Negatieve lijst / positieve lijst voor de kennisgeving

Er zijn af en toe specifieke gebruikers, meestal bots, die onderhoudswerkzaamheden uitvoeren die geen meldingen moeten genereren. Om deze gevallen te behandelen, kunnen gebruikers op de zwarte lijst gezet worden van het bestand LocalSettings.php (of InitialiseSettings.php in het geval van WMF-wiki's):

$wgEchoAgentBlacklist = [ 'SampleBot', 'SampleUser' ];

Er is ook een zwarte lijst op wiki die kan worden onderhouden door de wiki gemeenschap. De locatie van de globale on-wiki zwarte lijst wordt standaard vastgesteld op MediaWiki:Echo-blacklist. Individuele gebruikers kunnen de zwarte lijst overschrijven door een witte lijst te maken. De locatie van de witte lijst is standaard Special:MyPage/Echo-whitelist. Alle wiki-lijsten verwachten een specifieke gebruikersnaam per regel te ontvangen zonder speciale markeringen of voorvoegsels. Bijvoorbeeld:

SampleBot
SampleUser
Optie "Mention"

Een van de meldingssoorten die deze extensie toestaat is: "Meldt het mij wanneer iemand een link naar mijn gebruikerspagina maakt." Het is misschien voor sommige gebruikers niet duidelijk, maar deze specifieke kennisgeving werkt alleen als de persoon die een link naar de pagina van een andere gebruiker heeft ook (~~~~) de post ondertekent.

Na de installatie van de extensie wordt een nieuwe tabblad "Meldingen" gecreëerd op de pagina Special:Preferences van een gebruiker. Onder de sectie "Breng mij op de hoogte van deze gebeurtenissen", voor de optie "Mention", staat in de hoverbox: "Breng me op de hoogte wanneer iemand naar mijn gebruikerspagina linkt." Als een beheerder denkt dat de vereiste om de post te ondertekenen niet duidelijk is in deze hulptekst, kan deze worden gewijzigd door de tekst in de MediaWiki:Echo-pref-tooltip-mention pagina van de Wiki te wijzigen.

Terminologie

  • notification - Elke individuele kennisgeving die door Echo wordt verstrekt
  • message - Een melding over activiteit in een Flow-discussie
  • alert - Elke andere melding dan een 'message'

Zie ook