======================
INFO DÉBILE - AIDE
Auteur: Charles Leduc
Mise à jour: juin 2021
======================

Ojectif:
========
Retrouver les données de débit du site du CEHQ (Centre d'Expertise Hydrique du Québec)
et générer une page web d'information des débits courants.


Installation - pré-requis: Apache Ant
=====================================
1. Installer l'application ANT (Apache Ant) sur votre ordinateur
  1A. Obtenir la distribution de ant
      Rechercher dans Google: "apache ant download zip"
      Va vous conduire ici: https://www.apache.org/dist/ant/binaries/ ou équivalent
      Télécharger le fichier ZIP le plus récent: exemple
  1B. Extraire le contenu du fichier ZIP dans un répertoire de votre choix
      Recommandation: utiliser un répertoire sans espaces dans le nom
      Exemple: C:\apache-ant-1.9.7\
  1C. Définir la variable d'environnement ANT_HOME
      Depuis l'explorateur de fichiers Windows ou le Panneau de Contrôle (Control Panel):
      System, Advanced System Settings, Environment Variables, System Variables (section du bas), New
      Nom:    ANT_HOME
      Valeur: C:\apache-ant-1.9.7\
  1D. Ajouter la commande "ant" à votre "path" (chemin d'accès)
      Modifier la variable d'environnement "PATH" ou "Path"
      Même endroit que pour ANT_HOME
      Ajouter le répertoire "bin" de votre installation de apache-ant (séparé par un point-virgule)
      Exemple:
      AVANT: %systemroot%\system32;%systemroot%
      APRÈS: %systemroot%\system32;%systemroot%;C:\apache-ant-1.9.7\bin
         ou: %systemroot%\system32;%systemroot%;%ant_home%\bin
  1E. Tester la fonctionnalité
      - Ouvrir une NOUVELLE fenêtre Ligne de Commande (Démarrer, Accessoires, Ligne de Commande)
      - taper la commande "ant -version"
        C:\>ant -version
        Apache Ant(TM) version 1.9.2 compiled on July 8 2013 <== SUCCES

        C:\>ant -version
        'ant' is not recognized as an internal or external command, operable program or batch file. <== ECHEC
  1F. Aller chercher le fichier JAR de jsch sur http://www.jcraft.com/jsch/
      et mettre ce fichier dans le répertoire de ANT\lib (C:\apache-ant-1.9.7\lib)
      Optionnel: pre-requis pour automatiser le transfert du fichier généré vers un serveur web
 

Installation - InfoDébile
=========================
2. Installer l'application INFODEBILE sur votre ordinateur
  2A. Obtenir le fichier archive (ZIP) d'INFODEBILE, disponible sur http://www.cartespleinair.org/Canot/cartes.html
  2B. Extraire le contenu dans un répertoire de votre choix
      Ex: C:\Users\Zoumba Louche\Documents\Canot\INFODEBILE
  2C. Editer le fichier ServeurFtp.properties: il sert à spécifier (optionnellement) le serveur (nom, réperoire, user, password)
      sur lequel sera uploadé le fichier résultant infodebile.html avec la commande "ant html-scp".
  

Utilisation - page HTML générée
===============================
  3A. Ouvrir une fenêtre Ligne de Commande (Démarrer, Accessoires, Ligne de Commande)
      Se déplacer dans le répertoire d'INFODÉBILE
      cd C:\Users\Zoumba Louche\Documents\Canot\INFODEBILE
      (truc: copier le nom de répertoire depuis votre explocateur de fichiers, dans la barre d'adresse)
      (truc: coller dans la fenêtre "ligne de commande", avec le bouton droit de la souris)
  3B. Taper la commande "ant -p" pour obtenir la liste des commandes (cibles) disponibles
      C:\Users\Zoumba Louche\Documents\Canot\INFODEBILE>ant -p
      Buildfile: C:\Users\Zoumba Louche\Documents\Canot\INFODEBILE\build.xml

Main targets:

 all                     Toutes les etapes en une seule commande
 clean                   1. Nettoyer les donnees anciennes
 genere-html             4. Generer la page web
 genere-xml              3. Generer un fichier XML des sections de rivieres avec debit
 get-cehq-realtime-data  2. Retrouver les donnees recentes de debit du CEHQ
 help                    Aide

  3C. Pour générer la page des débits, taper la commande "ant all", ou simplement "ant"
      Le fichier HTML est généré sous le répertoire d'INFODEBILE
  3D. (en cas d'erreur seulement)
      il est possible que votre système n'ait pas la commande 'awk', si c'est le cas, il y aura un message d'erreur mentionnant la commande awk ou gawk.
      verifier le nom exact avec la commande 'which', ou l'option '-version'
      Exemples:
      which awk
      which gawk
      awk -version
      gawk -version
      Une fois la commande trouvée, éditer le fichier build.xml, chercher 'awk' et y mettre la bonne commande selon votre système.
  3E. Ouvrir le fichier HTML généré à l'aide d'un navigateur web (Firefox, Chrome, Safari, Internet Explorer, etc)
      Et admirer le résultat.
  3F. La commande infodebile.bat donne le même résultat, utiliser cette commande par exemple pour automatiser la génération périodique des 
      infos de débits.  Via le Task Scheduler (Planificateur de Tâches) de Windows.


Dehors!
=======
4. Ne plus niaiser devant l'ordinateur, aller pagayer la rivière de votre choix !

