diff --git a/docs/user-guide/adding-widgets.md b/docs/user-guide/adding-widgets.md index 87c7711754..0eb326695c 100644 --- a/docs/user-guide/adding-widgets.md +++ b/docs/user-guide/adding-widgets.md @@ -2,7 +2,7 @@ **************** -With a click on the button in [Sidebar](exploring-dashboards.md#sidebar) the *Widget* panel opens, showing the list of the available widget types that can be added to the dashboard: +With a click on the button in [Side Toolbar](exploring-dashboards.md#side-toolbar) the *Widget* panel opens, showing the list of the available widget types that can be added to the dashboard: diff --git a/docs/user-guide/connecting-widgets.md b/docs/user-guide/connecting-widgets.md index d4b8893cae..e4af6d359a 100644 --- a/docs/user-guide/connecting-widgets.md +++ b/docs/user-guide/connecting-widgets.md @@ -5,7 +5,7 @@ In dashboards it is possible to connect the added widgets allowing the user to i -Once at least one connection between widgets is set, it is possible to identify the connected widgets turning on the connections button in the dashboard [Sidebar](exploring-dashboards.md#sidebar) making it green . This will highlight the connected elements with a colored bar on their upper side. +Once at least one connection between widgets is set, it is possible to identify the connected widgets turning on the connections button in the dashboard [Side Toolbar](exploring-dashboards.md#side-toolbar) making it green . This will highlight the connected elements with a colored bar on their upper side. @@ -37,7 +37,7 @@ As soon as more than one Map widget is added to the dashboard, the connect/disco With a click on it, if only another Map widget is present, by default the connection will be made towards that Map widgets. When more than one Map widget is present in the dashboard, instead, it is possible choose one through a page like the following: - + ### Maps with Charts, Tables and Counters @@ -45,15 +45,15 @@ In order to connect Charts, Tables or Counters widget with Maps widget, the proc * Connecting Charts with Maps: - + * Connecting Tables with Maps: - + * Connecting Counters with Maps: - + When a pan or zoom operation is performed in the Map widget, the other connected widgets are spatially filtered according to the Map viewport. diff --git a/docs/user-guide/exploring-dashboards.md b/docs/user-guide/exploring-dashboards.md index c8c01e0e7d..e43f65acac 100644 --- a/docs/user-guide/exploring-dashboards.md +++ b/docs/user-guide/exploring-dashboards.md @@ -12,9 +12,9 @@ In order to create a new dashboard, the **New Dashboard** button -## Topbar +## Top Toolbar -Through the *Topbar* it is possible to: +Through the *Top Toolbar* it is possible to: * Access [GeoSolutions website](https://www.geosolutionsgroup.com/) with a click on the icon @@ -22,39 +22,39 @@ Through the *Topbar* it is possible to: -* Go back to the [Homepage](https://mapstore.geosolutionsgroup.com/mapstore/#/) with the button +* Go back to the [Homepage](https://mapstore.geosolutionsgroup.com/mapstore/#/) by clicking the button -* Take a look at the account info, change password and logout, with the button (more info about these options are available in [Managing Users and Groups](managing-users-and-groups.md#managing-users-and-groups) section) +* **Login/Logout** by clicking the button (for more information see the [Managing Users and Groups](managing-users-and-groups.md) section) -### Options Menu +### Side Toolbar -In the **Options** drop-down menu you can: +From the **Side Toolbar** the user can: -* **Export** dashboard in `json` format +* [Add new widgets](adding-widgets.md#adding-widgets) with the button -* **Import** dashboard in `json` format (it will replace without asking the current dashboard) +* See the connections between widgets with the button, available when connections are present (more information about this option are available in [Connecting Widgets](connecting-widgets.md#connecting-widgets) section) -* [Save/Save as](resources-properties.md) the dashboard +* See the **About this dashboard** panel by clicking the button, when [Details](resources-properties.md#details) are present -* **Delete** the dashboard +* **Export** dashboard in `json` format by clicking the button -* Open the [Share](share.md#link) panel +* **Import** `json` dashboard files from your computer by clicking the button (it will replace the current dashboard directly) -* Start the **Tutorial** +* **Save** the dashboard by clicking the button, in order to apply the changes made in an existing dashboard. Selecting this option, the [Resources Properties](resources-properties.md) window opens, already filled with the current dashboard properties -* See the information about the deployed **Version** of [MapStore](https://mapstore.geosolutionsgroup.com/mapstore/#/) in the **About** panel. +* **Save as** when the user needs to save a copy of a dashboard or save one for the first time by clicking the button. Selecting this option an empty [Resources Properties](resources-properties.md) window opens. - +* **Delete dashboard** in order to delete the current dashboard by clicking the button -## Sidebar +* [Share](share.md) the dashboard by clicking the button -The *Sidebar* allows the user to: +* Start the **Tutorial** by clicking the button -* [Add new widgets](adding-widgets.md#adding-widgets) with the button +* Know more information **About** [MapStore](https://mapstore.geosolutionsgroup.com/mapstore/#/) and the deployed **Version** of *MapStore* by clicking the button -* See the connections between widgets with the button, available when connections are present (more information about this option are available in [Connecting Widgets](connecting-widgets.md#connecting-widgets) section) + ## Viewer diff --git a/docs/user-guide/img/adding-widgets/legend-ex.jpg b/docs/user-guide/img/adding-widgets/legend-ex.jpg index 8478c85c21..3fab5d8173 100644 Binary files a/docs/user-guide/img/adding-widgets/legend-ex.jpg and b/docs/user-guide/img/adding-widgets/legend-ex.jpg differ diff --git a/docs/user-guide/img/adding-widgets/legend-preview.jpg b/docs/user-guide/img/adding-widgets/legend-preview.jpg index 8a8dc74d62..b7c7b386d0 100644 Binary files a/docs/user-guide/img/adding-widgets/legend-preview.jpg and b/docs/user-guide/img/adding-widgets/legend-preview.jpg differ diff --git a/docs/user-guide/img/adding-widgets/select-map-connection.jpg b/docs/user-guide/img/adding-widgets/select-map-connection.jpg index 57874521b0..0b3971c860 100644 Binary files a/docs/user-guide/img/adding-widgets/select-map-connection.jpg and b/docs/user-guide/img/adding-widgets/select-map-connection.jpg differ diff --git a/docs/user-guide/img/adding-widgets/viewer-map.jpg b/docs/user-guide/img/adding-widgets/viewer-map.jpg index 3a0b445846..78afe7f159 100644 Binary files a/docs/user-guide/img/adding-widgets/viewer-map.jpg and b/docs/user-guide/img/adding-widgets/viewer-map.jpg differ diff --git a/docs/user-guide/img/button/geosolutions-link.jpg b/docs/user-guide/img/button/geosolutions-link.jpg index 92157126c0..cd33156b4a 100644 Binary files a/docs/user-guide/img/button/geosolutions-link.jpg and b/docs/user-guide/img/button/geosolutions-link.jpg differ diff --git a/docs/user-guide/img/button/show-connections.jpg b/docs/user-guide/img/button/show-connections.jpg index 3cb8bd613f..2f69e91174 100644 Binary files a/docs/user-guide/img/button/show-connections.jpg and b/docs/user-guide/img/button/show-connections.jpg differ diff --git a/docs/user-guide/img/connecting-widgets/chart-map.mp4 b/docs/user-guide/img/connecting-widgets/chart-map.mp4 new file mode 100644 index 0000000000..65e6436327 Binary files /dev/null and b/docs/user-guide/img/connecting-widgets/chart-map.mp4 differ diff --git a/docs/user-guide/img/connecting-widgets/connection-options.jpg b/docs/user-guide/img/connecting-widgets/connection-options.jpg index db798907cc..7eb6670eff 100644 Binary files a/docs/user-guide/img/connecting-widgets/connection-options.jpg and b/docs/user-guide/img/connecting-widgets/connection-options.jpg differ diff --git a/docs/user-guide/img/connecting-widgets/connections_widgets.mp4 b/docs/user-guide/img/connecting-widgets/connections_widgets.mp4 index d4fc42d00f..7d50e01f31 100644 Binary files a/docs/user-guide/img/connecting-widgets/connections_widgets.mp4 and b/docs/user-guide/img/connecting-widgets/connections_widgets.mp4 differ diff --git a/docs/user-guide/img/connecting-widgets/counter-map.mp4 b/docs/user-guide/img/connecting-widgets/counter-map.mp4 new file mode 100644 index 0000000000..d36b513516 Binary files /dev/null and b/docs/user-guide/img/connecting-widgets/counter-map.mp4 differ diff --git a/docs/user-guide/img/connecting-widgets/desktop.ini b/docs/user-guide/img/connecting-widgets/desktop.ini new file mode 100644 index 0000000000..b60a24beef --- /dev/null +++ b/docs/user-guide/img/connecting-widgets/desktop.ini @@ -0,0 +1,2 @@ +[LocalizedFileNames] +legend-map.jpg=@legend-map.jpg,0 diff --git a/docs/user-guide/img/connecting-widgets/interaction_ab.mp4 b/docs/user-guide/img/connecting-widgets/interaction_ab.mp4 index 1fabe94d19..6b0de1bd3a 100644 Binary files a/docs/user-guide/img/connecting-widgets/interaction_ab.mp4 and b/docs/user-guide/img/connecting-widgets/interaction_ab.mp4 differ diff --git a/docs/user-guide/img/connecting-widgets/legend-map.jpg b/docs/user-guide/img/connecting-widgets/legend-map.jpg index 03f9a5350c..f123af6e01 100644 Binary files a/docs/user-guide/img/connecting-widgets/legend-map.jpg and b/docs/user-guide/img/connecting-widgets/legend-map.jpg differ diff --git a/docs/user-guide/img/connecting-widgets/map-to-connect.mp4 b/docs/user-guide/img/connecting-widgets/map-to-connect.mp4 new file mode 100644 index 0000000000..f238f95ba9 Binary files /dev/null and b/docs/user-guide/img/connecting-widgets/map-to-connect.mp4 differ diff --git a/docs/user-guide/img/connecting-widgets/table-map.mp4 b/docs/user-guide/img/connecting-widgets/table-map.mp4 new file mode 100644 index 0000000000..a6122ef681 Binary files /dev/null and b/docs/user-guide/img/connecting-widgets/table-map.mp4 differ diff --git a/docs/user-guide/img/connecting-widgets/widgets_interaction.mp4 b/docs/user-guide/img/connecting-widgets/widgets_interaction.mp4 index 7282539521..a854f098aa 100644 Binary files a/docs/user-guide/img/connecting-widgets/widgets_interaction.mp4 and b/docs/user-guide/img/connecting-widgets/widgets_interaction.mp4 differ diff --git a/docs/user-guide/img/exploring-dashboards/dashboard-1.jpg b/docs/user-guide/img/exploring-dashboards/dashboard-1.jpg index e520236dc5..56adb31b01 100644 Binary files a/docs/user-guide/img/exploring-dashboards/dashboard-1.jpg and b/docs/user-guide/img/exploring-dashboards/dashboard-1.jpg differ diff --git a/docs/user-guide/img/exploring-dashboards/move-resize.mp4 b/docs/user-guide/img/exploring-dashboards/move-resize.mp4 index 6ac54b8720..ccea4100fc 100644 Binary files a/docs/user-guide/img/exploring-dashboards/move-resize.mp4 and b/docs/user-guide/img/exploring-dashboards/move-resize.mp4 differ diff --git a/docs/user-guide/img/exploring-dashboards/options-menu.jpg b/docs/user-guide/img/exploring-dashboards/options-menu.jpg index ffe65c968e..7b493b4519 100644 Binary files a/docs/user-guide/img/exploring-dashboards/options-menu.jpg and b/docs/user-guide/img/exploring-dashboards/options-menu.jpg differ diff --git a/docs/user-guide/resources-properties.md b/docs/user-guide/resources-properties.md index b64599547a..528681dc43 100644 --- a/docs/user-guide/resources-properties.md +++ b/docs/user-guide/resources-properties.md @@ -8,29 +8,23 @@ In order to customize the properties of a resource, the Admin or a normal user w Through the *Edit properties* window the user can perform the following operations: -* Add an image as a **Thumbnail** dropping it or clicking inside the *Thumbnail* box. +* Add a *Thumbnail* -!!! warning - The image to be added must not be larger than 500 kb and its best dimensions are 300x180 px. The supported formats are `jpg` (or `jpeg`) and `png`. +* Add a *Name* and a *Description* -* Add a **Name** and a **Description** +* Add a *Permission* rule -!!! note +!!! warning The name of a resource is the only mandatory field. Note that is not allowed to choose a name that has already been assigned to another resource. -* Enable the **Unadvertised** option to make the owner of the resource or the MapStore admin the only ones who can see and search that resource in the [Home Page](home-page.md) or in the [Map Catalog](map-catalog.md) tool. - -* Add a [**Permission** rule](resources-properties.md#permission-rules) +## Thumbnail -* Add **Details** (only for *Maps* and *Dashboard*) +It is possible to add an image as thumbnail dropping it or clicking inside the following box: -Once a resource is saved, the *Edit properties* panel shows the creation and the last modification dates. An example in the image below: + - - -Admin users can also see who created and modified the resource. An example in the image below: - - +!!! warning + The image to be added must not be larger than 500 kb and its best dimensions are 300x180 px. The supported formats are `jpg` (or `jpeg`) and `png`. ## Permission rules @@ -51,16 +45,16 @@ How to manage users and groups is a topic present in the [Managing Users](managi ## Details -Only for resources of type *map* and *dashboard*, it is possible to add details as additional information in form of descriptive content for the resource itself. This is useful to associate some information to the resource and provide an overview of its content. In this case the *Edit properties* window is the following: +For *Map* and *Dashboard* resources, it is possible to add details. This is useful to associate some information to the map/dashboard or an overview description of its content. In this case the *Edit properties* window is the following: -With a click on the **Add new details** button a panel opens and the user can write the details of the resource. +With a click on the **Add new details** button it opens a panel where the user can write the details. The text can be edited and some links and images can be added through the [Text Editor Toolbar](text-editor-toolbar.md#text-editor-toolbar). -Once the editing is done, the map details can be saved with the **Save** button and other buttons appear on the *Edit properties* panel. +Once the editing is done, the details can be saved with the **Save** button and other buttons appear on the *Edit properties* panel. @@ -75,16 +69,16 @@ Here, the user is allowed to: !!! note - If the **Show as modal** button is not activated once the user opens the *About this map* button, the details are displayed on a panel. + If the **Show as modal** button is not activated once the user opens the *About this map/dashboard* button, the details are displayed on a panel. !!! warning - The *About this map* button is visible in the [Side Toolbar](mapstore-toolbars.md#side-toolbar) only when the details are present on the map. + The *About this map/dashboard* button is visible in the [Side Toolbar](mapstore-toolbars.md#side-toolbar) only when the details are present on the map/dashboard. -* Enable the **Show at startup** button. If active, when the user opens a resource with defined details, these are visualized in a descriptive panel. +* Enable the **Show at startup** button. If active, as soon as the user opens the map/dashboard, the details panel is visualized. * **Delete** the details sheet -Once the details are saved, the **Show details** button appears also on the map card in [Homepage](https://mapstore.geosolutionsgroup.com/mapstore/#/) +Once the details are saved, the **Show details** button appears also on the map/dashboard card in [Homepage](https://mapstore.geosolutionsgroup.com/mapstore/#/)