Notifications Macro
Last modified by Vincent Massol on 2021/03/01 00:12
 | Provide a macro to embed notifications in any page or to display a stream of events. |
| Type | XAR |
| Category | Macro |
| Developed by | |
| Active Installs | 3969 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
Macro to embed Notifications in any page (or dashboard).
Usage
{{notifications /}}
The macro can takes the following parameters:
| Parameter | Mandatory | Default value | Description |
|---|---|---|---|
| count | No | 10 | The Maximum number of events to display by default |
| useUserPreferences | No | false | If true, the preferences of the user about notifications are used |
| displayOwnEvents | No | false | If true, the events of the current user are displayed like the others. They are hidden otherwise. |
| displayMinorEvents | No | false | If true, the events concerning minor revisions of pages are displayed like the others. They are hidden otherwise. |
| displaySystemEvents | No | false | If true, the events triggered by the XWiki software are displayed like the others. They are hidden otherwise. |
| displayReadEvents | No | true | If true, the events that the user have already marked as read are displayed like the others. They are hidden otherwise. |
| displayReadStatus | No | true | Either or not the status of the events (either it has been marked as read or not) should be displayed |
| wikis | No | List of wikis (comma-separated) to consider. This parameter is ignored if useUserPreferences is set to "true". | |
| spaces | No | List of spaces (comma-separated) to consider. This parameter is ignored if useUserPreferences is set to "true". | |
| pages | No | List of pages (full references, comma-separated) to consider. This parameter is ignored if useUserPreferences is set to "true". | |
| users | No | List of users (comma-separated) to consider. This parameter is ignored if useUserPreferences is set to "true". | |
| displayWatchedUsersOnly | No | false | If true, only events from followed/watched users are shown. This parameter is ignored if useUserPreferences is set to "true". |
| displayRSSLink | No | true | If true, a link is added at the end of the notifications, to the RSS view of the current macro |
| tags | No | List of tags to consider (comma-separated). It only works on the current wiki. Ignored if "useUserPreferences" is set to "true". |
