Extension/NotifyMe: Difference between revisions

Latest revision as of 13:43, 4 September 2026

done
Notifications inform users about changes and events in the wiki. Configure notification preferences to choose which events generate notifications, and use the watchlist to specify the pages and other contexts to monitor.

Notifications are configured per wikiNotification settings apply to each wiki individually. They are not shared globally across wikis.

Configure notification preferences

Notification preferences can be configured under User menu > Preferences > Notifications.

Notification preferences and the watchlistNotification preferences determine which types of events generate notifications. The watchlist determines which pages and other contexts are monitored.

Notifications preferences showing notification subscriptions, delivery channels, and email frequency

Notification preferences

Notification subscriptions

The Notification subscriptions section contains notification types that can be enabled or disabled individually. All notification types are selected by default. All notification types are selected by default.

Notification	Description
Page created	A page on the watchlist was created.
Page moved	A page on the watchlist was moved.
Page deleted	A page on the watchlist was deleted.
Page edited	A page on the watchlist was edited.
A new comment has been added to a page to which the user has subscribed via preferences	A new comment was added to a page on the watchlist.
Another user replied to a comment that the user has created or is watching	Another user replied to a comment created by the user or to a comment the user is watching.
A page was approved	A page on the watchlist was approved.

Notification channels

Notifications are always sent in the wiki. Additional delivery channels can be enabled in the Notification channels section.
Email sends notifications by email in addition to notifications in the wiki.

Configure the email notification frequency

The Frequency of email notifications setting determines how often email notifications are sent. Available options are:

Instant
Daily
Weekly

Add a page or context to the watchlist

The watchlist determines which pages and other contexts are monitored for notification events. Supported watchlist contexts include:

pages
namespaces
categories
books
other contexts where the Watch icon is available

Watch icon for adding the current page or context to the watchlist

Watch icon

To add a page or context to the watchlist:

Open the page or context to monitor.
Select the Watch icon.

The page or context is added to the watchlist. Notifications configured under Preferences > Notifications can then be generated for relevant events in that context.

View notifications

If unread notifications are available, the notification icon in the top toolbar shows the number of unread notifications. Select the notification icon to open the notification menu with recent notifications.

Notification menu showing recent notifications and the number of unread notifications

Notification menu

Select the link at the end of the notification menu to open the Notification center.

Notification center showing Unread, Read, and All notifications

Notification center

The Notification center provides the following options:

Unread displays unread notifications.
Read displays notifications that have already been read.
All displays all available notifications.
Selecting a notification marks it as read.
The notification center provides access to notification preferences.

Automatically generated notifications

Some notifications are generated automatically and do not depend on notification preferences.

For administratorsAdministrators can customize the content and design of notification emails.

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:NotifyMe}}Registered wiki users receive notifications for a variety of changes to the wiki. Users can subscribe to different types of notifications.
+<status color="green" light="true">done</status><br>
+{{DISPLAYTITLE:Notifications}}
-== Automatically generated notifications ==
+Notifications inform users about changes and events in the wiki. Configure notification preferences to choose which events generate notifications, and use the watchlist to specify the pages and other contexts to monitor.
-<span class="youtubelink">[[File:notif subscr default excerpt.png|alt=default subscriptions set in the user preferences|thumb|[[File:youtube-icon.png|alt=YouTube icon|left|22x22px]][https://youtu.be/UojRGLmDTwM YouTube: Notifications subscriptions (4:55 min.)] |360x360px|link=https://youtu.be/UojRGLmDTwM]]</span>Some notifications are not dependent on a subscription and are always automatically sent to users. These include:
+{{Textbox|boxtype=important|header=Notifications are configured per wiki|text=Notification settings apply to each wiki individually. They are not shared globally across wikis.|icon=yes}}
+== Configure notification preferences ==
-* [[Manual:Extension/BlueSpiceReminder|Reminders]]: Your reminders are due in one week or today
+Notification preferences can be configured under '''User menu > Preferences > Notifications'''.
-* [[Manual:Extension/BlueSpiceReadConfirmation|Read confirmation]] requests: You have a new read confirmation request
+{{Textbox|boxtype=note|header=Notification preferences and the watchlist|text=Notification preferences determine which types of events generate notifications. The watchlist determines which pages and other contexts are monitored.|icon=yes}}
-* [[Manual:Extension/Workflows|Mentions and tasks]]: Another user mentioned you or a new task was assigned to you
+[[File:notifications-preferences.png|alt=Notifications preferences showing notification subscriptions, delivery channels, and email frequency|center|thumb|750x750px|Notification preferences]]
-* [[Manual:Extension/Workflows|Workflow]] notifications: A workflow you initiated has finished or you have a new workflow task
+=== Notification subscriptions ===
-* [[Manual:Extension/BlueSpicePageAssignments|Page assignment]] changes: Someone assigned you to a page or removed your page assignment.   <br />'''Note:''' Users are not automatically notified about changes on pages to which they are assigned. Assigned users have to subscribe to be notified.
+The '''Notification subscriptions''' section contains notification types that can be enabled or disabled individually. All notification types are selected by default. All notification types are selected by default.
-* Changes to your user page by other users
-* Reverted changes via the page history by other users
-* Changes to your wiki permissions and other administrative events
-== Events without notifications ==
-The following events do not trigger notifications:
-* own edits
-* page revisions that are marked as "minor edit"
-== Subscribing to notifications ==
-In addition to automatic notifications, you can subscribe to additional notifications. These custom notification sets are meant to inform you about very specific events in a single context (for example: page approvals in a particular namespace).
-[[File:notification preferences.png|alt=Notifications tab with three subscriptions|center|thumb|750x750px|Notifications tab in user preferences]]
-'''To subscribe to a notification set:'''
-# '''Click''' on ''Preferences'' in your user menu.
-# '''Switch''' to the tab ''Notifications''.
-# '''Click''' the ''Add'' button.
-#'''Create''' your notification subscription. See below for [[Manual:Extension/NotifyMe#Options|selecting the options]].
-#'''Click''' ''Done'' to save your new notification set.[[File:notification edit subscription set.png|center|thumb|550x550px|alt=Dialog box for adding a subscription|Subscription settings]]
-{{Textbox|boxtype=note|header=A note for wiki administrators:|text=If you are an administrator and need to monitor the entire wiki, it is more efficient to habitually check the overview pages that show all changes in the wiki (e.g., the pages for ''Recent changes'' or the ''Quality overview'' page for the approval status of all pages) That way, you can avoid beeing flooded with notifications.|icon=yes}}
-=== Options ===
 {| class="wikitable"
-! style="" |Setting
+! Notification
-! style="" |Description
+! Description
+|-
+| '''Page created'''
+| A page on the watchlist was created.
+|-
+| '''Page moved'''
+| A page on the watchlist was moved.
+|-
+| '''Page deleted'''
+| A page on the watchlist was deleted.
 |-
-| style="" |Receive notifications for
+| '''Page edited'''
-| style="" |
+| A page on the watchlist was edited.
-* '''Book:'''  if pages change in a  book. To get notifiied about multiple namespaces, you need to create separate subscriptions.
-* '''Namespace:'''  if pages change in a  namespace. To get notifiied about multiple namespaces, you need to create separate subscriptions.'''Namespace:'''  if pages change in a  namespace. To get notifiied about multiple namespaces, you need to create separate subscriptions.
-* '''Category:'''  if pages change in a  category. To get notifiied about multiple categories, you need to create separate subscriptions. Subcategories are also not included in a category subscriptions. They each require their own notification.
-* '''Watchlist:''' if pages change that are on your watchlist.
-* '''Assigned pages:''' if pages change that are on your [[Manual:Extension/BlueSpicePageAssignments|assignments]] list.
 |-
-| style="" |Type of notifications
+| '''A new comment has been added to a page to which the user has subscribed via preferences'''
-| style="" |
+| A new comment was added to a page on the watchlist.
-* '''Low-frequency:'''
-** create / move / delete page
-** edit / delete discussion or blog topic / comment
-* '''High-frequency:'''
-** edit page
-** create blog post or discussion topic
-** create blog or discussion comment
-* '''Quality monitoring:'''
-** approval of assigned page
-** page expiry
 |-
-| style="" |Delivery method
+| '''Another user replied to a comment that the user has created or is watching'''
-| style="" |By default, notifications appear in the wiki itself. If you want to get email notifications as well, you need to activate the email checkbox.
+| Another user replied to a comment created by the user or to a comment the user is watching.
+|-
+| '''A page was approved'''
+| A page on the watchlist was approved.
 |}
+=== Notification channels ===
-== List of events that trigger notifications ==
+Notifications are always sent in the wiki. Additional delivery channels can be enabled in the '''Notification channels''' section. <br>
-{{Icon|bi bi-arrow-right-circle|||}} [[Manual:Extension/NotifyMe/triggers|View event triggers]]
+'''Email''' sends notifications by email in addition to notifications in the wiki.
+=== Configure the email notification frequency ===
-==Viewing notifications==
+The '''Frequency of email notifications''' setting determines how often email notifications are sent. Available options are:
-If a user has unread notifications, the bell symbol in the top toolbar shows the number of new notifications. Clicking the notification symbols opens a mega menu with the 10 most recent notifications.
+* '''Instant'''
-[[File:Notifications symbol.png|alt=Buttons in the top toolbar with active notifications symbol|center|thumb|300x300px|New notifications]]
+* '''Daily'''
+* '''Weekly'''
-At the end of the notifications is a link to view all notifications. This link opens the ''Notification center''.
+== Add a page or context to the watchlist ==
-[[File:Notifications center.png|alt=layout of the notification center with 4 marked areas|center|thumb|750x750px|Notifications center]]
+The watchlist determines which pages and other contexts are monitored for notification events. Supported watchlist contexts include:
+* pages
+* namespaces
+* categories
-'''The following features are available in the Notification center:'''
+* books
+* other contexts where the '''Watch''' {{Icon|bi bi-bs-watch|||}} icon is available
-'''1 - Notifications filter:''' The filter  lists notifications by category or namespace.
+[[File:watchlist-watch-icon.png|alt=Watch icon for adding the current page or context to the watchlist|center|thumb|550x550px|Watch icon]]
+'''To add a page or context to the watchlist:'''
-'''2 - Status tab:''' You can view unread notifications as well as read notifications or all notifications.
+# Open the page or context to monitor.
+# Select the '''Watch''' {{Icon|bi bi-bs-watch|||}} icon. <br>
-'''3 - Preferences:''' Here you can clear the unread notifications list or go to your user preferences to update your notification subscriptions.
+The page or context is added to the watchlist. Notifications configured under '''Preferences > Notifications''' can then be generated for relevant events in that context.
+== View notifications ==
-'''4 - Notification:''' Clicking on the filled-in blue notification marker will mark a notification as read.
+If unread notifications are available, the notification icon in the top toolbar shows the number of unread notifications. Select the notification icon {{Icon|bi bi-bs-notification|||}} to open the notification menu with recent notifications.
+[[File:notifications-menu.png|alt=Notification menu showing recent notifications and the number of unread notifications|center|thumb|550x550px|Notification menu]]
-== Customizing the notification emails ==
+Select the link at the end of the notification menu to open the '''Notification center'''.
-By default, the emails use the settings from the page ''Special:FlexiSkin''. If your wiki does not have active FlexiSkin settings, the standard template uses the BlueSpice Logo and default colors.
+[[File:notifications-center.png|alt=Notification center showing Unread, Read, and All notifications|center|thumb|750x750px|Notification center]]
+The '''Notification center''' provides the following options:
-[[File:Standard notification email layout.png|alt=Screenshot of the default layout with example content|center|thumb|550x550px|Notification email layout]]
+* '''Unread''' displays unread notifications.
+* '''Read''' displays notifications that have already been read.
-You can customize the content and design of the default email layout directly in the wiki. This requires changes to the following three pages:
+* '''All''' displays all available notifications.
+* Selecting a notification marks it as read.
-* MediaWiki:Wrapper.mail
+* The notification center provides access to notification preferences.
-* MediaWiki:SingleNotification.mail
+== Automatically generated notifications ==
-* MediaWiki:DigestNotification.mail
+[[Extension/NotifyMe/Trigger|Some notifications]] are generated automatically and do not depend on notification preferences.
-{{Icon|bi bi-arrow-right-circle|||}} [[Manual:Extension/NotifyMe/Email layout|How to customize the notification email layout]]
+{{Textbox|boxtype=important|header=For administrators|text=Administrators can customize the content and design of [[Extension/NotifyMe/Email layout|notification emails]].|icon=yes}}
-{{translation}}
-[[Category:Personalization]]
-__FORCETOC__