From 835d5edaa2e33ca086e05672844f6a79def975d3 Mon Sep 17 00:00:00 2001 From: Luc Claustres Date: Tue, 9 Mar 2021 21:33:37 +0100 Subject: [PATCH] wip: updated tours/docs (#154) --- config/default.js | 30 +++++++++--------------------- docs/guides/getting-started.md | 12 +++++++----- docs/guides/understanding-kano.md | 2 +- src/i18n/app_en.json | 7 +++++-- src/i18n/app_fr.json | 7 +++++-- src/tours/home.js | 14 +++++++------- src/tours/index.js | 1 - src/tours/side-nav.js | 7 ++----- 8 files changed, 36 insertions(+), 44 deletions(-) diff --git a/config/default.js b/config/default.js index 979574fe..7ca379a3 100644 --- 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 index 1ebb50c1..05a469af 100644 --- 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 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 3D (respectively 2D) activity, -* display the coordinates of a location, -* seek for an address, -* center the view on your current location, +* center the view on your current location and display it, +* seek for an address, +* manage your favorite views, +* displays the coordinates of a location, * switch to fullscreen mode. :point_right: Launch the main tutorial from the main menu then open the link 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* 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: +* center the view to the loaded layer content (if any) * save the layer (i.e. make it persistent), * edit layer properties like its name or description, * edit layer features (metadata and geometry), diff --git a/docs/guides/understanding-kano.md b/docs/guides/understanding-kano.md index d0223146..d9e18e0b 100644 --- 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 index 1e207a5e..80a5bdbd 100644 --- 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 24H, 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 index c6b0a7a6..c03982c5 100644 --- 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 24H 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 barre d'application vous permet d'accéder rapidement à certaines actions récurrentes." } }, "screen": { diff --git a/src/tours/home.js b/src/tours/home.js index 457f99c5..a3877c14 100644 --- a/src/tours/home.js +++ b/src/tours/home.js @@ -1,14 +1,14 @@ 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: { @@ -16,21 +16,21 @@ module.exports = [{ 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 index 8cf19049..c4b03c84 100644 --- 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 index cdf60195..eee36f07 100644 --- 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 } }]