Skip to content

Commit

Permalink
[Backport 2024.01.xx] - Fix User Guide for 2024.01.00 (#10307)
Browse files Browse the repository at this point in the history
* fix_guide

* fix_list_order

* add_review
  • Loading branch information
ElenaGallo committed May 13, 2024
1 parent ae76e4d commit e52c895
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 19 deletions.
14 changes: 11 additions & 3 deletions docs/user-guide/filtering-layers.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,18 +82,22 @@ If the user wants to filter by an attribute, he can simply write the desired fil

<img src="../img/filtering-layers/attribute-table-quick-filter-1.jpg" class="ms-docimage"/>

The user can also filter an attribute using the operation input box. From the dropdown menu it is possible to choose the operation to perform (for the *String* attribute can be `=`, `like`, `ilike` or `isNull`, for the *Integer*, *Data* or *Time* attribute, can be `=`, `>`, `<`, `>=`, `<=`, `<>` or `isNull`)
The user can also filter an attribute using the input box. From the dropdown menu it is possible to choose the operator to use (for the *String* attribute it can be `=`, `like`, `ilike` or `isNull`, for the *Integer*, *Data* or *Time* attribute, it can be insted `=`, `>`, `<`, `>=`, `<=`, `<>`, `><` or `isNull`)

<img src="../img/filtering-layers/operations_drop_down_menu.jpg" class="ms-docimage"/>

In order to filter a numerical filed matching the records *greater than* or *equal* to a certain threshold value, an example can be:

<img src="../img/filtering-layers/attribute-table-quick-filter-3.jpg" class="ms-docimage"/>

The user can also filter the records, of the *Date*, *Time* and *DateTime* attributes, through the *Date Picker* option by clicking on the <img src="../img/button/date_picker.jpg" class="ms-docbutton"/> button for *Date* attributes, the <img src="../img/button/time_picker.jpg" class="ms-docbutton"/> button for *Time* attributes and the <img src="../img/button/date_time_picker.jpg" class="ms-docbutton"/> button for *DateTime* attributes. To filter a *DateTime* attribute using the *Date Picker* option, an example can be the following:
The user can also filter the records, of the *Date*, *Time* and *DateTime* attributes, through the *Date Picker* option by clicking on the <img src="../img/button/date_picker.jpg" class="ms-docbutton"/> button for *Date* attributes, the <img src="../img/button/time_picker.jpg" class="ms-docbutton"/> button for *Time* attributes and the <img src="../img/button/date_time_picker.jpg" class="ms-docbutton"/> button for *DateTime* attributes. To filter a *DateTime* attribute using the **Date Picker** option, an example can be the following:

<video class="ms-docimage" style="max-width:700px;" controls><source src="../img/filtering-layers/data_time_picker_example.mp4"/></video>

In the *Date Picker* option, with the `><` operator selected, the **Time Range** picker is supported. Here the user can select the *Start Date* and the *End Date* to filter the attribute, an example can be the following:

<video class="ms-docimage" style="max-width:700px;" controls><source src="../img/filtering-layers/time_range_picker_example.mp4"/></video>

#### Quick Filter by map interaction

It is possible to filter records in the [Attribute Table](attributes-table.md#attribute-table) by clicking on the map or doing a selection directly in a map of multiple features. The user can activate the **Filter on the map** <img src="../img/button/filter_geometry_button.jpg" class="ms-docbutton"/> button (once clicked the button turns blue) and then:
Expand Down Expand Up @@ -151,7 +155,11 @@ A condition can be set by selecting a value for each of the three input boxes:

* In the second input box it is possible to choose the operation to perform (selecting a text field can be **=**, **like**, **ilike** or **isNull**, selecting a numerical field, can be **=**, **>**, **<**, **>=**, **<=**, **<>** or **><**)

* The third input box (in case of fields of type String) provides a paginated list of available field values already present in the layer's dataset (a GeoServer WPS process is used for this). In case of numeric fields the user can simply type a value to use for the filter.
* The third input box (in case of fields of type String) provides a paginated list of available field values already present in the layer's dataset (a GeoServer WPS process is used for this). In case of numeric fields, the user can simply type a value to use for the filter or use instead the **Date Picker** tool for the *Date*, *Time* and *DateTime* attributes as described above in the [Quick Filter by attributes](filtering-layers.md#quick-filter-by-attributes) section.

!!! Note
For the *Query Panel*, the *Date Picker* tool also allows the user to perform select **Quick Date Selections** such as: `Now`, `Yesterday` for single *Date* or *DateTime* and `Tomorrow` or also quick date ranges like `Now`, `This week`, `This month`, `7 days from now`, `30 days from now` and `90 days from now` for *Date* or *DateTime* intervals depending on the operator selected. An example can be the following:
<video class="ms-docimage" style="max-width:500px;" controls><source src="../img/filtering-layers/quick_date_ranges.mp4"/></video>

!!! Note
the "paginated list of available field values" above is available only if the server provides the WPS process `gs:PagedUnique`
Expand Down
Binary file not shown.
Binary file not shown.
39 changes: 23 additions & 16 deletions docs/user-guide/resources-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,29 @@ 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 a *Thumbnail*
* Add an image as a **Thumbnail** dropping it or clicking inside the *Thumbnail* box.

* Add a *Name* and a *Description*
!!! 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 *Permission* rule
* Add a **Name** and a **Description**

!!! warning
!!! note
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.

## Thumbnail
* 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.

It is possible to add an image as thumbnail dropping it or clicking inside the following box:
* Add a [**Permission** rule](resources-properties.md#permission-rules)

<img src="../img/resource-properties/thumb.jpg" class="ms-docimage"/>
* Add **Details** (only for *Maps* and *Dashboard*)

!!! 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`.
Once a resource is saved, the *Edit properties* panel shows the creation and the last modification dates. An example in the image below:

<img src="../img/resource-properties/resource_data.jpg" class="ms-docimage" style="max-width:400px;"/>

Admin users can also see who created and modified the resource. An example in the image below:

<img src="../img/resource-properties/resource_creation.jpg" class="ms-docimage" style="max-width:400px;"/>

## Permission rules

Expand All @@ -45,16 +51,16 @@ How to manage users and groups is a topic present in the [Managing Users](managi

## Details

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:
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:

<img src="../img/resource-properties/edit-map-properties-panel_details.jpg" class="ms-docimage" style="max-width:400px;"/>

With a click on the **Add new details** button <img src="../img/button/add_details_button.jpg" class="ms-docbutton"/> it opens a panel where the user can write the details.
With a click on the **Add new details** button <img src="../img/button/add_details_button.jpg" class="ms-docbutton"/> a panel opens and the user can write the details of the resource.

<img src="../img/resource-properties/details_panel.jpg" class="ms-docimage"/>

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 details can be saved with the **Save** button <img src="../img/button/save_large_button.jpg" class="ms-docbutton"/> and other buttons appear on the *Edit properties* panel.
Once the editing is done, the map details can be saved with the **Save** button <img src="../img/button/save_large_button.jpg" class="ms-docbutton"/> and other buttons appear on the *Edit properties* panel.

<img src="../img/resource-properties/details_sheet_buttons.jpg" class="ms-docimage"/>

Expand All @@ -69,18 +75,19 @@ Here, the user is allowed to:
<img src="../img/resource-properties/show-as-modal.jpg" class="ms-docimage"/>

!!! note
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. <img src="../img/resource-properties/show-as-panel.jpg" class="ms-docimage"/>
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. <img src="../img/resource-properties/show-as-panel.jpg" class="ms-docimage"/>

!!! warning
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.
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.

* Enable the **Show at startup** <img src="../img/button/show-at-starup-button.jpg" class="ms-docbutton"/> button. If active, as soon as the user opens the map/dashboard, the details panel is visualized.
* Enable the **Show at startup** <img src="../img/button/show-at-starup-button.jpg" class="ms-docbutton"/> button. If active, when the user opens a resource with defined details, these are visualized in a descriptive panel.

* **Delete** the details sheet <img src="../img/button/delete_white_button.jpg" class="ms-docbutton"/>

Once the details are saved, the **Show details** button <img src="../img/button/details_button.jpg" class="ms-docbutton"/> appears also on the map/dashboard card in [Homepage](https://mapstore.geosolutionsgroup.com/mapstore/#/)
Once the details are saved, the **Show details** button <img src="../img/button/details_button.jpg" class="ms-docbutton"/> appears also on the map card in [Homepage](https://mapstore.geosolutionsgroup.com/mapstore/#/)

<img src="../img/resource-properties/card-map-details-button.jpg" class="ms-docimage" style="max-width:400px;"/>

Through this, it is possible to open the details panel also from the home page.

<img src="../img/resource-properties/details-sheet.jpg" class="ms-docimage"/>

0 comments on commit e52c895

Please sign in to comment.