Skip to content
Snippets Groups Projects
Commit ff2bb90d authored by ncastejon's avatar ncastejon
Browse files

Start doc for Resources. Add some images to improve different pages.

parent 6a5debdd
No related branches found
No related tags found
1 merge request!14Doc webapp
docs/assets/data.png

392 KiB

docs/assets/filters.png

28.4 KiB

docs/assets/geo-services.png

90.7 KiB

docs/assets/search.png

141 KiB

docs/assets/suggestion.png

33.6 KiB

...@@ -2,6 +2,8 @@ ...@@ -2,6 +2,8 @@
This is the main page to observe the data of a dataset. This page has two components: a data table and a map. The map will be displayed only for geographical datasets (it makes sense). This is the main page to observe the data of a dataset. This page has two components: a data table and a map. The map will be displayed only for geographical datasets (it makes sense).
![Data](../../../../assets/data.png)
## Fullscreen and Toggle Map/data ## Fullscreen and Toggle Map/data
To increase the flexibility and the comfort of the user to display the data, it's possible to put in fullscreen the components. To increase the flexibility and the comfort of the user to display the data, it's possible to put in fullscreen the components.
......
# Resources
We define a resource a piece of information that is associated to a dataset. A resource can be classified in three categories:
* queryable resources: this is provided by the geographical APIs available for the dataset.
* static resources: a file that can be downloaded directly. For example a PDF, a CSV.
* others: all other types. It might be for example an URL of a website providing more information about the dataset
## Queryable resources
For each geographical dataset, there is one or multiple interfaces to access geographical data. These interfaces are standards defined by the Open Geospatial Consortium (OGC).
We have one exception, the `WS` service. It is not a standard, and has been developped for specfic needs for the Métropole de Lyon.
* WMS (Web Map Service): allows to get map as images
* WFS (Web Feature Service): manipulate geographical information with coordinates and properties
* WCS (Web Coverage Service): retrieves coverages data (geospatial information representing space/time-varying phenomena)
* KML (Keyhole Markup Service): get XML-based files for GIS softwares
* SOS (Sensor Observation Service): query observation and sensor metadata
* WS
By the way, it is possible to select datasets with the services you want by using the [filters](../search.md#Filters)
Here is an example of the page.
![Geographical services](../../../../assets/geo-services.png)
For each service you have the possibility to create a custom reequest (exception for the `SOS` service) and change the options such as the output formats, the projection system or the regions. From that you can copy the custom request, or download the resources that link will give you.
In the previous example in the picture, I would be able to download the image of the 'arbres d'alignement' dataset from the WMS (Web Map Service).
## Static resources
## Other resources
...@@ -9,6 +9,8 @@ Here are the features existing on the portal: ...@@ -9,6 +9,8 @@ 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. 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.
![Search page](../../../assets/search.png)
## Datasets results ## Datasets results
As in many search tools the results are displayed in different tabs representing different results categories: `All`, `Data`, `Services` and the `News` (editorial content). As in many search tools the results are displayed in different tabs representing different results categories: `All`, `Data`, `Services` and the `News` (editorial content).
...@@ -22,6 +24,8 @@ See the [search bar](./header.md#Search-bar) documentation ...@@ -22,6 +24,8 @@ See the [search bar](./header.md#Search-bar) documentation
## Filters ## Filters
![Filters](../../../assets/filters.png)
On the left side of the screen the user has the possibility to add filters and subfilters (depending the category) On the left side of the screen the user has the possibility to add filters and subfilters (depending the category)
These categories (e.g. producers, licences, formats) are based on the metadata properties. Then each value for these properties are aggregated. These categories (e.g. producers, licences, formats) are based on the metadata properties. Then each value for these properties are aggregated.
Inside one filter category, the values are sorted by the number of datasets. Inside one filter category, the values are sorted by the number of datasets.
...@@ -33,4 +37,6 @@ On another hand, if the user selects different filters in different filter categ ...@@ -33,4 +37,6 @@ On another hand, if the user selects different filters in different filter categ
## Suggestion ## Suggestion
![Filters](../../../assets/suggestion.png)
This is a useful feature, especially for typo. If your research doesn't give you any result, Elasticsearch might find for you a word that is close of yours that would give more success in the results. This is a useful feature, especially for typo. If your research doesn't give you any result, Elasticsearch might find for you a word that is close of yours that would give more success in the results.
# Resources service # Resources service
## What it does ## What it does
This service can provide lists of resources and formats. This service can provide lists of resources and formats.
A resource is an entity representing some information, usually geographic, that can be accessed by a query (for example Web Map Service) or by downloading a file. One resource can be considered standard (e.g WMS protocol) or not standard (a custom service). A resource is an entity representing some information, usually geographic, that can be accessed by a query (for example Web Map Service) or by downloading a file. One resource can be considered standard (e.g WMS protocol) or not standard (a custom service).
Each resource is associated with one or many formats. Each resource is associated with one or many formats.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment