Wiki source code of Notifications
Last modified by Eleni Cojocariu on 2026/10/15 16:37
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The [[Notifications Application>>doc:extensions:Extension.Notifications Application.WebHome]] keeps you informed of what happens on the wiki, through channels you can use independently of each other: the notifications menu inside the wiki, mail, and [[RSS feeds>>doc:documentation.xs.user.notifications.subscribe-rss-feed.rss-feeds.WebHome]]. | ||
| 2 | |||
| 3 | Two independent choices decide what reaches you: | ||
| 4 | |||
| 5 | * which events interest you, and | ||
| 6 | * where they have to happen. | ||
| 7 | |||
| 8 | An event has to pass both before it is delivered on any channel. | ||
| 9 | |||
| 10 | {{plantuml}} | ||
| 11 | @startuml | ||
| 12 | !theme bluegray | ||
| 13 | skinparam nodesep 25 | ||
| 14 | skinparam ranksep 30 | ||
| 15 | |||
| 16 | start | ||
| 17 | :somebody acts on the wiki; | ||
| 18 | if (an event type you enabled?) then (no) | ||
| 19 | :nothing reaches you; | ||
| 20 | stop | ||
| 21 | endif | ||
| 22 | if (in a location or from a user you watch?) then (no) | ||
| 23 | :nothing reaches you; | ||
| 24 | stop | ||
| 25 | endif | ||
| 26 | if (dropped by one of your filters?) then (yes) | ||
| 27 | :nothing reaches you; | ||
| 28 | stop | ||
| 29 | endif | ||
| 30 | fork | ||
| 31 | :notifications menu; | ||
| 32 | fork again | ||
| 33 | :mail; | ||
| 34 | fork again | ||
| 35 | :RSS feed; | ||
| 36 | end fork | ||
| 37 | stop | ||
| 38 | @enduml | ||
| 39 | {{/plantuml}} | ||
| 40 | |||
| 41 | The bell in the top bar, provided by the [[Alerts Application>>doc:extensions:Extension.Alerts Application.WebHome]], is where you [[Read Your Notifications>>doc:documentation.xs.user.notifications.read-notifications.WebHome]]. Its badge counts the notifications you have not read yet, and reads "20+" past twenty. Events that resemble each other arrive as a single entry, which [[Notification Grouping>>doc:documentation.xs.user.notifications.notification-grouping.WebHome]] explains. | ||
| 42 | |||
| 43 | Every setting below lives in your own profile: [[Change the Notification Settings>>doc:documentation.xs.user.notifications.change-notifications-settings.WebHome]] opens it. From there, [[Choose Which Notifications You Receive>>doc:documentation.xs.user.notifications.choose-notification-types.WebHome]] turns event types on and off, [[Watch a Page or a Wiki>>doc:documentation.xs.user.notifications.watched-entities.watch-page-wiki.WebHome]] and [[Follow a User>>doc:documentation.xs.user.notifications.follow-user.WebHome]] pick the places and people you care about, and [[Watched Entities>>doc:documentation.xs.user.notifications.watched-entities.WebHome]] explains how those choices relate to each other. | ||
| 44 | |||
| 45 | [[Filter the Notifications You Receive>>doc:documentation.xs.user.notifications.filter-notifications.WebHome]] narrows the result further, and [[Notification Filters>>doc:documentation.xs.user.notifications.filter-notifications.notification-filters.WebHome]] documents every filter a wiki ships with. | ||
| 46 | |||
| 47 | To get the same events by mail, [[Receive Notifications by Email>>doc:documentation.xs.user.notifications.receive-notifications-email.WebHome]]. To follow them from outside the wiki, [[Subscribe to the Notifications RSS Feed>>doc:documentation.xs.user.notifications.subscribe-rss-feed.WebHome]]; [[RSS Feeds>>doc:documentation.xs.user.notifications.subscribe-rss-feed.rss-feeds.WebHome]] lists the other feeds a wiki offers. The [[Notifications Macro>>doc:documentation.xs.user.notifications.macro.WebHome]] puts the same list inside a wiki page. | ||
| 48 | |||
| 49 | Other ways of being notified come from separate applications. The [[Share Page Application>>doc:extensions:Extension.Share Page Application]] sends a page by mail to another user of the wiki or to any email address. The [[User Mentions Application>>doc:extensions:Extension.Mentions Application.WebHome]] notifies you when somebody mentions you in a page, a comment, or any field supporting XWiki syntax. The [[What's New Application>>doc:extensions:Extension.WhatsNewUI.WebHome]] tells you about news regarding XWiki itself. |
