Utilisateurs

Cher·e·s utilisateur·trice·s,

Vous trouverez sur cette page toutes les informations nécessaires à la bonne utilisation du logiciel. Vous pourrez notamment consulter :

• les dernières mises à jour effectuées sur le logiciel
• une brève notice d'utilisation de la solution logiciel. (sorte de README)

---

1. Historique des mises à jour

05/12/2017 : Réalisation de la première version.
12/01/2018 : Ajout de corrections et rectification de bugs (voir tickets fermés à cette date).

2. Manuel d'utilisation du logiciel

1) Pré-requis

Pour lancer la solution logicielle vous aurez besoin d'avoir installer auparavant node et de disposer des dépendances suivantes. Vous devrez donc exécuter les commandes suivantes :

• npm install caporal
• npm install fs
• npm install colors
• npm install opn

• npm install readline

  2) Utilisation du logiciel

• Pour vérifier que le fichier suis bien son ABNF respectif défini dans le cahier des charges
  node caporalCLI.js check <fichier>
  avec <fichier> un database .txt contenant des contacts</fichier></fichier>

  • Option -s : affiche les symboles à chaque étape
  • Option -t : log the tokenization results
    

• Pour exporter un contact à partir de la base de données vers un fichier vCard
  node caporalCLI.js createVcf <fichier>
  avec <fichier> une base de données en .txt contenant un ou plusieur contacts</fichier></fichier>

• Pour vérifier que le fichier est dans un format vcf valide
  node caporalCLI.js parseVcf <fichier>
  avec <fichier> un fichier en .vcf</fichier></fichier>

• Pour importer un fichier vCard dans la base de données
  node caporalCLI.js import <database> <vcard>
  avec <database> la base de données .txt et <vcard> le fichier au format .vcf
  Si le contact à ajouter est déjà présent dans la base de données il y a possibilité de le remplacer, le fusionner ou l'ajouter tout de même à l'aide d'une vue Google Chart.</vcard></database></vcard></database>

• Pour afficher le nombre de contacts dans la base de données
  node vCardParser.js total

• Pour afficher un contact
  node vCardParser.js find nom prenom
  nom --> nom du contact
  prenom --> prenom du contact
  Si il existe plusieurs contacts avec le même nom, la méthode n'affichera que le premier qui a été ajouté dans la base de données

• Pour afficher la liste de tous les contacts
  node caporalCLI.js display <file> <needle>
  avec <file> la base de données .txt à afficher et <needle> l'objet de la recherche</needle></file></needle></file>

• Option -a : affiche tous les contacts
• Option -d : affiche les contacts qui ont un domaine correspondant à <needle></needle>
• Option -p : affiche les contacts qui ont un nom correspondant à <needle></needle>