Guide Développeur

Guide Développeur

Organisation du code

1.Fichier nécessaire pour le stockage des données qui seront exploitées par les différents programmes du logiciel :

data.txt : Symbolise la base de donnée en format texte, dans ce fichier se trouve les données de 3 contacts.
log.txt : une fichier censé être vierge au début, où les commits sont écrit à l'intérieur au fur et à mesure que l'utilisateur utilise le logiciel. (Un exemple est déjà l'intérieur pour comprendre son fonctionnement)
README.txt : une fichier texte, qui à permis au développeur-utilisateur, une prise en main plus rapide. En revanche pour une description plus détaillée sur l'utilisation de ce logiciel il est nécessaire de lire le "Guide utilisateur" présent dans le wiki sourceforge du groupe JeVaisScript_GL02.
vCard.vcf : Un fichier contenant tous les contacts en format VCard qui ont pu être exportés de la base de donnée texte grâce notamment à l'utilisation à l'une des fonctionnalités du logiciel.

2.Lib : ensemble de fichiers relatifs aux commandes de la librairie, l'ensemble des commandes du logiciel sous forme de fichier javascript :

ConvertToCard.js : Transfert les données contenues dans le fichier data.txt dans le fichier vcard.vcf. Si l'entrée n'existe pas alors un message d'erreur s'affiche. Dans l'autre cas, le programme va pouvoir parser les données de data.txt par Domaine, Nom, Prénom, ENtreprise, Fonction, Email, Telephone1, Telephone2 et Remarque. Une fois cette opération effectuée les données vont être ajoutées une à une à la fin du fichier VCard "vcard.vsf".
Utilise : Log.js

Delete_prospect.js: Permet de supprimer un prospect, l'entrée indique le prospect que l'on souhaite supprimer de la base de données, et il retourne une erreur s'il y en a une (si l'entrée saisie n'est pas reconnue). Sinon un message apparait indiquant que l'opération c'est bien déroulée.
Utilise : Log.js

Display_data.js : Permet l'affichage de donnée qui sont parser par Domaine, Nom, Prénom, Entreprise, Fonction, Email, Téléphone1, Téléphone2, Remarque.

Field.js : Offre des tableaux avec quelques mots clés qui pourraient être utilisés dans les autres programmes.

Find_repeat.js: Trouve s'il y a une répétition entre deux contacts présent dans la base de donnée. Le programme demande ensuite à l'utilisateur de rentrer un nombre associé au contact qu'il veut supprimer. Le dernière étape de ce programme est l'exportation des contacts non-supprimé dans une autre fichier spécifié.
Utilise : Log.js et Read_Vcard_file.js, Write_to_bp.js

Log.js: Ce programme permet le changement de format de la date concernée en format YYYY:MM:DD:HH:MM:SS. Ensuite il prendra en compte les différents ajouts ou suppresions de contacts qui ont été effectué dans les programmes faisant appel à ce programme. Si il y a une erreur dans les parametres d'entrés, un message d'erreur est alors affiché. Sinon il écrit bien les informations de notification de suppression ou d'ajout dans la fichier log.txt.

Read_Vcard_file.js: Ce programme est utilisé pour lire les fichiers .vcf (VCard). Premierement le programme va vérifier si le fichier existe ou non. Ensuite s'il existe le programme va vérifier si le format de données ne contient pas d'erreur. Si il y a une erreur le programme va afficher les éléments manquant requis (TITLE) ou si il trouve des champs invalides(N).
Utilise : Field.js 

Recherche_attributs.js: Créer premierement la liste de 5 contacts présent dans le programme. Ensuite une fonction demande de saisir le critère de recherche de l'utilisateur pour faire sa recherche par attribut suivant : nom, prenom, entreprise, fonction, email, telephone1, telephone2, remarque
Après ça le programme demande à l'utilisateur de rentrer sa recherche précise, ensuite une liste de contacts contenant l'attribut spécifié pourrat être affichée. Si il y a une erreur, un affichage prévient l'utilisateur qu'aucun prospect ne contient le mot clé spécifié par l'utilisateur. Ou un affichage qui demande si l'utilisateur a bien rentrer un type d'attribut existant.

Tri.prospect.js : Ce programme a pour fonction de trier les données des contacts contenues dans le programme. Dans ce cas il y en a 5 qui seront triées par Nom d'entreprise et pas Nom de contact. L'utilisateur peut entrer "byname" pour avoir juste la liste des noms triée ou entrer "byentreprise" pour avoir juste la liste des noms d'entreprises triées.

Type.js : Est util pour demander à l'utilisateur de rentrer un ou plusieurs "Nom Prenom" pour pouvoir exporter les contacts correspondant dans un format VCard.

Vcf_to_bp.js: Sert de convertisseur des données dans la forme texte de BaseProspect, puis l'écrire dans le fichier data.txt servant de support pour BaseProspect. Enfin le commit est envoyé dans le fichier log.txt.
Utilise : Log.js , Recherche_attributs.js, Read_Vcard_file.js, Write_to_bp.js

Write_to_bp.js : Offre la fonction qui est utilisée par le programme vcf_to_bp.js
Utilise : Read_Vcard_file.js

3.LICENCE.txt : informations relatives à la license d'exploitation de la librairie