up doc

docs/configuration_de_conversion.md

@@ -0,0 +1,50 @@
+# Configuration de conversion
+
+Ce fichier de configuration est utilisé pour convertir un jeu de données ouvertes en des données exploitables par des tags OpenStreetMap. Il décrit les règles de conversion pour chaque propriété des données ouvertes et les valeurs attendues pour chaque tag OpenStreetMap.
+
+Structure du fichier de configuration
+
+Le fichier de configuration est un objet JSON du type MappingConfigType qui contient les propriétés suivantes :
+
+    config_name : le nom de la configuration
+    config_author : le nom de l'auteur de la configuration avec son email entre chevrons
+    source : infos sur la provenance des données à convertir, contient deux propriétés:
+        geojson_path: lien relatif dans ce dépôt vers le fichier téléchargé
+        url: lien absolu de la source, sur le portail datagouv par exemple
+    add_not_mapped_tags_too : un boolean indiquant si les tags non détectés par la configuration doivent être ajoutés également aux points convertis. false: on enlève tout ce qui n'est pas mentionné dans la propriété "tags" de ce fichier de configuration.
+    default_properties_of_point : un objet qui décrit les clés et valeur par défaut à mettre pour les points. exemple: amenity : restaurant.
+    filters : un objet qui décrit les filtres à appliquer aux données ouvertes.
+        enable_coordinates_filter: booléen, permet d'activer un filtre sur les points se trouvant dans certaines coordonnées. La description des restrictions se fait dans une sous clé "properties". 
+            properties: objet listant colonne et expression régulières pour ne garder que ce qui correspond.
+            bounding_box: tableau décrivant un rectangle de coordonnées: Xstart Ystart Xend Yend.
+        enable_properties_filter: objet décrivant les regex à chercher sur certaines colonnes pour ne garder que les objets concernés. Pour ne trouver que les points dont le code postal dans la colonne consolidated_code_postal commence par 76 ou 27, on écrira : consolidated_code_postal: '^[76|27]'
+    tags : un objet qui décrit les règles de conversion pour chaque tag OpenStreetMap. C'est ici que l'on dispose d'une grande flexibilité de règles de conversion pratiques détaillées dans la section suivantes.
+
+
+
+# Propriétés de conversion des tags
+
+Chaque clé donne une colonne du jeu de données à convertir en tag OSM, soit en conservant la valeur si on lui donne une simple chaîne de caractères en valeur, soit en lui apportant des modifications plus précises avec un objet en valeur.
+
+Par exemple, nous avons un jeu de données sur les bornes de recharge électriques et leur numéro de SIREN est donné dans une colonne "siren_amenageur", dans OSM on utilisera une clé 'owner:ref:FR:SIREN'.
+
+```json
+{
+  "config_name": "IRVE config",
+  "tags": {
+    "siren_amenageur": "owner:ref:FR:SIREN"
+  }
+}
+```
+Ce qui équivaut à une utilisation d'objet ainsi
+```json
+{
+  "config_name": "IRVE config",
+  "tags": {
+    "siren_amenageur": {
+      "key_converted":"owner:ref:FR:SIREN" 
+    }
+  }
+}
+```
+