Flash Messages Application
Allows you to create Flash messages aiming at one or multiple local groups |
Type | XAR |
Category | |
Developed by | Victor Rachieru, Guillaume Delhumeau, Sidali Djebloun |
Active Installs | 19 |
Rating | |
License | GNU Lesser General Public License 2.1 |
Table of contents
Description
This extension allows you to create programmed Flash messages aiming towards one or multiple groups.
Administration
WebHome
The messages are created from within the WebHome of the app through the admin menu located above the livetable.
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.
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.
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.
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
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.8
The following translations have been updated with this release:
v1.1.7
The following translations have been updated with this release:
v1.1.6
The following translations have been updated with this release:
v1.1.5
v1.1.4
v1.1.3
v1.1.2
v1.1.1
v1.1
Dependencies
Dependencies for this extension (org.xwiki.contrib:application-flashmessages-ui 1.1.8):
- org.xwiki.platform:xwiki-platform-appwithinminutes-ui 8.4
- org.xwiki.platform:xwiki-platform-rendering-macro-velocity 8.4
- org.xwiki.platform:xwiki-platform-rendering-macro-code 8.4
- org.xwiki.platform:xwiki-platform-rendering-macro-include 8.4
- org.xwiki.rendering:xwiki-rendering-macro-html 8.4
- org.xwiki.platform:xwiki-platform-rendering-macro-script 8.4