From version 566.1
edited by Administrator
on 2020/09/11 00:00
To version 567.1
edited by Silvia Macovei
on 2020/09/11 14:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Admin
1 +XWiki.SilviaMacovei
ExtensionCode.ExtensionClass[0]
Description
... ... @@ -1,66 +1,23 @@
1 -{{extensionToc/}}
1 +This application allows admin users to create programmed flash messages aimed towards one or multiple groups.
2 2  
3 -This application allows admin users to create programmed flash messages aiming towards one or multiple groups. When a new flash message is created, it pops up on the screen for all the users from the selected groups, the first time they visit the wiki. After dismissing it, the message is still available just below the header of the page.
3 +When a new flash message is created, it pops up on the screen for all the users from the selected groups, the first time they visit the wiki. After dismissing it, the message will be available below the page header.
4 4  
5 -== Home page ==
5 +The app can be accessed from the following two locations:
6 6  
7 -In order to access the home page of the application, the users have to look for **Flash Messages** entry in one of the following 2 places:
7 +* the **Applications** panel located on the left side of the page
8 +* the **Other** section from the global administration of the wiki
8 8  
9 -* the **Applications** panel located by default in the left panels section of the page
10 -* the **Other** section from the global administration of the wiki (this option exists because the application is intended for admin users and it would make sense to have an entry point in the Administration, besides the best practice of listing the application in the Applications panel)
10 +{{image reference="applicationsPanel.png"/}}
11 11  
12 -{{gallery}}
13 - image:applicationsPanel.png
14 - image:otherAdminSection.png
15 -{{/gallery}}
12 +{{image reference="otherAdminSection.png"/}}
16 16  
17 -
18 -Flash messages index view in the **FlashMessages.WebHome** page:
19 -
20 20  {{image reference="viewFlashIndex.png"/}}
21 21  
22 -Flash messages index view in **Global Administration > Other > Flash Messages** section:
16 +//Flash messages index view in the app home//
23 23  
24 24  {{image reference="viewAdminFlashIndex.png"/}}
25 25  
20 +//Flash messages index view from the **Global Administration > Other > Flash Messages** section//
26 26  
27 -== Create flash message ==
28 28  
29 -In order to create a new message, click **Create** button from the top of the page and the next step will display a list of available templates where you can find the one corresponding to flash messages.
30 -
31 -{{image reference="createFlash.png"/}}
32 -
33 -== Message structure ==
34 -
35 -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.
36 -Optionally, you can provide an end date and set up the event as a recurring one.
37 -
38 -{{image reference="viewFlash.png"/}}
39 -
40 -== Recurrency ==
41 -
42 -In order to make an event recurrent, set the repeat property to "Yes".
43 -After this step, a new settings layer will appear in order to configure the repeat period.
44 -Choose your desired settings such as repeat interval, repeat frequency and the days of the week and you're set.
45 -Be sure to keep an eye on the "Repeat summary" to have a human friendly overview of your settings.
46 -
47 -{{image reference="editFlash.png"/}}
48 -
49 -== Display ==
50 -
51 -=== Popup alert ===
52 -
53 -The messages are displayed to a concerned user in form of a popup when the first page is loaded after the start time.
54 -
55 -{{image reference="popupFlash.png"/}}
56 -
57 -=== Header notification ===
58 -
59 -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. Note that each message is shown for 10s after the slider goes to the next one.
60 -
61 -{{image reference="headerFlash.png"/}}
62 -
63 -Each of the three last messages is marked by a bullet in the right side of the flash bar located just under the header.
64 -These bullets are used not only to display the position of the current message but to navigate through them as well.
65 -
66 -{{image reference="toggleFlashes.png"/}}
23 +
Store.Code.PayingAppsClass[0]
Documentation
... ... @@ -1,1 +1,44 @@
1 -
1 += Topics =
2 +
3 +{{toc start="2"/}}
4 +
5 +== Create flash message ==
6 +
7 +In order to create a new message, click **Create** button from the top of the page and the next step will display a list of available templates where you can find the one corresponding to flash messages.
8 +
9 +{{image reference="createFlash.png"/}}
10 +
11 +== Message structure ==
12 +
13 +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.
14 +Optionally, you can provide an end date and set up the event as a recurring one.
15 +
16 +{{image reference="viewFlash.png"/}}
17 +
18 +== Recurrency ==
19 +
20 +In order to make an event recurrent, set the repeat property to "Yes".
21 +After this step, a new settings layer will appear in order to configure the repeat period.
22 +Choose your desired settings such as repeat interval, repeat frequency and the days of the week and you're set.
23 +Be sure to keep an eye on the "Repeat summary" to have a human friendly overview of your settings.
24 +
25 +{{image reference="editFlash.png"/}}
26 +
27 +== Display ==
28 +
29 +=== Popup alert ===
30 +
31 +The messages are displayed to a concerned user in form of a popup when the first page is loaded after the start time.
32 +
33 +{{image reference="popupFlash.png"/}}
34 +
35 +=== Header notification ===
36 +
37 +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. Note that each message is shown for 10s after the slider goes to the next one.
38 +
39 +{{image reference="headerFlash.png"/}}
40 +
41 +Each of the three last messages is marked by a bullet in the right side of the flash bar located just under the header.
42 +These bullets are used not only to display the position of the current message but to navigate through them as well.
43 +
44 +{{image reference="toggleFlashes.png"/}}
XWiki SAS Copyright © 2019