Manual:Extension/Notifications: Difference between revisions

Latest revision as of 12:35, 5 July 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.

Subscribing to notifications

To receive notifications, you first need to subscribe. Notifications are meant to inform about very specific events in a single context (e.g., page approvals in a particular namespace).

Click on Preferences in your user menu.
Switch to the tab Notifications.
Click the Add button.
Create your notification subscription.

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 add / remove page assignment page expiry;
Delivery method	By default, notifications appear in the wiki itself. If you want to additionally get email notifications, 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 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:

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.

Automatically generated notifications

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

Reminders
Read confirmation requests
Mentions and tasks
Workflow notifications
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 marked as "This is a minor edit"

Technical Reference: Notifications

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

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:Notifications}}
-Registered wiki users receive notifications for a variety of changes to the wiki. Users can set their notification preferences as needed.
+{{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 subscribe to different types of notifications.
+== Subscribing to notifications ==
+To receive notifications, you first need to subscribe. Notifications are meant to inform about very specific events in a single context (e.g., page approvals in a particular namespace).
+# '''Click''' on ''Preferences'' in your user menu.
+# '''Switch''' to the tab ''Notifications''.
+# '''Click''' the ''Add'' button.
+#'''Create''' your notification subscription.[[File:notification edit subscription set.png|center|thumb|350x350px|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"
+!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
+** add / remove page assignment
+** page expiry;
+|-
+|Delivery method
+|By default, notifications appear in the wiki itself. If you want to additionally get email notifications, 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 most recent notifications.
+[[File:Notifications symbol.png|alt=Buttons in the top toolbar with active notifications symbol|center|thumb|300x300px|New notifications]]
+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|650x650px|Notifications center]]
-== Viewing 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.
-[[File:Manual:notifications-menulink.png|alt=Link to the notifications page|center|thumb|650x650px|Link to the notifications page]]
-The notifications page shows all incoming notifications.
-[[File:Manual:notifications-page.png|alt=Notifications page|center|thumb|650x650px|Notifications page]]
 The following features are available:
-'''1 - Recent activity:''' The filter  lists notifications by page. Clicking on a page name will only show the notifications for that page.
+'''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.
-'''2 - Status filter:''' You can view all notifications as well as read or unread notifications.
+'''4 - Notification:''' Clicking on the filled-in blue notification marker will mark a notification as read.
-'''3 - Settings menu:''' Here you can go to the settings page to choose the type of notifications you want to receive.
+== Automatically generated notifications ==
+Some notifications are not dependent on a subscription and automatically sent to users. These include:
-'''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.
+* [[Manual:Extension/BlueSpiceReminder|Reminders]]
+* [[Manual:Extension/BlueSpiceReadConfirmation|Read confirmation]] requests
+* [[Manual:Extension/Workflows|Mentions and tasks]]
+* [[Manual:Extension/Workflows|Workflow]] notifications
+* 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
-== Notification settings==
+== Events without notifications ==
-{{Messagebox|boxtype=note|icon=|Note text=<br />
+The following events do not trigger notifications:
-*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:'''
+* own edits
-**''Send me:'' Frequency of notifications (none, immediately, daily, weekly)
+* page revisions marked as "This is a minor edit"
-**''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)
-*<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>
-**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>
-**when a page is added or removed from a category listed here
-**when a change is made to a page associated with that category
 {{translation}}
 [[Category:Personalization]]
 __FORCETOC__