Message Stream Application

Version 17.1 by Guillaume Delhumeau on 2018/06/05 15:17

cogMacro to display a message stream
TypeXAR
Category
Developed by

XWiki Development Team

Active Installs3657
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Enterprise

Installable with the Extension Manager

Description

Provides the ability to send messages to other users or groups in the wiki.

Usage

There are several ways of sharing a status message.

Sharing on the Dashboard Page

You can share a post on the default Dashboard (Dashboard.WebHome) by writing it in the text area above the Activity Stream. The message can be visible:

  • to everyone
  • to your followers - you can specify a follower like this: XWiki.UserName 
  • to a specific group (e.g.: XWiki.GroupName)

    StatusMessageVisibleToGroup.png

  • to a specific user (e.g.: XWiki.UserName)

    StatusMessageVisibleToUser.png

You will be then able to see the posts in your Activity Stream.

PostStatusMessage.png

See the messages inside the notifications

Since XWiki 9.11.6 and XWiki 10.5RC1, you can also see the posts in the notifications:

MessagesInNotifications.png

But, for that, you need to enable them in your notification settings:

NotificationSettings.png

Sharing on your User Profile Page

You can also share a message via your user profile page using the "Send Message" widget located "My Activity Stream".

PostOnUserProfile.png

Sharing on Another User's Profile Page

You can share status messages on other user's profile page. The posts will be visible by default only to that user.

PostOnAnotherUserProfile.png

Deleting a Status Message

To delete one of your status messages:

Go to the "Profile" menu in the top right corner and click on "Network". Hover the post you wish to delete, click on the red "x" in the top right corner near the creation date and confirm.
DeletePost.png

ConfirmPostDeletion.png

Go to the main homepage, hover the post you wish to delete, click on the red "x" in the top right corner near the creation date and confirm.

Macro Usage

You can also use the following macro to add a box to send messages anywhere your wish in the wiki:

{{messageSender/}}

Configuration

The Message Stream feature can be enabled or disabled from the Administration UI.

Since 8.4 It's disabled by default and needs to be enabled to activate the feature. This was chosen in order to not clutter the UI by default, considering that not all users would need this feature. In the future, it should be moved as an optional extension to install.

To enable or disable it, click on "Administer Wiki" from the drawer menu:

AdministerWikiMenu.png

In the global administration page, click on "Message Stream" in the vertical menu to the left.

MessageStreamGlobalAdmin.png

In the "Message Stream" administration page select "Yes" or "No" from the drop-down list, then click on "Save".

DisableMessageStream.png

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-messagestream-ui 10.4):

  • org.xwiki.platform:xwiki-platform-messagestream-api 10.4
Tags:
    

Get Connected