Merge pull request #88 from PnX-SI/update-doc-import

SIPAF - Update doc Import

README.md

@@ -2,14 +2,13 @@
 
 ## Présentation
 
-Ce module donne accès à des outils qui permettent de créer des sous-module geonature.
-
+Ce module donne accès à des outils qui permettent de créer des sous-module GeoNature.
 
 Les modules sont listés sur la page d'accueil du module `modulator`.
 
-Un exemple de sous-module est le module `m_sipaf` pour les passage à faune:
+Un exemple de sous-module est le module `m_sipaf` pour les passages à faune :
 
-- page d'accueil du module `m_sipaf` avec une carte, liste et filtres les objets du sous-module :
+- page d'accueil du module `m_sipaf` avec une carte, liste et filtres des objets du sous-module :
 
 ![image](https://user-images.githubusercontent.com/4418840/217202599-44988f09-2651-49b4-966a-623d7abdcab9.png)
 
@@ -19,7 +18,7 @@ Un exemple de sous-module est le module `m_sipaf` pour les passage à faune:
 
 ## Installation
 
-Compatible avec la version 2.13.0 (et plus) de GeoNature.
+Compatible avec la version 2.13 de GeoNature.
 
 - Téléchargez le module dans ``/home/<myuser>/``, en remplacant ``X.Y.Z`` par la version souhaitée
 
@@ -58,7 +57,7 @@ sudo systemctl restart geonature
 Cette commande : 
 - installe le module python
 - le module dans la base de données
-- fait les migrations
+- applique les migrations
 - copie le dossier de configuration du sous-module dans le dossier `/backend/media/modulator/config` de GeoNature
 
 Pour mettre à jour un sous-module, il faut relancer sa commande d'installation.
@@ -68,17 +67,13 @@ Le formalisme pour les codes des sous-modules est le suivante :
 - prefixé par `m_`
 - par exemple `m_sipaf`
 
-Des sous-modules sont déjà présents dans le dossier
-`/config/modules/contrib` :
-
-- Le module SIPAF (passages à faune) :   
-   - `geonature modulator install -p ./contrib/m_sipaf`
-
-par exemple pour le module `m_sipaf`
+Des sous-modules sont déjà présents dans le dossier `/config/modules/contrib` :
 
-```bash
-geonature modulator install -p <chemin vers gn_modulator>/contrib/m_sipaf
-```
+- Installation du module SIPAF (passages à faune) :
+
+  ```bash
+  geonature modulator install -p <chemin vers gn_modulator>/contrib/m_sipaf
+  ```
 
 ### Mise à jour
 
@@ -113,9 +108,10 @@ Relancer la commande d'installation du module
 
 ```
 geonature modulator install -p <chemin vers le sous-module>
+```
 
 ## Développement
 
 ## Création d'un sous-module
 
-[Documentation sur la création de sous module](./doc/creation_module.md)
+[Documentation sur la création d'un sous-module](./doc/creation_module.md)

contrib/m_sipaf/doc/import.md

@@ -2,7 +2,7 @@
 
 ## Définition des champs
 
-[Définition des champs](./import_description_champs.md)
+[Définition des champs](./import_passage_faune_description_champs.md)
 
 Le champs `uuid_passage_faune` permet d'identifier de maniere unique un passage à faune.  
 La colonne `uuid_passage_faune` doit être présente dans le fichier d'import même si les valeurs ne sont pas renseignées.
@@ -11,6 +11,8 @@ Si la valeur est nulle, une valeur sera générée par défaut. Cependant il ser
 
 Il est donc conseillé de fournir une valeur pour ce champs.
 
+Pour les champs avec des relations multiples (un PAF peut avoir plusieurs acteurs, un PAF peut avoir plusieurs usages), il est possible d'importer ces informations. Pour cela, il faut dupliquer les lignes des PAF concernés en modifiant uniquement ce champs. Par exemple, si un PAF a 2 acteurs, alors ce PAF sera présent 2 fois dans le fichier importé avec un acteur différent à chacune des 2 lignes.
+
 ## Exemples de fichiers
 
 - [Exemple simple](/backend/gn_modulator/tests/import_test/pf_simple.csv)
@@ -62,13 +64,13 @@ Il faudra revoir et corriger les données pour pouvoir reprocéder à l'import.
 
 ![Validation de l'import](img/erreur_import.png)
 
-### Options additionelles
+### Options additionnelles
 
 - `Verifier avant insertion`
   - décocher pour passer à l'étape de vérification des données et ne plus avoir à valider une fois le fichier chargé
 - `Autoriser les mises à jour`
   - par défaut les mises à jour ne sont pas autorisées
   - appuyer sur cette case pour pouvoir mettre à jour des données à partir de leur UUID
 - `SRID`
-  - par défaut le SRID (système de projection des coordonées) est `4326`
+  - par défaut le SRID (système de projection des coordonnées) est `4326`
     - vous pouvez préciser un SRID différent pour le fichier