Recent changes to Guide utilisateur

Guide utilisateur modified by GILBERT

GILBERT — Fri, 13 Jan 2017 21:43:39 -0000

--- v2
+++ v3
@@ -1,4 +1,13 @@
 # Guide utilisateurs
+
+## Lancement de l'application
+
+Afin de lancer l'application, allez sous le répertoire trunk du proejt. Executez le programme Javascript avec node dans votre console de la manière suivante:
+node launch.js
+
+Cette commande permet d'afficher les commandes disponibles.
+Pour lancer une commande effectuez la commande suivante:
+node launch.js [nom commande] [params commande]

 ## Commandes

@@ -6,18 +15,18 @@

 Commande: import "chemin fichier .bp ou .vcf"

-La commande import permet l'importation d'un fichier .bp ou .vcf dans l'application. Ce fichier est chargé dans le fichier json de l'application situé dans le répertoire /trunk/data/data.json.
+La commande "import" permet l'importation d'un fichier .bp ou .vcf dans l'application. Ce fichier est chargé dans le fichier json de l'application situé dans le répertoire /trunk/data.
 Si l'importation est réussie, vous obtenez un message de succès dans votre console.
 Si l'importation a échoué, un message d'erreur vous avertit de l'erreur rencontrée lors du parcours des données du fichier.

-ATTENTION: Lors de l'importation d'un fichier, les anciennes données contenues dans le fichier json sont écrasées. Pensez donc si ce n'est pas fait à réaliser un export de vos données si vous désirer importer un nouveau fichier de données.
-Si vous souhaitez ajouter des données à votre fichier json déjà existant, veuillez utiliser la commande update.
+ATTENTION: Lors de l'importation d'un fichier, les anciennes données contenues dans le fichier json sont écrasées. Pensez donc si ce n'est pas fait à réaliser un export de vos données si vous désirez importer un nouveau fichier de données.
+Si vous souhaitez ajouter des données à votre fichier json déjà existant, veuillez utiliser la commande "update".

 ### 2. Exportation des données :

 Commande : export « chemin fichier .bp ou .vcf »

-La commande export permet d’exporter les données de la base de données json sous un fichier sous le format .bp ou .vcf.
+La commande export permet d’exporter les données de la base de données json dans un fichier sous le format .bp ou .vcf.
 Si l’exportation de fichier est réussie, le fichier de destination contenant les données est créé.
 Si l’exportation de fichier échoue, un message d’erreur est affiché en console.

@@ -27,12 +36,13 @@
 Commande : update « chemin du fichier.vcf »

 La commande update permet de mettre à jour les données de la base json à partir des données d’un export .vcf. Cette commande peut prendre en option le paramètre –f qui permet de faire une comparaison des données à mettre à jour automatiquement.
-En absence de ce paramètre, la mise à jour des données se fait manuellement dans le fichier update.txt dans le répertoire /trunk/data. Le fichier est créé lors du lancement de la commande, l’utilisateur choisit ensuite dans ce fichier les paramètres qu’il veut sauvegarder et mettre à jour. Il lance ensuite la commande ApplyUpdate qui permet de prendre en compte les modifications de ces données (cette partie n’a pas été implémentée par manque de temps).
+En absence de ce paramètre, la mise à jour des données se fait manuellement dans le fichier update.txt dans le répertoire /trunk/data. Le fichier est créé lors du lancement de la commande, l’utilisateur choisit ensuite dans ce fichier les données qu’il veut sauvegarder et mettre à jour. Il lance ensuite la commande ApplyUpdate qui permet de prendre en compte les modifications de ces données (cette partie n’a pas été implémentée par manque de temps).

-Avec le paramètre –f la mise à jour des données se fait de manière automatique. Les données de références sont celles contenues dans l’export .vcf. Ces données mettent à jour automatiquement le fichier json de l’application.
+Avec le paramètre –f, la mise à jour des données se fait de manière automatique. Les données de référence sont celles contenues dans l’export .vcf. Ces données mettent à jour automatiquement le fichier json de l’application. A chaque exécution de cette commande, le fichier de suivi des mises à jour est complété avec les données mises à jour et la date de la mise à jour.

 ### 4. Consultation des mises à jour des données

 Commande : Display_updates

 La commande Display_updates permet d’afficher les données contenues dans le fichier de suivi de mises à jour dans la console.
+Cette commande retourne une erreur si le fichier de mise à jour n'est pas existant.

Guide utilisateur modified by GILBERT

GILBERT — Fri, 13 Jan 2017 21:07:47 -0000

--- v1
+++ v2
@@ -1,6 +1,6 @@
 # Guide utilisateurs

-## Commande
+## Commandes

 ### 1. Importation des données : 

@@ -13,58 +13,26 @@
 ATTENTION: Lors de l'importation d'un fichier, les anciennes données contenues dans le fichier json sont écrasées. Pensez donc si ce n'est pas fait à réaliser un export de vos données si vous désirer importer un nouveau fichier de données.
 Si vous souhaitez ajouter des données à votre fichier json déjà existant, veuillez utiliser la commande update.

-### 3. Exportation des données :
+### 2. Exportation des données :
+
+Commande : export « chemin fichier .bp ou .vcf »
+
+La commande export permet d’exporter les données de la base de données json sous un fichier sous le format .bp ou .vcf.
+Si l’exportation de fichier est réussie, le fichier de destination contenant les données est créé.
+Si l’exportation de fichier échoue, un message d’erreur est affiché en console.

-Contient les commandes du logiciel sous forme de fichier javascript. Le dossier contient :
-   **export.js :** commande d’exportation des contacts dans la database du logiciel an format vcf ou BaseProspect.
-   **Import.js :** commande d’importation de contacts au format vcf ou BaseProspect dans la database du logiciel  
-   **Update.js :** commande permettant de contient l'ensemble des commandes du logiciel sous forme de fichier javascript. 
-### 2. data : 
-Regroupe les données sauvegardées par l’application.
-### 3. doc : 
-Contient le README du projet et autres documentations sur le projet.
-   **README.txt :** donne un bref descriptif du projet avec sa licence, les auteurs du projet, et un aperçu des fonctionnalités du logiciel.
-### 4. modules : 
-Regroupe les fichiers relatifs aux parsers et aux commandes. Le dossier contient :
-   **BaseProspectParser.js :** Parser pour les fichiers d’extension BaseProspect.
-   **Command.js :** Permet d’identifier les différentes commandes utilisées dans le logiciel.
-   **ParseError.js :** Permet de gérer les erreurs de parser.
-   **VCardParser.js :** Parser pour les fichiers d’extension vcf.
-### 5. node_modules : 
-Regroupe les fichiers relatifs aux modules de node.js. Se référer à la documentation de node.js.
-### 6. test : 
-Regroupe l'ensemble des fichiers de test des différentes commandes.
-### 7. **launch.js :** 
-Interface du logiciel permettant de lancer les différentes commandes.
-### 8. **LICENSE.md :** 
-Informations relatives à la license d'exploitation du projet.
+### 3. Mise à jour des données

-## Fonctionnalités des commandes
+Commande : update « chemin du fichier.vcf »

-### Launch.js
-L’interface « launch.js » regroupe les 3 commandes « export.js », « import.js » et « update.js ». Si aucun paramètre n’est rentré, La liste des commandes et leur fonction sont affichés dans la console. 
-Si le paramètre rentré est une des 3 commandes et qu’il est accompagné par un ‘/ ?’, un message d’aide correspondant à la commande s’affiche (le message n’est, pour l’instant, pas crée). 
-Si le paramètre rentré n’est pas une des 3 commandes, la console affiche une erreur : « Commande inexistante ».
-Si le paramètre est une des 3 commandes sans la compagnie d’un ‘/ ?’, cette commande est lancée.   
-Export.js 
-Pour le bon fonctionnement de la commande export.js, il faut, dans un premier temps, « require » le module « fs », « command.js », « BaseProspectParser.js » et « VCardParser.js ». 
-De plus, il faut avoir les contacts enregistrés dans le dossier « data » dans le fichier « data.json ».  Nous devons rentrer en paramètre de cette fonction la destination de l’exportation et son extension .bp ou .vcf. Nous pouvons aussi rentrer en paramètre la liste de contacts à exporter. Nous avons donc une ligne de commande sous la forme :  'export <destination path="" (.bp="" or="" .vcf)=""> [-p="prenom nom ; prenom nom ; ..."]'. 
-Si l’extension choisie ne correspond ni à .bp ou .vcf, un message d’erreur s’affiche « Invalid file extension ».
-Si des contacts sont en paramètre, nous allons parcourir le fichier « data.json » pour rechercher les contacts correspondants. Seuls les contacts correspondants seront exportés sous l’extension désirée. Si aucun contact ne correspond, la console affiche « Aucun contact à exporter ». Si aucun contacts n’est en paramètre, tous les contacts présent dans le fichier « data.json » seront exportés.
-Le parser BaseProspect ou VCard s’occupe alors de convertir les données. 
+La commande update permet de mettre à jour les données de la base json à partir des données d’un export .vcf. Cette commande peut prendre en option le paramètre –f qui permet de faire une comparaison des données à mettre à jour automatiquement.
+En absence de ce paramètre, la mise à jour des données se fait manuellement dans le fichier update.txt dans le répertoire /trunk/data. Le fichier est créé lors du lancement de la commande, l’utilisateur choisit ensuite dans ce fichier les paramètres qu’il veut sauvegarder et mettre à jour. Il lance ensuite la commande ApplyUpdate qui permet de prendre en compte les modifications de ces données (cette partie n’a pas été implémentée par manque de temps).

-### Import.js
-Pour le bon fonctionnement de la commande import.js, il faut, dans un premier temps, « require » le module « fs », « command.js », « BaseProspectParser.js » et « VCardParser.js ».
-Nous devons rentrer en paramètre de cette fonction le chemin menant au fichier .bp ou .vcf que nous voulons importer. 
-Si l’extension choisie ne correspond ni à .bp ou .vcf, un message d’erreur s’affiche « Invalid file extension ».
-Le parser correspondant devrait donc se lancer. Si les données ne correspondent pas à l’extension du fichier ou sont corrompues, un message d’erreur s’affiche : "Le fichier n'est pas valide : essayer d'importer un autre fichier." 
-Sinon, l’écriture des données est envoyée par le parser dans le fichier « date.json » et un message confirmant le bon déroulement de l’opération s’affiche :  "L'importation s'est déroulée sans problème."
+Avec le paramètre –f la mise à jour des données se fait de manière automatique. Les données de références sont celles contenues dans l’export .vcf. Ces données mettent à jour automatiquement le fichier json de l’application.

-### Update.js
-Pour le bon fonctionnement de la commande import.js, il faut, dans un premier temps, « require » le module « fs », « command.js », « BaseProspectParser.js » et « VCardParser.js ».
+### 4. Consultation des mises à jour des données

+Commande : Display_updates

-## Pistes d’évolution
-
-Le logiciel peut, bien évidemment, encore être améliorer. Il manque beaucoup de fonctionnalités. Nous pouvons, par exemple, modifier le parser de fichier vCard (VCardParser.js) en utilisant une librairie : vcards-js. Une grande amélioration possible seraient une interface graphique.
+La commande Display_updates permet d’afficher les données contenues dans le fichier de suivi de mises à jour dans la console.

Guide utilisateur modified by GILBERT

GILBERT — Fri, 13 Jan 2017 20:39:08 -0000

Guide utilisateurs

Commande

1. Importation des données :

Commande: import "chemin fichier .bp ou .vcf"

La commande import permet l'importation d'un fichier .bp ou .vcf dans l'application. Ce fichier est chargé dans le fichier json de l'application situé dans le répertoire /trunk/data/data.json.
Si l'importation est réussie, vous obtenez un message de succès dans votre console.
Si l'importation a échoué, un message d'erreur vous avertit de l'erreur rencontrée lors du parcours des données du fichier.

ATTENTION: Lors de l'importation d'un fichier, les anciennes données contenues dans le fichier json sont écrasées. Pensez donc si ce n'est pas fait à réaliser un export de vos données si vous désirer importer un nouveau fichier de données.
Si vous souhaitez ajouter des données à votre fichier json déjà existant, veuillez utiliser la commande update.

3. Exportation des données :

Contient les commandes du logiciel sous forme de fichier javascript. Le dossier contient :
export.js : commande d’exportation des contacts dans la database du logiciel an format vcf ou BaseProspect.
Import.js : commande d’importation de contacts au format vcf ou BaseProspect dans la database du logiciel
Update.js : commande permettant de contient l'ensemble des commandes du logiciel sous forme de fichier javascript.

2. data :

Regroupe les données sauvegardées par l’application.

3. doc :

Contient le README du projet et autres documentations sur le projet.
README.txt : donne un bref descriptif du projet avec sa licence, les auteurs du projet, et un aperçu des fonctionnalités du logiciel.

4. modules :

Regroupe les fichiers relatifs aux parsers et aux commandes. Le dossier contient :
BaseProspectParser.js : Parser pour les fichiers d’extension BaseProspect.
Command.js : Permet d’identifier les différentes commandes utilisées dans le logiciel.
ParseError.js : Permet de gérer les erreurs de parser.
VCardParser.js : Parser pour les fichiers d’extension vcf.

5. node_modules :

Regroupe les fichiers relatifs aux modules de node.js. Se référer à la documentation de node.js.

6. test :

Regroupe l'ensemble des fichiers de test des différentes commandes.

7. launch.js :

Interface du logiciel permettant de lancer les différentes commandes.

8. LICENSE.md :

Informations relatives à la license d'exploitation du projet.

Fonctionnalités des commandes

Launch.js

L’interface « launch.js » regroupe les 3 commandes « export.js », « import.js » et « update.js ». Si aucun paramètre n’est rentré, La liste des commandes et leur fonction sont affichés dans la console.
Si le paramètre rentré est une des 3 commandes et qu’il est accompagné par un ‘/ ?’, un message d’aide correspondant à la commande s’affiche (le message n’est, pour l’instant, pas crée).
Si le paramètre rentré n’est pas une des 3 commandes, la console affiche une erreur : « Commande inexistante ».
Si le paramètre est une des 3 commandes sans la compagnie d’un ‘/ ?’, cette commande est lancée.
Export.js
Pour le bon fonctionnement de la commande export.js, il faut, dans un premier temps, « require » le module « fs », « command.js », « BaseProspectParser.js » et « VCardParser.js ».
De plus, il faut avoir les contacts enregistrés dans le dossier « data » dans le fichier « data.json ». Nous devons rentrer en paramètre de cette fonction la destination de l’exportation et son extension .bp ou .vcf. Nous pouvons aussi rentrer en paramètre la liste de contacts à exporter. Nous avons donc une ligne de commande sous la forme : 'export <destination path="" (.bp="" or="" .vcf)=""> [-p="prenom nom ; prenom nom ; ..."]'.
Si l’extension choisie ne correspond ni à .bp ou .vcf, un message d’erreur s’affiche « Invalid file extension ».
Si des contacts sont en paramètre, nous allons parcourir le fichier « data.json » pour rechercher les contacts correspondants. Seuls les contacts correspondants seront exportés sous l’extension désirée. Si aucun contact ne correspond, la console affiche « Aucun contact à exporter ». Si aucun contacts n’est en paramètre, tous les contacts présent dans le fichier « data.json » seront exportés.
Le parser BaseProspect ou VCard s’occupe alors de convertir les données.

Import.js

Pour le bon fonctionnement de la commande import.js, il faut, dans un premier temps, « require » le module « fs », « command.js », « BaseProspectParser.js » et « VCardParser.js ».
Nous devons rentrer en paramètre de cette fonction le chemin menant au fichier .bp ou .vcf que nous voulons importer.
Si l’extension choisie ne correspond ni à .bp ou .vcf, un message d’erreur s’affiche « Invalid file extension ».
Le parser correspondant devrait donc se lancer. Si les données ne correspondent pas à l’extension du fichier ou sont corrompues, un message d’erreur s’affiche : "Le fichier n'est pas valide : essayer d'importer un autre fichier."
Sinon, l’écriture des données est envoyée par le parser dans le fichier « date.json » et un message confirmant le bon déroulement de l’opération s’affiche : "L'importation s'est déroulée sans problème."

Update.js

Pour le bon fonctionnement de la commande import.js, il faut, dans un premier temps, « require » le module « fs », « command.js », « BaseProspectParser.js » et « VCardParser.js ».

Pistes d’évolution

Le logiciel peut, bien évidemment, encore être améliorer. Il manque beaucoup de fonctionnalités. Nous pouvons, par exemple, modifier le parser de fichier vCard (VCardParser.js) en utilisant une librairie : vcards-js. Une grande amélioration possible seraient une interface graphique.