Update User Guide - Add Permalink tool (#9328)

* update_9312 * review_9312
geosolutions-it · Aug 3, 2023 · 6ee71b7 · 6ee71b7
1 parent 7ebdbef
commit 6ee71b7
Show file tree

Hide file tree

Showing 14 changed files with 21 additions and 4 deletions.
diff --git a/docs/user-guide/img/button/generate_permalink.jpg b/docs/user-guide/img/button/generate_permalink.jpg
diff --git a/docs/user-guide/img/share/embed-dash.jpg b/docs/user-guide/img/share/embed-dash.jpg
diff --git a/docs/user-guide/img/share/embed.jpg b/docs/user-guide/img/share/embed.jpg
diff --git a/docs/user-guide/img/share/embed_maps_size.jpg b/docs/user-guide/img/share/embed_maps_size.jpg
diff --git a/docs/user-guide/img/share/embed_maps_toc.jpg b/docs/user-guide/img/share/embed_maps_toc.jpg
diff --git a/docs/user-guide/img/share/permalink.jpg b/docs/user-guide/img/share/permalink.jpg
diff --git a/docs/user-guide/img/share/permalink_generated.jpg b/docs/user-guide/img/share/permalink_generated.jpg
diff --git a/docs/user-guide/img/share/share_options.jpg b/docs/user-guide/img/share/share_options.jpg
diff --git a/docs/user-guide/img/share/share_window.jpg b/docs/user-guide/img/share/share_window.jpg
diff --git a/docs/user-guide/img/share/share_window_3d_map_options.jpg b/docs/user-guide/img/share/share_window_3d_map_options.jpg
diff --git a/docs/user-guide/img/share/share_window_center_zoom.jpg b/docs/user-guide/img/share/share_window_center_zoom.jpg
diff --git a/docs/user-guide/img/share/share_window_map_options.jpg b/docs/user-guide/img/share/share_window_map_options.jpg
diff --git a/docs/user-guide/img/share/social.jpg b/docs/user-guide/img/share/social.jpg
diff --git a/docs/user-guide/share.md b/docs/user-guide/share.md
@@ -12,11 +12,13 @@
 
 From the *Share panel* the user is allowed to share a resource in different ways:
 
-* With a **direct link**
+* With a **Direct Link**
 
-* Through a **social network**
+* Through a **Social Network**
 
-* With **embedded code** or **APIs** (only available for *maps*)
+* Through a **Permalink** to shares current user session (only available from the [Side Toolbar](mapstore-toolbars.md#side-toolbar))
+
+* With **Embedded code** or **APIs** (only available for *maps*)
 
 ## Link
 
@@ -32,6 +34,21 @@ The **Social** section allows the user to share the resource on the most common
 
 <img src="../img/share/social.jpg" class="ms-docimage"  style="max-width:400px;"/>
 
+## Permalink
+
+The **Permalink** section allows to save the current overall viewer state of the resource and share it as a permalink.
+
+<img src="../img/share/permalink.jpg" class="ms-docimage"  style="max-width:400px;"/>
+
+A permalink is a new resource belonging to a dedicated category in [MapStore](https://mapstore.geosolutionsgroup.com/mapstore/#/) for which the user must enter the **Title** and **Description** (the last one is not mandatory) and choose whether the resource will be public by checking the **Public** option (this will generate a public map permalink so that everyone can access it).
+
+!!! Warning
+    [Map Details](resources-properties.md#details) as well as other resources connected to a map or context, if present, will not be available in the final permalink resource.
+
+When all options are filled, the user can **Generate permalink** through the <img src="../img/button/generate_permalink.jpg" class="ms-docbutton"/> button to get the **Permalink URL** or the **QR code** to share it.
+
+<img src="../img/share/permalink_generated.jpg" class="ms-docimage"  style="max-width:400px;"/>
+
 ## Embed
 
 The **Embed** section provides to the user the needed snippets, **embedded code** or the **MS APIs** (only available for *maps*) to embed MapStore in a third party web page.
@@ -99,7 +116,7 @@ The related available options allow the user to:
 
 In case of GeoStories, enabling the **Advanced options** in the *Share tool* the user can include the following to the share URL:
 
-<img src="../img/exploring-stories/share_options.jpg" class="ms-docimage" width="400px"/>
+<img src="../img/share/share_options.jpg" class="ms-docimage" width="400px"/>
 
 * The **Home button** to allow the possibility to bring the user to the MapStore Home Page if needed: that button will be automatically included in view mode inside the story toolbar just beside the navigation bar.