Merge branch 'master' of gitlab.veremes.net:Development/vitis-2020/applications/vmap-2021

doc/source/administrator/cadastre/config_fiche_desc.md

+# Configuration de la fiche descriptive
+
+Cette section est dédiée à la configuration de la fiche descriptive.  
+Elle est décomposée en 3 parties :  
+![config_section_fiche_descriptive](../../images/administrator/cadastre/config_fiche_descriptive.jpg)
+
+## Tolérance d'intersection
+
+Surface (en pourcent %) à partir de laquelle une intersection est prise en compte.
+
+## Intersection sur "id_com"
+
+Cette option est un champ a activer (cocher "Oui" ou "Non").  
+Si cette option est activée, lors d'une intersection, vMap utilisera également l'identifiant "id_com" pour faire les intersections, si celui-ci existe dans la table.
+
+## Tables d'intersection
+
+Ce champ est un document JSON, permettant d'indiquer les différentes tables utilisées pour les intersections avec vMap, ainsi qu'indiquer le type de champ pour la représentation de cette donnée (nombre, texte, lien, ...).
+
+Le document JSON accepte les paramètres suivant :  
+
+| Nom du champ | Type de champ        | Obligatoire ? | Description                                                                                               |
+|--------------|----------------------|---------------|-----------------------------------------------------------------------------------------------------------|
+| columns      | Objet JSON           | Oui           | Objet JSON contenant la description des champs de la table à intersecter pour la construction du document |
+| schema       | chaîne de caractères | Oui           | Schéma dans lequel se trouve la table à intersecter                                                       |
+| table        | chaîne de caractères | Oui           | Table à intersecter                                                                                       |
+| title        | chaîne de caractères | Oui           | Nom de la section intersectée dans la fiche descriptive                                                   |
+| type         | chaîne de caractères | Oui           | Type de la géométrie contenue dans la table intersectée                                                   |
+
+Pour le descriptif du document JSON représentant les colonnes de la table :  
+
+| Nom du champ   | Type de champ        | Exemple de valeurs | Obligatoire ?       | Description                                                                                                                                                                                                                                                                                                                                             |
+|----------------|----------------------|--------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| alias          | chaîne de caractères | "Cliquez ici"      | Non                 | Permet d'afficher une chaîne de caractères alternative dans le nom du lien de la colonne de la table intersectée, au lieu d'afficher le nom de la colonne, ne sert que pour les champs de type 'lien'                                                                                                                                                                                  |
+| alias_variable | chaîne de caractères |  - true  - false   | non, défaut à false | Permet d'indiquer si le l'alias est une chaîne de caractère à afficher (false), ou du texte contenu dans un attribut qu'il faut référencer (true), ne sert que pour les champs de type 'lien'                                                                                                                                                                                                |
+| label          | chaîne de caractères | "Identifiant"      | Oui                 | Nom de la colonne à afficher                                                                                                                                                                                                                                                                                                                            |
+| name           | chaîne de caractères | "id_X"             | Oui                 | nom de la colonne en base de données                                                                                                                                                                                                                                                                                                                    |
+| type           | chaîne de caractères |  - lien  - texte   | Non, défaut à texte                 | Permet d'indiquer le type de représentation pour la donnée de la colonne.  - En tant que texte, le contenu est juste affichée dans la colonne.  - En tant que lien, le contenu est utilisé pour proposer un accès de type lien hypertexte à un document, cela est très utile pour donner l'accès à un document en rapport avec la parcelle par exemple. |
+
+Ci-dessous, un exemple fictif de document JSON pour les intersections d'une fiche descriptive, celle-ci pouvant servir d'exemple :  
+
+```js
+[
+  {
+    "columns": [
+      {
+        "label": "titre",
+        "name": "col_titre",
+      }
+      {
+        "alias": "Réglement",
+        "alias_variable": false,
+        "label": "Lien vers règlement",
+        "name": "lien_reglement",
+        "type": "lien"
+      }
+    ],
+    "schema": "schema1",
+    "table": "table1",
+    "title": "Titre de ma table",
+    "type": "POLYGON"
+  }
+]
+```
\ No newline at end of file

doc/source/administrator/cadastre/config_fiche_urba.md

+# Configuration de la fiche d'urbanisme
+
+Cette section est dédiée à la configuration de la fiche d'urbanisme.  
+Elle est décomposée en 7 parties :  
+![config_section_fiche_urbanisme](../../images/administrator/cadastre/config_fiche_urbanisme.jpg)
+
+## Logo fiche urbanisme
+
+Ce champ permet de définir le logo à afficher sur la fiche d'urbanisme.  
+
+```{warning}
+L'image du logo doit être saisie sous forme de chaîne caractère au format base64.  
+Plus d'informations sur le format des URL en base64 [au lien suivant](https://developer.mozilla.org/fr/docs/Web/HTTP/Basics_of_HTTP/Data_URLs).
+```
+
+## Organisation fiche urbanisme
+
+Nom de l'organisation à afficher sur la fiche d'urbanisme.
+
+## Template d'impression pour fiche d'urbanisme
+
+Identifiant du modèle d'impression à utiliser pour la fiche d'urbanisme.  
+Quand celui-ci est renseigné, vMap utilise ce modèle à la place du modèle de fiche d'urbanisme par défaut, cela permet d'utiliser des modèles personnalisés.  
+
+```{tip}
+Plus d'informations sur la fonctionnement des modèles d'impression [au lien suivant](./)
+```
+
+## Marge de zoom pour la géométrie
+
+Cette attribut permet de définir la marge utilisée dans la fiche d'urbanisme entre la géométrie et le bord de la carte.  
+**Elle est exprimée en pixels (px), et ne peut pas dépasser de la largeur ou de la hauteur de la carte**.
+
+## Tolérance d'intersection
+
+Surface (en pourcent %) à partir de laquelle une intersection est prise en compte.
+
+## Intersection sur "id_com"
+
+Cette option est un champ a activer (cocher "Oui" ou "Non").  
+Si cette option est activée, lors d'une intersection, vMap utilisera également l'identifiant "id_com" pour faire les intersections, si celui-ci existe dans la table.
+
+## Tables d'intersection
+
+Ce champ est un document JSON, permettant d'indiquer les différentes tables utilisées pour les intersections avec vMap, ainsi qu'indiquer le type de champ pour la représentation de cette donnée (nombre, texte, lien, ...).
+
+Le document JSON accepte les paramètres suivant :  
+
+| Nom du champ | Type de champ        | Obligatoire ? | Description                                                                                               |
+|--------------|----------------------|---------------|-----------------------------------------------------------------------------------------------------------|
+| columns      | Objet JSON           | Oui           | Objet JSON contenant la description des champs de la table à intersecter pour la construction du document |
+| schema       | chaîne de caractères | Oui           | Schéma dans lequel se trouve la table à intersecter                                                       |
+| table        | chaîne de caractères | Oui           | Table à intersecter                                                                                       |
+| title        | chaîne de caractères | Oui           | Nom de la section intersectée dans la fiche d'urbanisme                                                   |
+| type         | chaîne de caractères | Oui           | Type de la géométrie contenue dans la table intersectée                                                   |
+
+Pour le descriptif du document JSON représentant les colonnes de la table :  
+
+| Nom du champ   | Type de champ        | Exemple de valeurs | Obligatoire ?       | Description                                                                                                                                                                                                                                                                                                                                             |
+|----------------|----------------------|--------------------|---------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| alias          | chaîne de caractères | "Cliquez ici"      | Non                 | Permet d'afficher une chaîne de caractères alternative dans le nom du lien de la colonne de la table intersectée, au lieu d'afficher le nom de la colonne, ne sert que pour les champs de type 'lien'                                                                                                                                                                                               |
+| alias_variable | chaîne de caractères |  - true  - false   | non, défaut à false | Permet d'indiquer si le l'alias est une chaîne de caractère à afficher (false), ou du texte contenu dans un attribut qu'il faut référencer (true), ne sert que pour les champs de type 'lien'                                                                                                                                                                                                      |
+| label          | chaîne de caractères | "Identifiant"      | Oui                 | Nom de la colonne à afficher                                                                                                                                                                                                                                                                                                                            |
+| name           | chaîne de caractères | "id_X"             | Oui                 | nom de la colonne en base de données                                                                                                                                                                                                                                                                                                                    |
+| type           | chaîne de caractères |  - lien  - texte   | Oui                 | Permet d'indiquer le type de représentation pour la donnée de la colonne.  - En tant que texte, le contenu est juste affichée dans la colonne.  - En tant que lien, le contenu est utilisé pour proposer un accès de type lien hypertexte à un document, cela est très utile pour donner l'accès à un document en rapport avec la parcelle par exemple. |
+
+Ci-dessous, un exemple fictif de document JSON pour les intersections d'une fiche d'urbanisme, celle-ci pouvant servir d'exemple :  
+
+```js
+[
+  {
+    "columns": [
+      {
+        "label": "titre",
+        "name": "col_titre",
+      }
+      {
+        "alias": "Réglement",
+        "alias_variable": false,
+        "label": "Lien vers règlement",
+        "name": "lien_reglement",
+        "type": "lien"
+      }
+    ],
+    "schema": "schema1",
+    "table": "table1",
+    "title": "Titre de ma table",
+    "type": "POLYGON"
+  }
+]
+```
\ No newline at end of file

doc/source/administrator/cadastre/config_generale.md

+# Configuration générale
+
+Cette section concerne la configuration générale du module cadastre.  
+Celle-ci est décomposée en 3 parties.  
+
+![conf_generale](../../images/administrator/cadastre/conf_generale.jpg)
+
+## Liste des départements
+
+Cette option est un champ a activer (cocher "Oui" ou "Non").  
+Celle-ci a pour effet d'activer la possibilité de filtrer les données par département.
+
+```{note}
+Cette option utilise la table `s_cadastre`.`departement` afin de fournir la table des départements.
+```
+
+```{figure} ../../images/administrator/cadastre/cadastre_option_departements.jpg
+:alt: module_cadastre_avec_liste_departements
+:align: center
+
+Avec la liste des départements activée
+```
+
+```{figure} ../../images/administrator/cadastre/cadastre_sans_option_departements.jpg
+:alt: module_cadastre_sans_liste_departements
+:align: center
+
+Sans la liste des départements activée
+```
+
+## Projection de la base de données (code EPSG)
+
+Ce champ sert à renseigner le système de la projection de la base de données, afin de projetter les données dans le bon système au niveau de l'application.  
+Le code est sous la forme d'une chaîne de caractère au format EPSG :  
+- EPSG:<numéro du code> (ex: EPSG:2154 pour le Lambert93)
+
+## Base de donnée à utiliser pour les intersections
+
+Ce champ permet de récupérer la base de données qui sera utilisée pour réaliser les intersections des `fiches d'urbanisme` et `fiches descriptives`.  
+
+```{warning}
+La base de données indiquée doit être présente dans le même cluster de base de données Postgres afin que cela fonctionne.  
+Sinon les intersections ne fonctionneront pas.
+```
\ No newline at end of file

doc/source/administrator/cadastre/index.rst

+Module Cadastre
+============================================
+
+--------------
+
+.. Note:: | La configuration du mode cadastre est située dans l'onglet  
+  | Configuration > Configuration vMap > Cadastre.
+  |chemin_conf_cadastre|
+
+.. |chemin_conf_cadastre| image:: ../../images/administrator/cadastre/chemin_config.jpg
+    :width: 200
+    :alt: chemin_configuration_cadastre
+
+Cette section concerne la documentation de la configuration du module Cadastre de vMap.  
+Celui-ci est composé de 3 sous-parties :  
+
+============================================
+
+.. toctree::
+   :maxdepth: 2
+
+   config_generale.md
+   config_fiche_urba.md
+   config_fiche_desc.md

doc/source/administrator/index.rst

@@ -15,3 +15,4 @@ Il est conseillé aux administrateurs de consulter en premier la `Documentation
    configuration/index.rst
    api/api.rst
    journaux.md
+   cadastre/index.rst

doc/source/conf.py

@@ -58,6 +58,10 @@ extensions = [
     'sphinx.ext.viewcode',
 ]
 
+myst_enable_extensions = [
+    "colon_fence"
+]
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']