wip: updated tours/docs (#154)

kalisio · Mar 9, 2021 · 835d5ed · 835d5ed
1 parent 98809d9
commit 835d5ed
Show file tree

Hide file tree

Showing 8 changed files with 36 additions and 44 deletions.
diff --git a/config/default.js b/config/default.js
@@ -70,6 +70,7 @@ const mapCatalog = {
 
 // Map layer actions
 const mapLayerActions = [{
+  id: 'layer-actions',
   component: 'frame/KMenu',
   actionRenderer: 'item',
   content: [
@@ -361,23 +362,16 @@ module.exports = {
           { id: 'zoom-in', icon: 'add', tooltip: 'mixins.activity.ZOOM_IN', handler: { name: 'onZoomIn' } },
           { id: 'zoom-out', icon: 'remove', tooltip: 'mixins.activity.ZOOM_OUT', handler: { name: 'onZoomOut' } },
           { component: 'QSeparator', vertical: true, color: 'lightgrey' }, */
-          { component: 'KLocateUser' },
+          { id: 'locate-user', component: 'KLocateUser' },
           { id: 'search-location', icon: 'las la-search-location', tooltip: 'mixins.activity.SEARCH_LOCATION', handler: { name: 'setTopPaneMode', params: ['search-location'] } },
           {
-            component: 'frame/KMenu',
-            icon: 'star_border',
-            persistent: true,
-            autoClose: false,
-            tooltip: 'KFavoriteViews.FAVORITE_VIEWS_LABEL',
+            id: 'favorite-views', component: 'frame/KMenu', icon: 'star_border', persistent: true, autoClose: false, tooltip: 'KFavoriteViews.FAVORITE_VIEWS_LABEL',
             content: [
-              { id: 'favorite-views', component: 'KFavoriteViews' }
+              { component: 'KFavoriteViews' }
             ]
           },
           {
-            component: 'frame/KMenu',
-            icon: 'las la-wrench',
-            tooltip: 'mixins.activity.TOOLS',
-            actionRenderer: 'item',
+            id: 'tools', component: 'frame/KMenu', icon: 'las la-wrench', tooltip: 'mixins.activity.TOOLS', actionRenderer: 'item',
             content: [
               { id: 'display-position', icon: 'las la-plus', label: 'mixins.activity.DISPLAY_POSITION', handler: { name: 'setTopPaneMode', params: ['display-position'] } }
             ]
@@ -439,22 +433,16 @@ module.exports = {
         default: [
           { id: 'toggle-map', icon: 'las la-map', tooltip: 'mixins.activity.TOGGLE_MAP', route: { name: 'map-activity', params: { south: ':south', north: ':north', west: ':west', east: ':east' }, query: { layers: ':layers' } } },
           { component: 'QSeparator', vertical: true, color: 'lightgrey' },
-          { component: 'KLocateUser' },
+          { id: 'locate-user', component: 'KLocateUser' },
           { id: 'search-location', icon: 'las la-search-location', tooltip: 'mixins.activity.SEARCH_LOCATION', handler: { name: 'setTopPaneMode', params: ['search-location'] } },
           {
-            component: 'frame/KMenu',
-            icon: 'star_border',
-            autoClose: false,
-            tooltip: 'KFavoriteViews.FAVORITE_VIEWS_LABEL',
+            id: 'favorite-views', component: 'frame/KMenu', icon: 'star_border', autoClose: false, tooltip: 'KFavoriteViews.FAVORITE_VIEWS_LABEL',
             content: [
-              { id: 'favorite-views', component: 'KFavoriteViews' }
+              { component: 'KFavoriteViews' }
             ]
           },
           {
-            component: 'frame/KMenu',
-            icon: 'las la-wrench',
-            tooltip: 'mixins.activity.TOOLS',
-            actionRenderer: 'item',
+            id: 'tools', component: 'frame/KMenu', icon: 'las la-wrench', tooltip: 'mixins.activity.TOOLS', actionRenderer: 'item',
             content: [
               { id: 'display-position', icon: 'las la-plus', label: 'mixins.activity.DISPLAY_POSITION', handler: { name: 'setTopPaneMode', params: ['display-position'] } }
             ]

diff --git a/docs/guides/getting-started.md b/docs/guides/getting-started.md
@@ -26,13 +26,14 @@ The main menu allows to open the documentation, manage your settings and logout
 
 :point_right: Launch the main tutorial from the main menu then open the link <i class="las la-external-link-square-alt"/> to the main menu tutorial to get more details
 
-## Navigation bar
+## Application bar
 
-The navigation bar allows to quickly execute recurring actions:
+The application bar allows to quickly execute recurring actions:
 * switch from 2D (respectively 3D) activity to <i class="las la-globe"></i> 3D (respectively <i class="las la-map"></i> 2D) activity,
-* <i class="las la-crosshairs"></i> display the coordinates of a location,
-* <i class="las la-search"></i> seek for an address,
-* <i class="las la-street-view"></i> center the view on your current location,
+* <i class="las la-crosshairs"></i> center the view on your current location and display it,
+* <i class="las la-search-location"></i> seek for an address,
+* <i class="las la-star_border"></i> manage your favorite views,
+* <i class="las la-wrench"></i> displays the coordinates of a location,
 * <i class="las la-expand"></i> switch to fullscreen mode.
 
 :point_right: Launch the main tutorial from the main menu then open the link <i class="las la-external-link-square-alt"/> to the navigation bar tutorial to get more details
@@ -75,6 +76,7 @@ A *right-click* on a feature of the map will display a contextual menu if some a
 Depending on the layer different actions are available. The most common action is to *zoom to* <i class="las la-search-location"/> the layer in order to fit the view on the available data. If the layer is disabled at high scales this action will set the current scale of the map so that data will start be visible if the layer is shown.
 
 More actions are available on user-defined feature layers:
+* <i class="las la-search-location"></i> center the view to the loaded layer content (if any)
 * <i class="las la-save"></i> save the layer (i.e. make it persistent),
 * <i class="las la-file-alt"></i> edit layer properties like its name or description,
 * <i class="las la-edit"></i> edit layer features (metadata and geometry),

diff --git a/docs/guides/understanding-kano.md b/docs/guides/understanding-kano.md
@@ -33,7 +33,7 @@ The 3D view is pretty similar to the 2D activity except that some feature might
 :::
 
 Each component can be shown/hidden through a handle on the different side of the view:
-* at the top to open the **navigation bar**,
+* at the top to open the **application bar**,
 * at the bottom to open the **timeline**,
 * on the left to open the **side/main menu**,
 * on the right to open the **catalog**.

diff --git a/src/i18n/app_en.json b/src/i18n/app_en.json
@@ -30,14 +30,17 @@
       "SETTINGS_LABEL": "Update general settings of the system on your device.",
       "LOGOUT_LABEL": "Logout in order to close your work session.",
       "SESSION_LABEL": "Otherwise the session will remain active on your device for <b>24H</b>, you will not have to login again in this time frame.",
-      "NAVIGATION_BAR_LABEL": "Open the main menu any time using this handle.",
-      "NAVIGATION_BAR_LINK_LABEL": "Open the navigation bar any time using this handle.",
+      "NAVIGATION_BAR_LABEL": "Open the application bar any time using this handle.",
+      "NAVIGATION_BAR_LINK_LABEL": "Browse the application bar.",
       "CATALOG_LABEL": "Open the catalog any time using this handle.",
       "CATALOG_LINK_LABEL": "Browse the catalog",
       "TIMELINE_LABEL": "Open the timeline any time using this handle.",
       "TIMELINE_LINK_LABEL": "Browse the timeline",
       "FAB_LABEL": "Quickly execute actions related to map data using this button.",
       "FAB_LINK_LABEL": "Browse the actions"
+    },
+    "navigation-bar": {
+      "NAVIGATION_BAR_LABEL": "The application bar allows to quickly execute recurring actions."
     }
   },
   "screen": {

diff --git a/src/i18n/app_fr.json b/src/i18n/app_fr.json
@@ -30,14 +30,17 @@
       "SETTINGS_LABEL": "Modifiez les paramètres généraux du système sur votre appareil.",
       "LOGOUT_LABEL": "Déconnectez vous si vous souhaitez clôturer votre session de travail.",
       "SESSION_LABEL": "Sinon la session reste active sur votre appareil pendant <b>24H</b> et vous n'aurez pas besoin de vous reconnecter durant ce laps de temps.",
-      "NAVIGATION_BAR_LABEL": "Ouvrez à tout moment la barre de navigation via cette poignée.",
-      "NAVIGATION_BAR_LINK_LABEL": "Parcourir la barre de navigation",
+      "NAVIGATION_BAR_LABEL": "Ouvrez à tout moment la barre d'application via cette poignée.",
+      "NAVIGATION_BAR_LINK_LABEL": "Parcourir la barre d'application",
       "CATALOG_LABEL": "Ouvrez à tout moment le catalogue via cette poignée.",
       "CATALOG_LINK_LABEL": "Parcourir le catalogue",
       "TIMELINE_LABEL": "Ouvrez à tout moment la ligne de temps via cette poignée.",
       "TIMELINE_LINK_LABEL": "Parcourir la ligne de temps",
       "FAB_LABEL": "Accéder rapidement aux actions relatives aux données cartographiques via ce bouton.",
       "FAB_LINK_LABEL": "Voir les actions"
+    },
+    "navigation-bar": {
+      "NAVIGATION_BAR_LABEL": "La <b>barre d'application</b> vous permet d'accéder rapidement à certaines actions récurrentes."
     }
   },
   "screen": {

diff --git a/src/tours/home.js b/src/tours/home.js
@@ -1,36 +1,36 @@
 module.exports = [{
-  target: '#opener-left',
+  target: '#left-opener',
   title: 'tours.home.SIDENAV_LABEL',
   link: 'tours.home.SIDENAV_LINK_LABEL',
   params: {
     placement: 'right',
-    hoverClickOnLink: '#opener-left',
+    hoverClickOnLink: '#left-opener',
     tour: 'side-nav'
   }
 }, {
-  target: '#opener-top',
+  target: '#top-opener',
   title: 'tours.home.NAVIGATION_BAR_LABEL',
   link: 'tours.home.NAVIGATION_BAR_LINK_LABEL',
   params: {
     placement: 'bottom',
     tour: 'navigation-bar'
   }
 }, {
-  target: '#opener-right',
+  target: '#right-opener',
   title: 'tours.home.CATALOG_LABEL',
   link: 'tours.home.CATALOG_LINK_LABEL',
   params: {
     placement: 'left',
-    hoverClickOnLink: '#opener-right',
+    hoverClickOnLink: '#right-opener',
     tour: 'catalog-panel'
   }
 }, {
-  target: '#opener-bottom',
+  target: '#bottom-opener',
   title: 'tours.home.TIMELINE_LABEL',
   link: 'tours.home.TIMELINE_LINK_LABEL',
   params: {
     placement: 'top',
-    hoverClickOnLink: '#opener-bottom',
+    hoverClickOnLink: '#bottom-opener',
     tour: 'timeline'
   }
 }, {

diff --git a/src/tours/index.js b/src/tours/index.js
@@ -7,4 +7,3 @@ module.exports = {
   'timeline': require('./map/timeline'),
   'fab': require('./map/fab')
 }
-
diff --git a/src/tours/side-nav.js b/src/tours/side-nav.js
@@ -3,9 +3,7 @@ module.exports = [{
   title: 'tours.home.LOGOUT_LABEL',
   content: 'tours.home.SESSION_LABEL',
   params: {
-    placement: 'top',
-    clickOnPrevious: '#online-help',
-    previousDelay: 500
+    placement: 'top'
   }
 }, {
   target: '#help',
@@ -19,7 +17,6 @@ module.exports = [{
   content: 'tours.home.SETTINGS_LABEL',
   params: {
     placement: 'top',
-    clickOnPrevious: '#about',
     previousDelay: 500
   }
 }, {
@@ -35,7 +32,7 @@ module.exports = [{
   content: 'tours.home.BUG_LABEL',
   params: {
     placement: 'top',
-    clickOnPrevious: ['#close-action', '#opener-left'],
+    clickOnPrevious: ['#close-modal', '#left-opener'],
     previousDelay: 500
   }
 }]