home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_progs / prog_oth / adoc.lzh / ADOC / ADOC.DOC < prev    next >
Encoding:
Text File  |  1991-08-15  |  6.4 KB  |  165 lines
  1.  
  2.                         ADoc v3.10 - Manuel d'utilisation
  3.  
  4.                         Réalisation     : Denis  GOUNELLE
  5.                         Idée originale  : Jean-Yves PROUX
  6.  
  7.  
  8.  
  9.  
  10.  
  11. Avertissement :
  12. ---------------
  13.  
  14.         Ce manuel décrit la version 3.10 de l'utilitaire ADoc. Ce programme
  15. est placé dans le domaine public, avec autorisation de le copier  librement
  16. et de le diffuser par n'importe quel moyen, à condition  qu'aucune  contre-
  17. partie (financière ou autre) ne soit reclamée en échange,  que  le  produit
  18. soit diffusé dans son intégralité, et sans aucune modification.
  19.  
  20.         ADoc est (C)1990 par Denis GOUNELLE, toute utilisation  commerciale
  21. ou vente de  ce  programme  (sans  autorisation  écrite)  est   STRICTEMENT
  22. INTERDITE.
  23.  
  24.         Malgrès de nombreux tests, je ne peux garantir que ce programme  ne
  25. contient aucune erreur. VOUS UTILISEZ CE PROGRAMME A VOS RISQUES ET PERILS.
  26. Je ne pourrais en aucun cas être tenu responsable de tout  dommage,  direct
  27. ou indirect, résultant de l'utilisation de ce programme.
  28.  
  29.  
  30. Sommaire :
  31. ----------
  32.  
  33.         1. Introduction
  34.         2. Principe de fonctionnement
  35.         3. Mode d'emploi
  36.            3.1 Appel depuis le CLI
  37.            3.2 Appel depuis le WorkBench
  38.            3.3 Mode d'emploi
  39.  
  40.  
  41. 1.Introduction :
  42. ----------------
  43.  
  44.         ADoc est un utilitaire permettant de disposer d'une aide permanante
  45. sur n'importe quel sujet. Il dispose d'une fonction (unique ?) de recherche
  46. d'un mot désigné à la souris.
  47.  
  48.         Vous pouvez me faire part de vos remarques ou critiques  sur  ADoc,
  49. en écrivant à l'adresse suivante :
  50.  
  51.                         M. GOUNELLE Denis
  52.                            Boite n° 71
  53.                        6, rue des cailloux
  54.                       92110 CLICHY - FRANCE
  55.  
  56.  
  57. 2. Principe de fonctionnement :
  58. -------------------------------
  59.  
  60.         ADoc travaille à partir d'un fichier d'aide, que vous pouvez  créer
  61. vous-même au moyen d'un éditeur de texte. Ce fichier contient une suite  de
  62. termes, chaque terme ayant la syntaxe suivante :
  63.  
  64.                 terme
  65.                         ligne explication 1
  66.                         ligne explication 2
  67.                            .    .    .
  68.                            .    .    .
  69.                         ligne explication n
  70.  
  71.         Il est absolument indispensable que la  première  lettre  de  terme
  72. soit sur la colonne 1, et que les lignes d'explications commencent  par  au
  73. moins un espace ou une tabulation, car c'est le seul  moyen  pour  ADoc  de
  74. distinguer un terme d'une explication.
  75.         Une ligne d'explication ne peut pas dépasser 78 caractères. On peut
  76. mettre au plus 25 lignes d'explication par terme en mode PAL  (20  en  mode
  77. NTSC). Un terme ne peut pas faire plus de 31 caractères et ne peut contenir
  78. d'espace ni de tabulation.
  79.  
  80.         Une fois ce fichier d'aide constitué, ADoc construit un  index  qui
  81. permet d'accéder presque instantanément  au  terme  recherché.  Le  nom  du
  82. fichier d'index est obtenu en  ajoutant  le  suffixe  '.index'  au  nom  du
  83. fichier d'aide. Cet index est chargé en mémoire pour  accélérer  encore  la
  84. recherche.
  85.  
  86.         ATTENTION : vous devez reconstruire l'index à chaque modification
  87.                     du fichier d'aide.
  88.  
  89.  
  90. 3. Mode d'emploi :
  91. ------------------
  92.  
  93.         ADoc peut s'utiliser depuis le  CLI  ou  depuis  le  WorkBench.  Le
  94. fichier d'aide par défaut est "ADOC:Amiga.doc" mais on peut, dans les  deux
  95. cas, indiquer un autre fichier.  Ceci  veut  dire  que  vous  pouvez  avoir
  96. plusieurs fichiers d'aide en même temps, chacun sur un sujet différent,  et
  97. sélectionner le fichier approprié quand vous avez besoin d'aide.
  98.  
  99.  
  100.         3.1 Appel depuis le CLI
  101.         -----------------------
  102.  
  103.         Depuis le CLI, la syntaxe de l'appel est la suivante :
  104.  
  105.                         ADoc  -i  [-f<fichier>]
  106.                      ou ADoc [-e] [-f<fichier>] [<terme>]
  107.  
  108.         La première forme demande de créer ou de mettre à jour  l'index  du
  109. fichier d'aide, la seconde forme demande de  l'aide.  L'option  -f<fichier>
  110. permet de préciser le fichier d'aide à utiliser. L'option -e demande à ADoc
  111. d'ouvrir son propre écran, plutôt que d'utiliser l'écran WorkBench.
  112.  
  113.         Dans la seconde forme on peut  indiquer  le  terme  sur  lequel  on
  114. désire de l'aide, mais ce n'est pas obligatoire.
  115.  
  116.  
  117.         3.2 Appel depuis le WorkBench
  118.         -----------------------------
  119.  
  120.         Depuis le WorkBench, on peut appeler ADoc de trois façons :
  121.  
  122.         - en double-cliquant sur l'icone d'ADoc
  123.         - en cliquant sur l'icone d'ADoc puis en double-cliquant  sur
  124.           l'icone d'un fichier d'aide, le tout en gardant  la  touche
  125.           SHIFT appuyée
  126.         - en cliquant sur l'icone d'un fichier d'aide puis en double-
  127.           cliquant sur l'icone d'aide, le tout en gardant  la  touche
  128.           SHIFT appuyée
  129.  
  130.         Quand ADoc est utilisé à partir du WorkBench, il ouvre  son  propre
  131. écran.
  132.  
  133.  
  134.         3.3 Mode d'emploi
  135.         -----------------
  136.  
  137.         Si le fichier d'index n'existe pas, ADoc ouvre une boite de requête
  138. pour vous proposer de le créer. Si vous répondez "OUI", l'index  est  créé,
  139. ce qui peut prendre un certain temps. Si vous répondez "NON", ADoc s'arrête
  140. et affiche un message d'erreur.
  141.  
  142.         Si vous appelez ADoc depuis le WorkBench, ou  depuis  le  CLI  mais
  143. sans indiquer le terme à chercher, une boite de requête apparait,  avec  la
  144. liste des termes connus. Vous pouvez alors cliquer deux fois sur  le  terme
  145. choisi, ou utiliser le gadget de chaine en bas de la fenêtre.
  146.  
  147.         Si le terme n'est pas trouvé, ou si vous cliquez sur le  gadget  de
  148. fermeture de la boite de requête, ADoc s'arrête.
  149.  
  150.         Si le  terme  est  trouvé  dans  le  fichier  d'aide,  une  fenêtre
  151. apparait, avec le texte  d'explication  correspondant.  Vous  pouvez  alors
  152. cliquer deux fois sur  un  mot  du  texte  d'explication,  ce  qui  lancera
  153. automatiquement la recherche de ce terme. Si vous désirez de l'aide sur  un
  154. terme qui n'est pas dans l'explication, vous pouvez  utiliser  la  commande
  155. `Autre terme' du menu `Projet' : une boite de  requête  apparait,  avec  la
  156. liste des termes connus.
  157.         Si le terme n'est pas  trouvé  l'écran  flashe,  sinon  l'aide  est
  158. affichée dans une nouvelle fenêtre qui vient se superposer à l'ancienne. Si
  159. vous demandez de l'aide sur un terme dont  l'aide  est  déjà  affichée,  la
  160. fenêtre correspondante est mise au premier plan.
  161.  
  162.         Pour quitter ADoc, vous pouvez soit fermer toutes les fenêtres  une
  163. par une (NOTE : ADoc s'arrête automatiquement quand la dernière fenêtre est
  164. fermée), soit utiliser la commande `Quitte' du menu `Projet'.
  165.