From 0d08675181643ab56a79d1e8b4531be587ea2b53 Mon Sep 17 00:00:00 2001
From: Laurent Panabieres <laurent.panabieres@veremes.com>
Date: Tue, 24 Nov 2020 12:56:17 +0100
Subject: [PATCH] Maj doc administration du module anomalie

Maj doc administration du module anomalie
---
 administration/anomalies.md | 44 ++++++++++++++++++++++---------------
 1 file changed, 26 insertions(+), 18 deletions(-)

diff --git a/administration/anomalies.md b/administration/anomalies.md
index 2e64643..cec0e04 100644
--- a/administration/anomalies.md
+++ b/administration/anomalies.md
@@ -1,14 +1,17 @@
 # Module anomalies
 
-Il n'y a pas d'interface d'administration pour le module anomalies mais des propriétés sont disponible dans le fichier:
+Aucune interface d'administration n'a été développée pour le module anomalie.
+L'ensemble des paramètres à éditer sont disponibles dans le fichier :
 /var/www/vmap/vas/rest/conf/anomalies/properties.inc
 
-## Les valeurs dynamique disponibles dans les emails
+Ce fichier permet notamment de configurer le corps des emails qui sont envoyés.
 
-Pour mettre des valeurs dynamique dans un mail il faut faire:
+## Paramètres variables et paramétrables dans les emails
+
+Pour mettre des valeurs dynamiques dans un email il faut utiliser la syntaxe suivante :
 ```{{ anomaly.CLE }}```
 
-Les clées disponibles sont:
+Voici l'ensemble des variables qui peuvent être utilisées dans le corps des emails :
 
 - **anomalies_id** -> Identifiant de l'anomalie
 - **status_id** -> Identifiant du statut de l'anomalie
@@ -19,16 +22,16 @@ Les clées disponibles sont:
 - **theme_short_name** -> Abréviation du nom du thème de l'anomalie
 - **title** -> Titre de l'anomalie
 - **description** -> Description de l'anomalie
-- **files** -> Nom des fichiers ajouté avec le formulaire de l'anomalie
-- **contact** -> Champs contact du formulaire de l'anomalie
+- **files** -> Nom des fichiers ajoutés avec le formulaire de l'anomalie
+- **contact** -> Champ contact du formulaire de l'anomalie
 - **user_id** -> Identifiant de l'utilisateur qui a créé l'anomalie
-- **login** -> Identifiant de connexion de l'utilisateur qui a créé l'anomalie
+- **login** -> Login de l'utilisateur qui a créé l'anomalie
 - **user_name** -> Nom de l'utilisateur qui a créé l'anomalie
 - **user_email** -> Email de l'utilisateur qui a créé l'anomalie
 - **anomalies_date** -> Date de la création de l'anomalie
-- **last_update_date** -> Date de la dernière mise à jour
-- **closing_date** -> Date de clotûre
-- **map_id** -> Identifiant de la carte sur laquel utilisateur était connecté lors de l'ajout de l'anomalie
+- **last_update_date** -> Date de la dernière mise à jour de l'anomalie
+- **closing_date** -> Date de clotûre de l'anomalie
+- **map_id** -> Identifiant de la carte sur laquelle utilisateur était connecté lors de l'ajout de l'anomalie
 - **admin_comment** -> Commentaire de l'administrateur
 
 ## Propriété importante
@@ -37,11 +40,10 @@ Pour que le module fonctionne correctement il est important de définir une vale
 
 ### $properties["anomalies_email_admin"]
 
-Doit contenir l'adresse email de l'administrateur qui recevra les emails
-
-Pas de valeur par défaut
+Doit contenir l'adresse email de l'administrateur qui recevra les emails.
+Aucune valeur par défaut n'a été définie.
 
-## Propriété des objets et contenus des emails pour l'utilisateur
+## Propriété générales des emails
 
 ### $properties["email_object_user_create_anomaly"]
 
@@ -301,7 +303,7 @@ Coordonnées : {{anomaly.user_email}}"
 
 ### $properties["email_object_admin_status_change_anomaly"]
 
-Objet de l'email envoyé à l'administrateur lors le statut de l'anomalie change.
+Objet de l'email envoyé à l'administrateur lorsque le statut de l'anomalie change.
 
 Valeur par défaut:
 
@@ -310,7 +312,7 @@ Valeur par défaut:
 ```
 ### $properties["email_admin_status_change_anomaly"]
 
-Contenu de l'email envoyé à l'administrateur lors le statut de l'anomalie change.
+Contenu de l'email envoyé à l'administrateur lorsque le statut de l'anomalie change.
 
 Valeur par défaut:
 
@@ -326,7 +328,7 @@ Coordonnées : {{anomaly.user_email}}"
 
 ### $properties["email_object_admin_finished_anomaly"]
 
-Objet de l'email envoyé à l'administrateur lors le statut de l'anomalie change pour "Terminer".
+Objet de l'email envoyé à l'administrateur lorsque le statut de l'anomalie change pour "Terminer".
 
 Valeur par défaut:
 
@@ -335,7 +337,7 @@ Valeur par défaut:
 ```
 ### $properties["email_admin_finished_anomaly"]
 
-Contenu de l'email envoyé à l'administrateur lors le statut de l'anomalie change pour "Terminer".
+Contenu de l'email envoyé à l'administrateur lorsque le statut de l'anomalie change pour "Terminer".
 
 Valeur par défaut:
 
@@ -357,6 +359,12 @@ Coordonnées : {{anomaly.user_email}}"
 
 Nombre entre 1 et 24, défini le niveau de zoom maximum.
 
+Valeur permettant de définir le niveau de zoom utilisé lorsqu'un utilisateur consulte (cartographiquement) une anomalie.
+
+Cette valeur est une valeur maximale. Si l'anomalie est de type "multi-point" le centrage cartographique sera réalisé de telle manière à ce que l'ensemble des points soient visibles.
+
+Cette valeur est comprise entre 1 et 24.
+
 Valeur par défaut:
 
 ```
-- 
GitLab