@database GestaCompte Livre ARexx.guide
@Master "Livre20ARexx.guide"

@author "A.F.L.E. - ©copyright 1998"
@$VER: GestaCompte Livre V2.0 (01.01.98)

@font GastonShell.font 10

@Node Main "GestaCompte Livre 2.0 - Commandes ARexx"

 @{u}@{i}Interface ARexx @{ui}@{uu}

 Grâce à son Interface  ARexx@{fg shine}  GestaCompte  Livre  V2.0 @{fg text} peut  non  seulement
 exécuter ses propres scripts et ainsi optimiser certaines tâches mais il est
 ouvert à d'autres logiciels ayant eux aussi une Interface ARexx.

 Ainsi vous pouvez importer/exporter des données vers un traitement de texte,
 un tableur, une base de données, etc....


 @{u}@{i}Commandes ARexx @{ui}@{uu}

 Le nombre de commandes ARexx implantées dans GestaCompte Livre V2.0  est  de
 23.

 @{" ACCOUNT    " Link "a"}   @{" EXPORTDATA ASCII " Link "g"}   @{" NUMBACCOUNTS   " Link "m"}   @{" SHOWYEAR   " Link "s"}
 @{" CHECK      " Link "b"}   @{" EXPORTDATA GEST  " Link "h"}   @{" NUMBOPERATIONS " Link "n"}   @{" TREAT      " Link "t"}
 @{" DELACCOUNT " Link "c"}   @{" IMPORTDATA       " Link "i"}   @{" OPERATION      " Link "o"}   @{" WAIT       " Link "u"}
 @{" DELCHECK   " Link "d"}   @{" LOAD             " Link "j"}   @{" QUIT           " Link "p"}   @{" WRITECHECK " Link "v"}
 @{" DELETE     " Link "e"}   @{" MONTH            " Link "k"}   @{" SAVE           " Link "q"}   @{" YEAR       " Link "w"}
 @{" DISPLAY    " Link "f"}   @{" NEWACCOUNT       " Link "l"}   @{" SHOWMONTH      " Link "r"}

@EndNode
@Node a "Commandes ARexx"

 @{fg shine}Commande@{fg text}     ACCOUNT@{i} position du compte @{ui}

 @{fg shine}Description@{fg text}  Retourne le texte du libellé indiqué.

 @{fg shine}Variable@{fg text}     @{i}position du compte @{ui}: valeur numérique.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= compte sous forme d'une chaîne de caractères (maxi 40).

@EndNode
@Node b "Commandes ARexx"

 @{fg shine}Commande@{fg text}     CHECK @{i}position @{ui}

 @{fg shine}Description@{fg text}  Met ou enlève le drapeau qui indique si  la  transaction  doit
              être exportée.

 @{fg shine}Variable@{fg text}     @{i}position @{ui}: expression numérique.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= Non défini.

@EndNode
@Node c "Commandes ARexx"

 @{fg shine}Commande@{fg text}     DELACCOUNT @{i}position du compte @{ui}

 @{fg shine}Description@{fg text}  Supprime le libellé de la liste des comptes.

 @{fg shine}Variable@{fg text}     @{i}position du compte @{ui}: valeur numérique (indique la position  du
              compte dans la liste).

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= Non défini.

@EndNode
@Node d "Commandes ARexx"

 @{fg shine}Commande@{fg text}     DELCHECK @{i}position @{ui}

 @{fg shine}Description@{fg text}  Marque la transaction comme n'étant pas encore  importée  dans
              le module comptabilité.

 @{fg shine}Variable@{fg text}     @{i}position @{ui}: expression numérique.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= Non défini.

@EndNode
@Node e "Commandes ARexx"

 @{fg shine}Commande@{fg text}     DELETE @{i}position @{ui}

 @{fg shine}Description@{fg text}  Supprime une transaction.

 @{fg shine}Variable@{fg text}     @{i}position @{ui}: expression numérique.

 @{fg shine}Résultats@{fg text}    RC=0
              Result= Non défini.

@EndNode
@Node f "Commandes ARexx"

 @{fg shine}Commande@{fg text}     DISPLAY

 @{fg shine}Description@{fg text}  Bascule le programme en premier plan.

 @{fg shine}Variable@{fg text}     -

 @{fg shine}Résultats@{fg text}    RC=0
              Result= Non défini.

@EndNode
@Node g "Commandes ARexx"

 @{fg shine}Commande@{fg text}     EXPORTDATA ASCII @{i}nom du fichier @{ui}

 @{fg shine}Description@{fg text}  Retourne dans un  fichier  toutes  les  transactions  dont  le
              drapeau d'export est mis.

 @{fg shine}Variable@{fg text}     @{i}nom du fichier @{ui}: chemin du fichier à créer.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= transaction sous forme d'une chaîne de caractères :


 jour/mois/nature/somme/libellé/compte/numéro du chèque/banque/nom/paiement

     @{i}jour @{ui}            : valeur numérique à deux chiffres.
     @{i}mois @{ui}            : valeur numérique à deux chiffres.
     @{i}nature @{ui}          : nature de la transaction contenant soit :

                         @{i}CashInflow @{ui}  pour une entrée en trésorerie.
                         @{i}Bank1Input @{ui}  pour une entrée trésorerie en banque 1.
                         @{i}Bank2Input @{ui}  pour une entrée trésorerie en banque 2.
                         @{i}CashPayment @{ui} pour une sortie en trésorerie.
                         @{i}Bank1Outflow @{ui}pour une sortie trésorerie en banque 1.
                         @{i}Bank2Outflow @{ui}pour une sortie trésorerie en banque 2.

     @{i}somme @{ui}           : valeur numérique.
     @{i}libellé @{ui}         : chaîne alphanumérique.
     @{i}compte @{ui}          : valeur alphanumérique limitée à 6 caractères.
     @{i}numéro du chèque @{ui}: valeur numérique.
     @{i}banque @{ui}          : nom de la banque s'il sagit d'un chèque.
     @{i}nom @{ui}             : nom du tireur s'il sagit d'un chèque.
     @{i}paiement @{ui}        : type de paiement :

                         @{i}CASH  @{ui} pour espèces.
                         @{i}CHEQ  @{ui} pour chèque.
                         @{i}CARD  @{ui} pour carte bancaire.
                         @{i}DEDUCT @{ui}pour prélèvement.
                         @{i}TRANSF @{ui}pour versement.

@EndNode
@Node h "Commandes ARexx"

 @{fg shine}Commande@{fg text}     EXPORTDATA GEST @{i}nom du fichier @{ui}

 @{fg shine}Description@{fg text}  Retourne dans un  fichier  toutes  les  transactions  dont  le
              drapeau d'export est mis sous le format de GestaCompte Banque.

 @{fg shine}Variable@{fg text}     @{i}nom du fichier @{ui}: chemin du fichier à créer.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= transaction sous forme d'une chaîne de caractères :


 Type de la Banque jour|mois|nature|numéro du chèque|somme|libellé|compte

     @{i}Type de la banque @{ui}: indique la banque concernée soit :

                    @{i}Bank1 @{ui}pour la banque 1
                    @{i}Bank2 @{ui}pour la banque 2

     @{i}jour    @{ui}: valeur numérique à deux chiffres.
     @{i}mois    @{ui}: valeur numérique à deux chiffres.
     @{i}nature  @{ui}: nature de la transaction contenant soit :

                 @{i}CHEQ   @{ui}pour chèque.
                 @{i}DEDUCT @{ui}pour prélèvement.
                 @{i}DELIVE @{ui}pour remise.

     @{i}somme   @{ui}: valeur numérique.
     @{i}libellé @{ui}: chaîne alphanumérique contenant soit :

                 Remise chèques (la phrase est localisée).
                 Remise espèces (la phrase est localisée).
                 ou le libellé de la transaction

     @{i}compte  @{ui}: compte comptable de la transaction.

@EndNode
@Node i "Commandes ARexx"

@{fg shine}Commande@{fg text}      IMPORTDATA

  @{i}jour/mois/nature/somme/libellé/compte/numéro du chèque/banque/nom/paiement @{ui}

 @{fg shine}Description@{fg text}  Saisie une transaction dans le mois indiqué.

 @{fg shine}Variable@{fg text}     @{i}jour @{ui}    : valeur numérique à deux chiffres.
              @{i}mois @{ui}    : valeur numérique à deux chiffres.
              @{i}nature @{ui}  : nature de la transaction contenant soit :

                         @{i}CashInflow   @{ui}pour une entrée en trésorerie.
                         @{i}Bank1Input   @{ui}pour une entrée trésorerie en banque 1.
                         @{i}Bank2Input   @{ui}pour une entrée trésorerie en banque 2.
                         @{i}CashPayment  @{ui}pour une sortie en trésorerie.
                         @{i}Bank1Outflow @{ui}pour une sortie trésorerie en banque 1.
                         @{i}Bank2Outflow @{ui}pour une sortie trésorerie en banque 2.

              @{i}somme    @{ui}: valeur numérique.
              @{i}libellé  @{ui}: chaîne alphanumérique limitée à 20 caractères.
              @{i}numéro du chèque @{ui}: valeur numérique.
              @{i}compte   @{ui}: valeur alphanumérique limitée à 6 caractères.
              @{i}banque   @{ui}: chaîne alphanumérique limitée à 3 caractères.
              @{i}nom      @{ui}: chaîne alphanumérique limitée à 15 caractères.
              @{i}paiement @{ui}: type de paiement :

                         @{i}CASH   @{ui}pour espèces.
                         @{i}CHEQ   @{ui}pour chèque.
                         @{i}CARD   @{ui}pour carte bancaire.
                         @{i}DEDUCT @{ui}pour prélèvement.
                         @{i}TRANSF @{ui}pour versement.

 @{fg shine}Résultats@{fg text}    RC=0
              Result= Non défini.

@EndNode
@Node j "Commandes ARexx"

 @{fg shine}Commande@{fg text}     LOAD [force]

 @{fg shine}Description@{fg text}  Charge  en  mémoire  les  transactions  à  partir  d'un   support
              magnétique.

 @{fg shine}Variable@{fg text}     force (option) : si égal à force, il n'affiche pas  le  message
              de mise en garde.

 @{fg shine}Résultats@{fg text}    RC=0
              Result= Non défini.

@EndNode
@Node k "Commandes ARexx"

 @{fg shine}Commande@{fg text}     MONTH @{i}valeur @{ui}

 @{fg shine}Description@{fg text}  Sélection du mois en cours.

 @{fg shine}Variable@{fg text}     @{i}valeur @{ui}: expression numérique entre 1 et 12.

 @{fg shine}Résultats@{fg text}    RC=0
              Result= Non défini.

@EndNode
@Node l "Commandes ARexx"

 @{fg shine}Commande@{fg text}     NEWACCOUNT @{i}libellé du compte @{ui}

 @{fg shine}Description@{fg text}  Insère le libellé dans la liste des  comptes  suivant  l'ordre
              alphabétique.

 @{fg shine}Variable@{fg text}     @{i}libellé  du  compte @{ui} :  chaîne  alphanumérique  limitée  à  40
              caractères.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= Non défini.

@EndNode
@Node m "Commandes ARexx"

 @{fg shine}Commande@{fg text}     NUMBACCOUNTS

 @{fg shine}Description@{fg text}  Donne le nombre de comptes définis.

 @{fg shine}Variable@{fg text}     -

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= valeur numérique.

@EndNode
@Node n "Commandes ARexx"

 @{fg shine}Commande@{fg text}     NUMBOPERATIONS

 @{fg shine}Description@{fg text}  Renvoi le nombre d'opérations dans le mois en cours.

 @{fg shine}Variable@{fg text}     -

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= nombre d'opérations.

@EndNode
@Node o "Commandes ARexx"

 @{fg shine}Commande@{fg text}     OPERATION @{i}position @{ui}

 @{fg shine}Description@{fg text}  Retourne le contenu de la transaction sélectionnée.

 @{fg shine}Variable@{fg text}     @{i}position @{ui}: expression numérique.

 @{fg shine}Résultats@{fg text}    RC=0
              Result= transaction sous forme d'une chaîne de caractères :

  jour/mois/nature/somme/libellé/compte/numéro du chèque/banque/nom/paiement

     @{i}jour @{ui}    : valeur numérique à deux chiffres.
     @{i}mois @{ui}    : valeur numérique à deux chiffres.
     @{i}nature @{ui}  : nature de la transaction contenant soit :

                @{i}CashInflow   @{ui}pour une entrée en trésorerie.
                @{i}Bank1Input   @{ui}pour une entrée trésorerie en banque 1.
                @{i}Bank2Input   @{ui}pour une entrée trésorerie en banque 2.
                @{i}CashPayment  @{ui}pour une sortie en trésorerie.
                @{i}Bank1Outflow @{ui}pour une sortie trésorerie en banque 1.
                @{i}Bank2Outflow @{ui}pour une sortie trésorerie en banque 2.

     @{i}somme   @{ui} : valeur numérique.
     @{i}libellé @{ui} : chaîne alphanumérique.
     @{i}compte  @{ui} : valeur alphanumérique limitée à 6 caractères.
     @{i}numéro du chèque @{ui}: valeur numérique.
     @{i}banque  @{ui} : nom de la banque s'il sagit d'un chèque.
     @{i}nom     @{ui} : nom du tireur s'il sagit d'un chèque.
     @{i}paiement@{ui} : type de paiement :

                @{i}CASH   @{ui}pour espèces.
                @{i}CHEQ   @{ui}pour chèque.
                @{i}CARD   @{ui}pour carte bancaire.
                @{i}DEDUCT @{ui}pour prélèvement.
                @{i}TRANSF @{ui}pour versement.

@EndNode
@Node p "Commandes ARexx"

 @{fg shine}Commande@{fg text}     QUIT

 @{fg shine}Description@{fg text}  Ferme le programme et retourne au système.

 @{fg shine}Variable@{fg text}     -

 @{fg shine}Résultats@{fg text}    RC=0
              Result= Non défini.

@EndNode
@Node q "Commandes ARexx"

 @{fg shine}Commande@{fg text}     SAVE [force]

 @{fg shine}Description@{fg text}  Sauvegarde les transactions sur support magnétique.

 @{fg shine}Variable@{fg text}     force (option) : si égal à force, il n'affiche pas le  message
              de mise en garde.

 @{fg shine}Résultats@{fg text}    RC=0
              Result= Non défini.

@EndNode
@Node r "Commandes ARexx"

 @{fg shine}Commande@{fg text}     SHOWMONTH

 @{fg shine}Description@{fg text}  Retourne le mois en cours sous GestaCompte.

 @{fg shine}Variable@{fg text}     -

 @{fg shine}Résultats@{fg text}    RC=0
              Result= mois (de 1 à 12).

@EndNode
@Node s "Commandes ARexx"

 @{fg shine}Commande@{fg text}     SHOWYEAR

 @{fg shine}Description@{fg text}  Retourne l'année en cours sous GestaCompte.

 @{fg shine}Variable@{fg text}     -

 @{fg shine}Résultats@{fg text}    RC=0
              Result= année sous forme de 4 chiffres.

@EndNode
@Node t "Commandes ARexx"

 @{fg shine}Commande@{fg text}     TREAT @{i}position @{ui}

 @{fg shine}Description@{fg text}  Indique si la  transaction  a  été  importée  dans  le  module
              comptabilité.

 @{fg shine}Variable@{fg text}     @{i}position @{ui}: expression numérique.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= 'yes' pour oui ou 'No' pour non.

@EndNode
@Node u "Commandes ARexx"

 @{fg shine}Commande@{fg text}     WAIT @{i}secondes @{ui}

 @{fg shine}Description@{fg text}  Attente de n secondes.

 @{fg shine}Variable@{fg text}     @{i}secondes @{ui}: expression numérique.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= Non défini.

@EndNode
@Node v "Commandes ARexx"

  @{fg shine}Commande@{fg text}    WRITECHECK @{i}position @{ui}

 @{fg shine}Description@{fg text}  Marque la transaction comme étant déjà importée dans le module
              comptabilité.

 @{fg shine}Variable@{fg text}     @{i}position @{ui}: expression numérique.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= Non défini.

@EndNode
@Node w "Commandes ARexx"

 @{fg shine}Commande@{fg text}     YEAR @{i}valeur @{ui}

 @{fg shine}Description@{fg text}  Change l'année en cours.

 @{fg shine}Variable@{fg text}     @{i}valeur @{ui}: expression numérique de quatre chiffres.

 @{fg shine}Résultats@{fg text}    RC=0.
              Result= Non défini.

@EndNode
