Notifications Macro
 | Provide a macro to embed notifications in any page or to display a stream of events. |
| Type | XAR |
| Category | Macro |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Bundled With | XWiki Standard |
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". |
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-notifications-macro-ui 17.5.0):
- org.xwiki.platform:xwiki-platform-notifications-script 17.5.0
- org.xwiki.platform:xwiki-platform-notifications-rest 17.5.0
- org.xwiki.platform:xwiki-platform-rendering-macro-velocity 17.5.0
- org.xwiki.platform:xwiki-platform-icon-script 17.5.0
- org.xwiki.rendering:xwiki-rendering-macro-html 17.5.0
- org.xwiki.platform:xwiki-platform-date 17.5.0
- org.xwiki.platform:xwiki-platform-alerts-ui 17.5.0
- org.xwiki.platform:xwiki-platform-notifications-preferences-default 17.5.0
- org.xwiki.platform:xwiki-platform-notifications-notifiers-default 17.5.0
