Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update User Guide - Unadvertised resources #9976

Merged
merged 10 commits into from
Mar 13, 2024
1 change: 1 addition & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"code-block-style": false,
"line-length": false,
"no-inline-html": false,
"no-alt-text": false,
"no-duplicate-heading": {
"siblings_only": true
}
Expand Down
Binary file modified docs/user-guide/img/resource-properties/edit-properties.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 18 additions & 12 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,11 +51,11 @@ How to manage users and groups is a topic present in the [Managing Users](managi

## Details

Only for resources of type map, it is possible to add details to the map. This is useful to associate some information to the map 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 of the map.
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"/>

Expand All @@ -74,7 +80,7 @@ Here, the user is allowed to:
!!! 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.

* 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, 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"/>

Expand Down
Loading