4.3 Notifications subscriptions

Latest revision as of 14:06, 4 September 2024

BlueSpice 4.5:This help page applies to the notifications functionality for BlueSpice 4.5+. For earlier versions, go to the previous documentation.

Registered wiki users receive notifications for a variety of changes to the wiki. Users can subscribe to different types of notifications.

Automatically generated notifications

YouTube: Notifications subscriptions (4:55 min.)

Some notifications are not dependent on a subscription and are always automatically sent to users. These include:

Reminders: Your reminders are due in one week or today
Read confirmation requests: You have a new read confirmation request
Mentions and tasks: Another user mentioned you or a new task was assigned to you
Workflow notifications: A workflow you initiated has finished or you have a new workflow task
Page assignment changes: Someone assigned you to a page or removed your page assignment.
Note: Users are not automatically notified about changes on pages to which they are assigned. Assigned users have to subscribe to be notified.
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

List of events that trigger automatic notifications

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).

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 selecting the options.
Click Done to save your new notification set.

Subscription settings

A note for wiki administrators: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.

Options

Setting	Description
Receive notifications for	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 assignments list.
Type of notifications	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
Delivery method	By default, notifications appear in the wiki itself. If you want to get email notifications as well, you need to activate the email checkbox.

Viewing notifications

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.

New notifications

At the end of the notifications is a link to view all notifications. This link opens the Notification center.

Notifications center

The following features are available in the Notification center:

1 - Notifications filter: The filter lists notifications by category or namespace.

2 - Status tab: You can view unread notifications as well as read notifications or all notifications.

3 - Preferences: Here you can clear the unread notifications list or go to your user preferences to update your notification subscriptions.

4 - Notification: Clicking on the filled-in blue notification marker will mark a notification as read.

Customizing the notification emails

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.

Notification email layout

You can customize the content and design of the default email layout directly in the wiki. This requires changes to the following three pages:

MediaWiki:Wrapper.mail
MediaWiki:SingleNotification.mail
MediaWiki:DigestNotification.mail

How to customize the notification email layout

Technical Reference: NotifyMe

To submit feedback about this documentation, visit our community forum.

@@ Line 1: / Line 1: @@
-{{DISPLAYTITLE:Notifications}}
+{{DISPLAYTITLE:NotifyMe}}
+{{Textbox|boxtype=note|header=BlueSpice 4.5:|text=This help page applies to the notifications functionality for BlueSpice 4.5+. For earlier versions, go to the [[Manual:Extension/BlueSpiceEchoConnector|previous documentation]].|icon=yes}}
-Registered wiki users receive notifications for a variety of changes to the wiki. Users can set their notification preferences as needed.
+Registered wiki users receive notifications for a variety of changes to the wiki. Users can subscribe to different types of notifications.
-== Viewing notifications ==
+== Automatically generated notifications ==
-To access the notifications page, click on your profile picture (1) and then click on ''Notifications'' in the Personal Tools (2). A red indicator is displayed if there are new notifications waiting.
+<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:
-[[File:Manual:notifications-menulink.png|alt=Link to the notifications page|center|thumb|650x650px|Link to the notifications page]]
+* [[Manual:Extension/BlueSpiceReminder|Reminders]]: Your reminders are due in one week or today
+* [[Manual:Extension/BlueSpiceReadConfirmation|Read confirmation]] requests: You have a new read confirmation request
+* [[Manual:Extension/Workflows|Mentions and tasks]]: Another user mentioned you or a new task was assigned to you
+* [[Manual:Extension/Workflows|Workflow]] notifications: A workflow you initiated has finished or you have a new workflow task
+* [[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.
+* 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
+{{Icon|bi bi-arrow-right-circle|||}} [[Manual:Extension/NotifyMe/standard|List of events that trigger automatic notifications]]
-The notifications page shows all incoming notifications.
+== Events without notifications ==
-[[File:Manual:notifications-page.png|alt=Notifications page|center|thumb|650x650px|Notifications page]]
+The following events do not trigger notifications:
+* own edits
+* page revisions that are marked as "minor edit"
-The following features are available:
+== 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]]
-'''1 - Recent activity:''' The filter  lists notifications by page. Clicking on a page name will only show the notifications for that page.
+'''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}}
-'''2 - Status filter:''' You can view all notifications as well as read or unread notifications.
+=== Options ===
+{| class="wikitable"
+!Setting
+!Description
+|-
+|Receive notifications for
+|
+* '''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.
+|-
+|Type of notifications
+|
+* '''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
+|-
+|Delivery method
+|By default, notifications appear in the wiki itself. If you want to get email notifications as well, you need to activate the email checkbox.
+|}
-'''3 - Settings menu:''' Here you can go to the settings page to choose the type of notifications you want to receive.
+==Viewing notifications==
+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.
+[[File:Notifications symbol.png|alt=Buttons in the top toolbar with active notifications symbol|center|thumb|300x300px|New notifications]]
-'''4 - Notification:''' Clicking on a notification will mark it as read. Alternatively, you can click the blue status icon. Read notifications are marked with a dark background and a blank status icon.
+At the end of the notifications is a link to view all notifications. This link opens the ''Notification center''.
+[[File:Notifications center.png|alt=layout of the notification center with 4 marked areas|center|thumb|750x750px|Notifications center]]
-== Notification settings==
-{{Messagebox|boxtype=note|icon=|Note text=<br />
-*You are not notified about your own edits.
-*No notifications are generated for page changes marked as "minor edit".
-[[File:Manual:minorEdit.png|alt=Minor edit|200x200px|Minor edit]]|bgcolor=}}
-The following settings are available:
-*'''E-Mail options:'''
-**''Send me:'' Frequency of notifications (none, immediately, daily, weekly)
+'''The following features are available in the Notification center:'''
-**''Send to:'' If you enter or change the e-mail address here, it will be changed for the entire wiki (i.e., under your profile data).
-**''Email format:'' (HTML or plain text)
+'''1 - Notifications filter:''' The filter  lists notifications by category or namespace.
-*<span style="color: rgb(37, 37, 37)">'''Notify me about these events''':</span>  E-mail and wiki notifications for different events can optionally be activated or deactivated here. You can see a description of the event by clicking on the info icon. Grayed out checkboxes cannot be activated or deactivated and are set the same for all users.
-*<span style="color: rgb(37, 37, 37)">'''Notifications on namespace events'''</span> <span class="ve-pasteProtect" style="color: rgb(37, 37, 37)">(always both in e-mail and in the wiki):</span>
+'''2 - Status tab:''' You can view unread notifications as well as read notifications or all notifications.
-**when creating pages in a namespace when editing pages in a namespace
-*<span style="color: rgb(37, 37, 37)">'''Notifications on categories'''</span> <span class="ve-pasteProtect" style="color: rgb(37, 37, 37)">(always both in e-mail and in the wiki)</span><span style="color: rgb(37, 37, 37)">:</span>
+'''3 - Preferences:''' Here you can clear the unread notifications list or go to your user preferences to update your notification subscriptions.
-**when a page is added or removed from a category listed here
-**when a change is made to a page associated with that category
+'''4 - Notification:''' Clicking on the filled-in blue notification marker will mark a notification as read.
+== Customizing the notification emails ==
+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:Standard notification email layout.png|alt=Screenshot of the default layout with example content|center|thumb|550x550px|Notification email layout]]
+You can customize the content and design of the default email layout directly in the wiki. This requires changes to the following three pages:
+* MediaWiki:Wrapper.mail
+* MediaWiki:SingleNotification.mail
+* MediaWiki:DigestNotification.mail
+{{Icon|bi bi-arrow-right-circle|||}} [[Manual:Extension/NotifyMe/Email layout|How to customize the notification email layout]]
 {{translation}}
 [[Category:Personalization]]
 __FORCETOC__