feedProvide a macro to embed notifications in any page or to display a stream of events.
TypeXAR
CategoryMacro
Developed by

XWiki Development Team

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Installable with the Extension Manager

Description

Macro to embed Notifications in any page (or dashboard).

Usage

{{notifications /}}

The macro can takes the following parameters:

ParameterMandatoryDefault valueDescription
countNo10The Maximum number of events to display by default
useUserPreferencesNofalseIf true, the preferences of the user about notifications are used
displayOwnEventsNofalseIf true, the events of the current user are displayed like the others. They are hidden otherwise.
displayMinorEventsNofalseIf true, the events concerning minor revisions of pages are displayed like the others. They are hidden otherwise.
displaySystemEventsNofalseIf true, the events triggered by the XWiki software are displayed like the others. They are hidden otherwise.
displayReadEventsNotrueIf true, the events that the user have already marked as read are displayed like the others. They are hidden otherwise.
displayReadStatusNotrueEither or not the status of the events (either it has been marked as read or not) should be displayed
wikisNoList of wikis (comma-separated) to consider. This parameter is ignored if useUserPreferences is set to "true".
spacesNoList of spaces (comma-separated) to consider. This parameter is ignored if useUserPreferences is set to "true".
pagesNoList of pages (full references, comma-separated) to consider. This parameter is ignored if useUserPreferences is set to "true".
usersNoList of users (comma-separated) to consider. This parameter is ignored if useUserPreferences is set to "true".
displayWatchedUsersOnlyNofalseIf true, only events from followed/watched users are shown. This parameter is ignored if useUserPreferences is set to "true".
displayRSSLinkNotrueSince 10.6RC1If true, a link is added at the end of the notifications, to the RSS view of the current macro
tagsNoSince 10.9RC1List 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:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. 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 14.9):

Tags:
    

Get Connected