Logbook, un logiciel de gestion de carnet d'écoutes.
====================================================

Ce document est un brouillon pour aider à utiliser logbook dans son état
actuel.  Il suppose malgré tout une certaine connaissance de PostgreSQL, et il
faudra sa documentation pour plus de détails.

Présentation
============
Logbook vous permet de gérer un carnet d'écoutes électronique et de générer des
rapports d'écoutes en quelques secondes, prêts à être envoyés.  En outre, il
peut gérer les rapports de plusieurs personnes: chacun peut y consigner ses
écoutes et générer ses propres rapports.

Logbook est un programme écrit pour mes besoins particuliers et est toujours en
cours de développement.  Bien qu'il ne soit pas à ce titre simplissime à
installer, je le publie cependant, s'il peut être utile à quelqu'un.
Il est un logiciel libre sous licence GPL (voir le fichier COPYING): vous
pouvez l'utiliser à volonté, le modifier et le redistribuer selon les termes
de ce fichier.  Il est écrit en Ruby (http://http://www.ruby-lang.org) et
utilise la base de données PostgreSQL (http://www.postgresql.org), et Ruby/DBI
(http://ruby-dbi.sourceforge.net), qui
sont également des logiciels libres.  Je le développe sur Debian GNU/Linux 3.1
pour PowerPC, mais il devrait fonctionner sur n'importe quel système de type
UNIX (FreeBSD, MacOS X, Linux ...), ainsi que sur Windows grâce à Cygwin
(http://www.cygwin.com).  La fonction d'édition des commentaires nécessite
aussi l'éditeur vi.

Installation
============
Tout d'abord, installer PostgreSQL, Ruby et Ruby/DBI.  Ils sont normalement
disponibles via votre système de packages, sauf peut-être Ruby/DBI.  Sous
Debian, il suffit de taper en root
"apt-get install postgresql ruby1.8 libdbd-pg-ruby1.8"
Si ce n'est pas fait à l'installation, configurer PostgreSQL pour permettre,
et créer un utilisateur dans cette base de données.

ne fois l'archve extraite, il y a 2 répertoires: ruby et sql.  Le répertoire
SQL contient un fichier servant à créer la base de données: aller dans ce
répertoire et taper les commandes suivantes:

createdb logbook
psql logbook -f tables.sql

(ces commandes supposent que PostgreSQL est configuré pour accepter les
connexions locales avec la méthode "ident sameuser"; adaptez-les si ce n'est
pas le cas)

Utilisation
===========
Une fois la base de données créée, il faut se créer un utilisateur auquel
rattacher les écoutes (plusieurs utilisateurs peuvent être créés si nécessaire).
Se connecter à la base de données avec la commande "psql logbook".  Une fois
connecté, créer l'utilisateur en tapant:

insert into table users values('login','prénom','nom','adresse postale','adresse e-mail');

Il faut ensuite créer des catégories de stations (ex: station internationale,
station pirate ...):

insert into s_types(label) values('nom de la catégorie');

De même pour les langues:

insert into languages values('code','nom');

(exemple: insert into languages values('fr','français');

Ensuite, on peut enregistrer toutes les stations et services que l'on écoute.
On ajoute une station avec:

insert into stations(label,stype) values('nom de la station',numéro de type);

où numéro de type est le numéro d'ordre du type de station (1 pour le premier
type entré).

Ensuite, pour chaque station, il faut entrer au moins un service:

insert into services (station,language,label) values(numéro de station,'code de
langue','nom');

où numéro de station est le numéro d'ordre de la station et nom est le nom
complet du service (exemple: 'radio gaga, service français')

(remplacer login, prénom, nom, adresse postale et adresse e-mail par les valeurs
adéquates; il faut taper "\n" pour un retour à la ligne dans l'adresse postale).

Pour se déconnecter de la base de données, taper "\q".

Ensuite, logbook est prêt à être utilisé: aller dans le répertoire ruby de
l'archive.  Si les deux commandes ci-dessus n'ont pas fonctionné, il faudra
d'abord éditer backend.rb et remplacer la chaîne de connexion "DBI:Pg:logbook:"
par la valeur adéquate.

Logbook peut se lancer tout simplement depuis la ligne de commande, sans
options: ./logbook.rb ou ruby logbook.rb.  D'autres options seront expliquées
plus bas.

Tout d'abord, entrer son login (la première valeur entrée lors de la création
de l'utilisateur).  On peut aussi taper son login sur la ligne de commande
du programme en lui passant l'option -u login.  Ensuite, le programme se
présente sous la forme d'un menu arborescent.  Le premier niveau permet de
choisir entre l'entrée de nouvelles écoutes (taper l) et la génération de
rapports (taper r).  Ici encore, il est possible de passer cette étape en
spécifiant les option -l ou -r sur la ligne de commande.  A tout moment, il y a
la commande h pour lister les options disponibles et q pour remonter au niveau
supérieur du menu (ou quitter si on est au niveau le plus élevé.

La génération de rapports est assez simple: elle permet de sélectionner une
station et un de ses services, et de rassembler toutes les écoutes qui n'ont
pas été rapportées dans un rapport au format HTML.

La fonction "carnet d'écoutes" permet de gérer plusieurs écoutes en simultané
pour les zappeurs.  Chaque écoute peut recevoir un identifiant pour la repérer
parmi les autres en cours ou reçoit un numéro automatique si aucun n'est fourni.
Une fois que l'écoute a été créée avec la commande n, on peut passer de l'une à
l'autre, on peut passer de l'une à l'autre avec la commande a.  On peut y
ajouter des informations sur la qualité (sinpo et remarques) avec la commande s,
ajouter au fur et à mesure une description du programme avec la commande c.
Lorsque l'écoute est terminée, ne pas oublier de la sauver avec la commande S.
Une autre écoute, s'il y en a une, devient alors l'écoute courante.