From 4337f617d98548d513a595b2e434130376a16839 Mon Sep 17 00:00:00 2001 From: FORESTIER Fabien <fabien.forestier@soprasteria.com> Date: Fri, 24 Jan 2020 16:28:08 +0100 Subject: [PATCH] Put the features to describe in the corresponding pages --- .../custom-apps/web-app/dataset/data.md | 36 ++++++ .../custom-apps/web-app/dataset/info.md | 5 + .../custom-apps/web-app/homepage.md | 5 + .../custom-apps/web-app/overview.md | 106 ------------------ docs/components/custom-apps/web-app/search.md | 11 ++ .../custom-apps/web-app/side-menu.md | 5 + 6 files changed, 62 insertions(+), 106 deletions(-) diff --git a/docs/components/custom-apps/web-app/dataset/data.md b/docs/components/custom-apps/web-app/dataset/data.md index e69de29..169cc8d 100644 --- a/docs/components/custom-apps/web-app/dataset/data.md +++ b/docs/components/custom-apps/web-app/dataset/data.md @@ -0,0 +1,36 @@ +# Research in the data + +# Properties display toggle + +# Data table (sort properties & complex properties & hostory of the click elements) + +# Map + +* plan vecto & satellite +* research by address +* geoloc +* copy map +* interactions +* detail of a data on map feature click + +For each geographical dataset it's possible to display the data on a map. Here is what have been done to make this happen. + +Mapbox GL JS + +On the client side, the library [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) is used. This is a very interesting tool improving quickly. The only drawback using it with Angular is that we cannot always use its last version. Indeed as we are using Typescript, we need to wait until the @types are updated. + +## Styling + +Mapbox use the [Mapbox style specification](https://docs.mapbox.com/mapbox-gl-js/style-spec/) to define the visual appearance of a map. +In our project we have created different styles depending on how we want to display the map. For example when we display the aerial layer, we don't necessary want the names of, say the roads and the river, to have the same color than when we display the vectorial layer. +So when we change these layers, we load the appropriate style. + +## How is the data fetched ? + +Initially we were using Web Feature Service (WFS) and Web Map Service protocols to get the data (geojson or images). But for WFS we realized that when our needs became more complex and precise, this could sometimes be not so easy (filters are not the most funny thing to do). +So we used...Elasticsearch. It is super fast and even have geographical research. We fetch the data from ES, format it into a `.geojson` and voilà ! This will also allow us in the future to have more advanced features on the map (like filters). + + +# Fullscreen + +# Toggle Map/data \ No newline at end of file diff --git a/docs/components/custom-apps/web-app/dataset/info.md b/docs/components/custom-apps/web-app/dataset/info.md index e69de29..4670777 100644 --- a/docs/components/custom-apps/web-app/dataset/info.md +++ b/docs/components/custom-apps/web-app/dataset/info.md @@ -0,0 +1,5 @@ +# Parent and children datasets + +# License + +# Contact us \ No newline at end of file diff --git a/docs/components/custom-apps/web-app/homepage.md b/docs/components/custom-apps/web-app/homepage.md index e69de29..1782dba 100644 --- a/docs/components/custom-apps/web-app/homepage.md +++ b/docs/components/custom-apps/web-app/homepage.md @@ -0,0 +1,5 @@ +# Explore + +# News + +# All news \ No newline at end of file diff --git a/docs/components/custom-apps/web-app/overview.md b/docs/components/custom-apps/web-app/overview.md index e018091..fb99893 100644 --- a/docs/components/custom-apps/web-app/overview.md +++ b/docs/components/custom-apps/web-app/overview.md @@ -52,111 +52,6 @@ It is highlighy customizable and easy to integrate in a project. To do so, a `variables.scss` file that contains our project variables, overrides the Bulma variables (color, padding, anything you want). Then Bulma is imported and added to our main `style.scss`. That's it, our style incorporate a personalized Bulma . -## Features by pages - -### Home - -#### Explore - -#### News - -#### All news - -### Side menu - -#### Draft button - -#### App version number - -#### FR and EN buttons - -### Feedback - -### Static pages - -### Partners - -### Reuses - -### Draft page - -### Contact - -### Last changes - -### Download the catalogue - -### Credits - -### Sign In & Sign Up - -### User profil - -### User data - -### Research - -#### Filters - -#### Tabs - -#### Pagination - -#### Sort - -#### Suggestion - -#### Dataset result - -### Datset details (Data tab) - -#### Research in the data - -#### Properties display toggle - -#### Data table (sort properties & complex properties & hostory of the click elements) - -#### Map - -* plan vecto & satellite -* research by address -* geoloc -* copy map -* interactions -* detail of a data on map feature click - -For each geographical dataset it's possible to display the data on a map. Here is what have been done to make this happen. - -Mapbox GL JS - -On the client side, the library [Mapbox GL JS](https://github.com/mapbox/mapbox-gl-js) is used. This is a very interesting tool improving quickly. The only drawback using it with Angular is that we cannot always use its last version. Indeed as we are using Typescript, we need to wait until the @types are updated. - -### Styling - -Mapbox use the [Mapbox style specification](https://docs.mapbox.com/mapbox-gl-js/style-spec/) to define the visual appearance of a map. -In our project we have created different styles depending on how we want to display the map. For example when we display the aerial layer, we don't necessary want the names of, say the roads and the river, to have the same color than when we display the vectorial layer. -So when we change these layers, we load the appropriate style. - -### How is the data fetched ? - -Initially we were using Web Feature Service (WFS) and Web Map Service protocols to get the data (geojson or images). But for WFS we realized that when our needs became more complex and precise, this could sometimes be not so easy (filters are not the most funny thing to do). -So we used...Elasticsearch. It is super fast and even have geographical research. We fetch the data from ES, format it into a `.geojson` and voilà ! This will also allow us in the future to have more advanced features on the map (like filters). - - -#### Fullscreen - -#### Toggle Map/data - -### Datset details (Info tab) - -#### Parent and children datasets - -#### License - -#### Contact us - - - ## Research features This core feature is based on [Elasticsearch](https://www.elastic.co/fr/) (ES). Almost all the information in the portal (including datasets, articles, geographical data) is indexed in ES. This allows lot's of possibilities with the powerful features of this tool. @@ -168,7 +63,6 @@ Here are the features existing on the portal: Of course there is a plenty of room for improvements for these features (and for new ones). ES is very powerful but also very complex to master. It's in a constant improvement. - ## API & Downloads feature ## CI/CD diff --git a/docs/components/custom-apps/web-app/search.md b/docs/components/custom-apps/web-app/search.md index e69de29..fc0dd80 100644 --- a/docs/components/custom-apps/web-app/search.md +++ b/docs/components/custom-apps/web-app/search.md @@ -0,0 +1,11 @@ +#### Filters + +#### Tabs + +#### Pagination + +#### Sort + +#### Suggestion + +#### Dataset result \ No newline at end of file diff --git a/docs/components/custom-apps/web-app/side-menu.md b/docs/components/custom-apps/web-app/side-menu.md index e69de29..f014ab2 100644 --- a/docs/components/custom-apps/web-app/side-menu.md +++ b/docs/components/custom-apps/web-app/side-menu.md @@ -0,0 +1,5 @@ +# Draft button + +# App version number + +# FR and EN buttons \ No newline at end of file -- GitLab