Changes for page Dashboard Macro

Last modified by Admin on 2024/03/25 15:33

<
From version < 118.5 >
edited by Alex Cotiugă
on 2016/04/26 09:04
To version < 119.1 >
edited by Vincent Massol
on 2016/10/28 10:37
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -xwiki:XWiki.acotiuga
1 +xwiki:XWiki.VincentMassol
ExtensionCode.ExtensionClass[0]
Description
... ... @@ -5,6 +5,7 @@
5 5  {{/info}}
6 6  
7 7  = Creating a dashboard =
8 +
8 8  In order to create a dashboard in a page, you just need to add the ##~{~{dashboard}}## macro to that page (you can use the macro menu from the WYSIWYG editor in order to do this). Configure the parameters of the dashboard to adjust its style and data source.
9 9  
10 10  == Parameter definition ==
... ... @@ -26,7 +26,6 @@
26 26  
27 27  {{image reference=dashboardInlineMode.png/}}
28 28  
29 -
30 30  == Adding gadgets ==
31 31  
32 32  To add a gadget, you need to click the "Add Gadget" button in the top right corner of the dashboard, and follow the wizard. The gadget will be added at the end of the last column, from where you can move it afterwards to the desired position.
... ... @@ -35,7 +35,8 @@
35 35  
36 36  Adding a gadget on the dashboard is automatically saved, in the current implementation.
37 37  
38 -=== Gadget's titile ===
38 +=== Gadget's title ===
39 +
39 39  {{info}}Since 8.1-milestone-2.{{/info}}
40 40  The default gadget's title is the gadget's id, which is used as translation key in order to have internationalized titles.
41 41  {{info}}Before, if the user didn't choose a name, the id was displayed in the dashboard.{{/info}}
... ... @@ -66,8 +66,24 @@
66 66  
67 67  In the same gadget settings menu, there is an option to remove the gadget. Note that, while there is a confirmation dialog before the actual delete, the action is automatically saved therefore not reversible by canceling the edit form.
68 68  
69 -= Advanced gadgets editing =
70 += Advanced Topics =
70 70  
72 +== Advanced gadgets editing ==
73 +
71 71  Since gadgets are saved as objects in the page, you can always use the objects editor for advanced actions. Note that, though the visual editor only provides the option to choose from a list of predefined gadgets (the macros in the wiki, actually), a gadget can contain any wiki syntax, so, in the objects editor, you can put any content in your gadgets.
72 72  
73 73  {{image reference=dashboardEditObjectMode.png/}}
77 +
78 +== Control Gadget Display ==
79 +
80 +{{info}}XWiki 8.4R{{/info}} A Dashboard now only displays a Gadget if that gadget's content is not empty when rendered. This allows Gadgets to control whether they should be displayed or not. For example, if you wish to display a Gadget only if the user has some permissions such as Admin rights, you can do that with an ##if## in the Gadget's content.
81 +
82 +For example the Activity Stream Gadget is only displayed if the Activity Stream feature is enabled:
83 +
84 +{{code}}
85 +{{velocity}}
86 +#if ($services.messageStream.isActive())
87 + ...
88 +#end
89 +{{/velocity}}
90 +{{/code}}
Show installed count
... ... @@ -1,0 +1,1 @@
1 +Yes

Get Connected