Dashboard Application

A dashboard allows you to customize pages by adding gadgets and columns. XWiki Standard comes with a visual editor available by clicking on the "Dashboard" link in the "Applications" panel on the left.

DashboardLeftPanel.png

Edit the Page Containing the Dashboard

In order for the edit menu to have the "Inline form" option, you will need to make sure you are an advanced user. In Inline mode, you will notice 2 extra buttons: "Add Gadget" and "Add Column". Also, when hovering a gadget, the possible actions, edit and delete, are displayed in the header.

DashboardInlineEdit.png

Gadgets

Insert a Gadget

To add a gadget, edit the home page of the "Dashboard" space in "Inline" mode and click the "Add Gadget" button. You will then see a window with all the available macros, each of them containing a short description about its usability. To improve the user experience, the Gadget Wizard has been updated to use the new Macro Wizard from the CKEditor.

Search for the macro you wish to insert from one of the predefined categories (for instance the "Info Message" macro in the "Formatting" category), then click on "Select".

AddGadget.png

Fill in the mandatory sections and click on "Submit.

InsertInfoMacro.png

The gadget will be added at the end of the last column,

InsertInfoMacroFinal.png

but you can drag it and move it around to different columns of the dashboard.

DragAndDropGadget.png

Edit the Parameters of a Gadget

To edit the parameters of a gadget, edit the home page of the "Dashboard" space in Inline mode, hover the title bar of the gadget and click on the yellow pen icon in the top right corner.

EditGadget.png

You will then see a wizard similar to the one used for adding the gadget. The new parameters will be automatically saved when clicking on the "Submit" button and the gadget will be placed again at the end of the last column.

Advanced users can also use the Objects mode for editing the parameters of a gadget. The advantage is that in Objects mode you can place any content inside the gadget, like for instance XWiki syntax or Velocity code.

EditGadgetObjectsMode.png

Delete a Gadget

To delete a gadget, you have two options:

  • Edit the dashboard page in Inline mode, hover the title bar of the gadget and click on the red "X" icon in the top right corner.
  • Edit the dashboard page in Objects mode and click on the corresponding "X" icon. 

Columns

Add a Column

To add a column, edit the home page of the "Dashboard" space in Inline mode and click on the "Add Column" button in the top right corner.

AddColumn.png

Inside the newly added column, you may perform the same actions described above: insert a gadget, edit its parameters and delete it.

SecondColumnAddGadget.png

Create a Dashboard

You may create a dashboard in any page:

If you want to know more about the Dashboard macro parameters, go to the dedicated page which is listed in the "Related Pages" section.

DashboardFinal.png

A Dashboard only displays a gadget provided its content is not empty when rendered which allows Gadgets to control whether they should be displayed or not.

User Dashboards

XWiki Standard brings support for personal dashboards, allowing each user to define his own dashboard in the profile page and to use it either in the profile page or instead of the dashboard displayed by default the wiki home page.

Access Your Personal Dashboard

In order to define your own dashboard, click your user avatar in the top menu bar, 

ProfileMenuMyDashboardOption.png

then, in your user profile page, click on the tab "My dashboard" under "Settings".

ProfilePageMyDashboardTab.png

The dashboard can be customized by adding gadgets and columns. To do so, click on the yellow pen in the top right corner of the section "Dashboard preferences". This will make the tab "My dashboard" available for editing in "Inline" mode and you will notice 2 green buttons: "Add Gadget" and "Add Column".

EditPersonalDashboard.png

Gadgets

Add a Gadget

To add a gadget, go to 'My Dashboard' section of your user profile, edit it in Inline mode and click on the "Add Gadget" button. You will then see a window with all the available macros each of them containing a short description about its usability.

AddGadget.png

Search for the macro you wish to insert, then click on "Select". We will choose the "Watchlist" macro that loads the list of favorites for the current user. 

InsertWatchlistMacro.png

After clicking on "Submit", the "Watchlist" gadget will be added at the end of the last column, but you can drag it and move it around to different columns of the dashboard. Also, when hovering the gadget, the possible actions, edit and delete, are displayed in the header.

DragAndDropWatchlistGadget.png

Edit a Gadget

To edit the parameters of a gadget, go to 'My Dashboard' section of your user profile, edit it in Inline mode, hover the title bar of the gadget and click on the yellow pen icon in the top right corner.

EditWatchlistGadget.png

You will then see a wizard similar to the one used for adding the gadget. The new parameters will be automatically saved when clicking on the "Insert gadget" button and the gadget will be placed again at the end of the last column.

Advanced users can edit their profile page in "Objects" mode in order to customize the parameters of a gadget, the advantage being that any content can be placed inside the gadget, like pieces of code or XWiki syntax. 

EditWatchlistGadgetObjectsMode.png

Remove a Gadget

To delete a gadget, there are two options:

  • Go to 'My Dashboard' section of your user profile, edit it in Inline mode, hover the title bar of the gadget and click on the red "X" icon in the top right corner.
  • Edit your user profile page in "Objects" mode and click on the corresponding red "X" icon. 

Columns

Insert a Column

To add a column, go to 'My Dashboard' section of your user profile, edit it in Inline mode and click on the "Add Column" button in the top right corner.

AddColumnUserDashboard.png

Inside the newly added column, you can perform the same actions described above: insert a gadget, edit its parameters and delete it.

SecondColumnAddGadgetUser.png

When you are done adding gadgets and columns, click on "Save & View" to see your personal dashboard displayed on the profile page.

Display a Personal Dashboard Instead of the Default One

To display your personal dashboard instead of the default one, go to your user profile and click on the "My dashboard" tab. In the "Dashboard preferences" section click the yellow pen in the top right corner. You will then see a drop-down list just below the text "Replace the Default Dashboard with My Custom Dashboard". 

DisplayDashboardOnHomepage.png

To complete, choose "Yes", then save the page. If you navigate to the wiki dashboard page, you should see the one configured on your user profile.

UserDashboardFinal.png

To reverse this operation, click on your avatar in the upper right corner of the screen, then on "My dashboard" in your profile page. Next, locate the "Dashboard preferences" text area and click on the yellow pen in the top right corner, in order to open the tab "My dashboard" in Inline mode. Finally, choose "No" in the drop-down list just below the text "Replace the Default Dashboard with My Custom Dashboard" and save the page to complete the changes. 

          

Related Pages

Search this space

 

Most popular tags

Failed to execute the [groovy] macro
  1. access rights
  2. activity stream
  3. annotation
  4. attachment
  5. comment
  6. Document Tree Macro
  7. export
  8. Extension Manager
  9. Flamingo skin
  10. global user
  11. Groovy event listener
  12. group
  13. nested page
  14. search
  15. skin
  16. syntax
  17. user
  18. user profile
  19. velocity macros
  20. wiki
  21. wysiwyg
  22. XWiki Applications
  23. xwikiattachment_archive table
  24. xwikiattachment table
  25. xwikiattrecyclebin table
  26. xwikiproperties table

[Display all tags from this space]