cogAllow you to create Flash messages aiming at one or multiple local groups
TypeXAR
Developed by

Victor Rachieru, Guillaume Delhumeau, Sidali Djebloun

Active Installs82
Rating
Rate!
11 Votes
LicenseGNU Lesser General Public License 2.1
Installable with the Extension Manager

Description

You can also try the Pro version: Flash Messages Application (Pro).

This extension allows you to create programmed Flash messages aiming towards one or multiple groups.

Since version 1.1 support for global users/groups has been introduced.

Administration

WebHome

The messages are created from within the WebHome of the app through the admin menu located above the livetable.

flash-messages-1.png

Message structure

Each entry requires a start date from which the message will start being displayed, a list of groups to show it to and the actual message.
Optionally, you can provide an end date and set up the event as a recurring one.

flash-messages-2.png

Recurrency

In order to make an event recurrent, set the repeat property to "Yes".
After this step, a new settings layer will appear in order to configure the repeat period.
Choose your desired settings such as repeat interval, repeat frequency and the days of the week and you're set.

Be sure to keep an eye on the "Repeat summary" to have a human friendly overview of your settings.

flash-messages-4.png

Display

The messages are displayed to a concerned user in form of a popup when he loads a page in view mode.
After the user has viewed the message it is marked as seen and is only displayed in the top slider which contains the three most recent messages.

Each of the three last messages is marked by a bullet in the right side of the flash bar located just under the header.
These bullets are used not only to display the position of the current message but to navigate through them as well.

Note that each message is shown for 10s after the slider goes to the next one.

flash-messages-3.png

Tested on

This extension has been tested with the following configurations.

Extension VersionXWiki FlavorNotes
1.0XWiki Enterprise 6.2-M1

The app info description is overlapping with "Actions" options.

1.1XWiki Enterprise 6.4

Depends on Closed XWIKI-11732 which can be easily fixed by editing macros.vm.
The issue does not exist in earlier versions of XE.

1.1.3XWiki Enterprise 6.4.1, 6.4.4, 7.1.2
1.1.4XWiki Enterprise 9.1.2
1.1.4XWiki 9.8.1

Known issues: http://jira.xwiki.org/browse/XAFLASHM-38 , http://jira.xwiki.org/browse/XAFLASHM-32 , https://jira.xwiki.org/browse/XAFLASHM-40 , https://jira.xwiki.org/browse/XAFLASHM-41

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

For versions lower than 1.1

5. Go in the filesystem and download "\webapps\xwiki\templates\global.vm"
6. Add the following code to the downloaded file:

  ....
 </div> ## companylogo
 </div> ## company
  ##=============================================
  ## Flash info extention
  ##=============================================
  #if($xcontext.action=='view')
    $xwiki.ssx.use('Flash.DisplayFlashMessages')
   <div id="flashMessages">
    #includeTopic('Flash.DisplayFlashMessages')
   </div>
  #end
  ##=============================================
  ## End Flash info extention
  ##=============================================
 <div id="globallinks">
  ....

7. Attach global.vm to the skin page

Release Notes

v1.1.4

  • Closed XAFLASHM-31 Remove the navigation bullet when there is just 1 message to be displayed

v1.1.3

v1.1.2

v1.1.1

  • Closed XAFLASHM-22 Messages are not displayed on the main wiki
  • Closed XAFLASHM-21 Capitalize application title for the English translation
  • Closed XAFLASHM-20 Flash App displays lots of WARNings in the console
  • Closed XAFLASHM-19 The top slider and the pop up are not shown on IE10
  • Closed XAFLASHM-17 Make Flash space visible only for Admins
  • Closed XAFLASHM-16 Error when a user doesn't have view rights on a subwiki
  • Closed XAFLASHM-13 'Groupes' selector has the image not cented
  • Closed XAFLASHM-12 Remove #docextra for Flash.WebHome
  • Closed XAFLASHM-11 Bad display for 'Groups' for Unregistered users

v1.1

  • Closed XAFLASHM-10 The messages can't be marked as seen for global users
  • Closed XAFLASHM-9 Allow selection of both local and global groups
  • Closed XAFLASHM-8 For the AppBar use a different icon
  • Closed XAFLASHM-7 Use an extension point instead of a modified template
  • Closed XAFLASHM-6 Improve the display for Flamingo Skin
  • Closed XAFLASHM-5 Have the same naming for 'Start date' property
  • Closed XAFLASHM-3 Create the French translation file
  • Closed XAFLASHM-2 Set the parent for all documents
  • Closed XAFLASHM-1 Rename some translations

Dependencies

Dependencies for this extension (org.xwiki.contrib:application-flashmessages-ui 1.1.4):

Tags:
Created by Djebloun Sidali on 2014/05/07 00:33
    

Get Connected