Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #545

Merged
merged 7 commits into from
Feb 13, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/images/admin/admin_couche_widget.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/source/_static/images/visu/visu_infos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
75 changes: 71 additions & 4 deletions docs/source/user_manual/admin_user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -335,13 +335,15 @@ Créer une couche
La configuration des couches permet de personnaliser de manière très approfondie les possibilités d’interaction au sein d’une couche :

* La fonction de recherche
* La description associée
* La représentation cartographique
* La légende associée aux styles cartographiques affichés
* L’affichage de popups associés aux données
* L’affichage de fiches informatives associés aux données
* La gestion d’outils de filtrage des données
* La gestion de la table attributaire
* La gestion d’un outil de synthèse
* L'affichage de contenus provenant d'applications externes

Pour créer une nouvelle couche, cliquez sur le bouton :guilabel:`CRÉER`.

Expand All @@ -361,7 +363,7 @@ Le :guilabel:`Champ principal` permet d’activer la fonction de recherche dans

Si l’option :guilabel:`Affichée par défaut` est activée, la couche sera activée dès l'ouverture de la vue à laquelle elle est associée dans le visualiseur cartographique.

Enfin, la partie :guilabel:`Description` permet d'ajouter un texte informatif en langage ``HTML`` sur cette couche. Ce texte peut être mis à disposition de l'utilisateur dans les vues classiques et de storytelling.
Enfin, la partie :guilabel:`Description` permet d'ajouter du contenu informatif (textes, images, etc) sur cette couche. Ce texte peut être mis à disposition de l'utilisateur dans les vues classiques et de storytelling.

A ce stade, il est possible d’enregistrer la couche telle quelle et de l’afficher dans le visualiseur cartographique. Une représentation par défaut est appliquée à la couche, ce qui permet de la visualiser.

Expand Down Expand Up @@ -984,12 +986,32 @@ Onglet WIDGET

L’outil de widget permet de récapituler dans un tableau dynamique des indicateurs utiles à l'analyse de la couche.

Sur le visualiseur cartographique, lors du zoom sur la carte, la synthèse se réactualise en fonction des éléments qui se trouvent dans l'emprise spatiale.
Plusieurs widgets peuvent être créés par couche. L'icône et le libellé de chacun d'entre eux est personnalisable.

La configuration de l’outil de widget s’adresse à des utilisateurs développeurs car il requiert l’écriture en `JSON <https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/JSON>`_ avec dans la clé "template" une chaîne de caractère contenant le code en `Nunjucks <https://mozilla.github.io/nunjucks/fr/templating.html>`_ du format de données attendu.
Trois types de calculs statistiques sont proposés :
- le comptage du nombre d'éléments présents ;
- la somme de leur valeur ;
- la moyenne de leur valeur.

.. image :: ../_static/images/admin/admin_couche_widget.png

Il est possible de choisir si le résultat de ces calculs se réactualise en fonction des éléments qui se trouvent dans l'emprise spatiale, lors du zoom sur la carte, ou non.

Un champ de saisie avancée à destination des utilisateurs développeurs est également disponible. Il requiert l’écriture en `JSON <https://developer.mozilla.org/fr/docs/Web/JavaScript/Reference/Global_Objects/JSON>`_ avec dans la clé "template" une chaîne de caractère contenant le code en `Nunjucks <https://mozilla.github.io/nunjucks/fr/templating.html>`_ du format de données attendu.

.. image :: ../_static/images/admin/admin_couche_widget_devs.png

Onglet EMBED
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Onglet INCLUSIONS

~~~~~~~~~~~~~~
Enfin, il est également possible d'associer à une couche des contenus provenant d'applications externes - par exemple, pour associer des graphiques aux couches cartographiques.

Pour cela, il suffit de renseigner :
- l'icône représentative,
- un libellé correspondant,
- l'url du contenu distant à mettre à disposition des utilisateurs de TerraVisu.

.. image :: ../_static/images/admin/admin_couche_embed.png

Modifier une couche
-------------------

Expand Down Expand Up @@ -1075,7 +1097,7 @@ A partir d’un groupe, en cliquant sur les trois petits points verticaux vous a

* Ajouter une couche
* Ajouter un sous-groupe
* Paramétrer le mode de sélection des couches (exclusif/inclusif)
* Paramétrer le mode de sélection des couches : exclusif, inclusif ou par variables
* Supprimer un groupe

.. note::
Expand All @@ -1088,6 +1110,51 @@ L’enregistrement de la vue aura pour effet immédiat de rajouter automatiqueme

Pour modifier une vue existante, cliquez sur la vue dans la liste et effectuez vos changements.

Sélection des couches par variables
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Le mode de sélection de couches dit "par variables" permet de rassembler plusieurs couches portant sur un même indicateur, dont la valeur est fonction de combinaisons de variables.
Ce mécanisme est particulièrement utile pour permettre la sélection du millésime de données ainsi que de l'échelle spatiale utilisée.

Pour pouvoir actionner ce mode de sélection, il est nécessaire d'avoir préalablement défini une couche par combinaison de valeurs voulues pour les variables en jeux.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

en jeu


**Exemple avec deux variables** :
- Variables et valeurs associées
- Zone géographique : Département, Région
- Année : 2020, 2050
- Couches nécessaires (sans contrainte sur le nom)
- Couche Département 2020
- Couche Département 2050
- Couche Région 2020
- Couche Région 2050

Dans la page d'édition d'une vue, vous aurez alors accès au menu suivant permettant la création d'un nouveau groupe.

1. Créer un nouveau groupe, le nommer et afficher ses paramètres :

.. image :: ../_static/images/admin/admin_vue_groupe_.png

2. Sélectionner le mode de sélection de couches "par variables" et renseigner le nom des variables souhaitées :

.. image :: ../_static/images/admin/admin_vue_groupe_variables.png

3. Ajouter une couche au groupe. C'est lors de cette étape que les valeurs des différentes variables sont définies.

.. image :: ../_static/images/admin/admin_vue_groupe_variables_valeurs.png

4. Affecter une couche à chaque combinaison :

.. image :: ../_static/images/admin/admin_vue_groupe_variables_combinaisons.png


Le groupe s'affiche alors dans l'arbre des couches et comporte un sélecteur de valeurs quand il est actif.

.. image :: ../_static/images/visu/visu_groupe_variables.png

Dans le cas où la couche correspondant à une combinaison n'a pas été définie, une erreur s'affiche lors du changement de valeurs des variables et la couche sélectionnée n'est pas modifiée.

.. image :: ../_static/images/visu/visu_groupe_variables_error.png

Supprimer une vue
-----------------

Expand Down
35 changes: 27 additions & 8 deletions docs/source/user_manual/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Vous voulez tester par vous-même? `Une instance de démonstration est accessibl
**Résumé des fonctionnalités :**

* Naviguer dans l'interface cartographique
* Intéragir avec les couches (filtres, table attributaire, transparence, zoom sur l'emprise, synthèse statistique)
* Intéragir avec les couches (descriptif, filtres, table attributaire, transparence, zoom sur l'emprise, synthèse statistique)
* Interroger les objets géographiques (infobulle au survol, fiche descriptive)
* Afficher des fonds de cartes
* Utiliser les outils de navigation (recherche dans les données/lieux, gestion du zoom, orientation de la carte..)
Expand All @@ -33,7 +33,7 @@ L'interface cartographique est décomposée en 4 parties :
* La carte : au centre, un fond de plan cartographique sur lequel se superposent des données
* Les outils de navigation : à droite, se trouvent les outils incontournables d'une application cartographique (zoom, orientation) mais aussi d'autres outils additionnels comme le retour à l'emprise initiale, le changement de fond de plan, l'impression et le partage de la carte

**Exemple du TerraVisu déployé pour la Région Sud**
**Exemple**

.. image :: ../_static/images/visu/visu_interfacecarto.png

Expand All @@ -47,13 +47,16 @@ Les données géographiques sont organisées dans des couches qui rassemblent de
Au niveau d'une couche de données, vous pouvez ainsi activer les fonctionnalités suivantes :

* Afficher/masquer la couche
* Afficher/masuqer le panneau d'informations de la couche
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Afficher/masuqer le panneau d'informations de la couche
* Afficher/masquer le panneau d'informations de la couche

* Afficher/masquer la table attributaire
* Afficher/masquer le panneau de filtres
* Afficher/modifier la liste des filtres appliqués
* Afficher le widget de synthèse
* Afficher du contenu provenant d'une application externe (graphiques par exemple)
* Zoomer sur son étendue spatiale
* Changer son opacité


.. image :: ../_static/images/visu/visu_interfacecarto_couche.png

L'interface cartographique se met automatiquement à jour selon les fonctionnalités activées.
Expand Down Expand Up @@ -98,12 +101,20 @@ La légende

Quand les couches affichées ont des légendes, celles-ci s'affichent sur la partie droite de l'écran. C'est vous qui décidez si vous souhaitez affichez la légende et quel type de légende.

**Exemple de type légende disponible**
**Exemple de légende disponible**

.. image :: ../_static/images/visu/visu_legende.png

La configuration de la légende s’effectue depuis l'outil administration.

Le panneau d'informations
~~~~~~~~~~~~~~~~~~~~~~~~
Il est possible d'associer du contenu informatif à chaque couche. Ce contenu est mis à disposition de l'utilisateur via un panneau dédié, configurable dans l'interface d'administration de la plateforme **TerraVisu**.

**Exemple de panneau d'informations**

.. image :: ../_static/images/visu/visu_infos.png

La table attributaire
~~~~~~~~~~~~~~~~~~~~~~~~

Expand All @@ -119,7 +130,7 @@ La table attributaire de **TerraVisu** comprend de nombreuses fonctionnalités t
* Afficher/masquer des colonnes
* Agrandir la table

**Exemple d'une table attributaire du TerraVisu Sud Éco Foncier**
**Exemple d'une table attributaire**

.. image :: ../_static/images/visu/visu_table.png

Expand All @@ -143,7 +154,7 @@ Le widget

Le widget permet de récapituler dans un tableau dynamique, des indicateurs utiles à l'analyse de la couche. La synthèse des informations se réactualise en fonction des éléments qui se trouvent dans l'emprise spatiale. Le widget s’affiche à droite de l’écran.

**Exemple d'un widget du TerraVisu de SCoT en action**
**Exemple d'un widget**

.. image :: ../_static/images/visu/visu_widget.png

Expand All @@ -154,7 +165,7 @@ Le zoom sur l'étendue spatiale

Cet outil permet de zoomer sur l'étendue spatiale d'une couche activée. Le zoom est particulièrement utile lorsque l'on souhaite voir l'emprise géographique des éléments filtrés d'une couche.

**Exemple d'un zoom pour le TerraVisu de SeineYonne**
**Exemple d'un zoom**

.. image :: ../_static/images/visu/visu_zoomemprise.png

Expand All @@ -171,6 +182,14 @@ Faites glisser le curseur de droite à gauche pour modifier le pourcentage de tr

.. image :: ../_static/images/visu/visu_transparence.png

Les contenus externes associés
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Des contenus configurés depuis une application externe, notamment graphiques, peuvent être ajoutés à une couche. Un pictogramme et un libellé, paramétrables depuis l'interface d'administration, permet d'identifier chacun d'entre eux dans la liste des informations et outils disponibles sur la couche.

**Exemple de graphique**

.. image :: ../_static/images/visu/visu_graphique.png

Les intéractions avec les données affichés sur la carte
---------------------------------------------------------

Expand Down Expand Up @@ -232,7 +251,7 @@ Le fait de sélectionner un résultat dans les attributs de la ou les couches ac
Le comportement est différent si on sélectionne un résultat pour la recherche de lieu puisqu'il permet uniquement de zoomer sur l'emprise géographique correspondante sans réaliser d'intéraction avec la ou les couches activées.


**Exemple de recherche pour le TerraVisu de SeineYonne**
**Exemple de recherche**

.. image :: ../_static/images/visu/visu_recherche.png

Expand Down Expand Up @@ -285,6 +304,6 @@ TerraVisu dispose d'une fonction de Storytelling. C'est une autre forme de visua

Cette fonctionnalité peut servir à la communication ou de manuel d'utilisation.

**Exemple du storytelling de Carto Collectivités**
**Exemple de storytelling**

.. image :: ../_static/images/visu/visu_storytelling.png
Loading