home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / new / util / cli / adoc / adoc.doc < prev    next >
Encoding:
Text File  |  1993-12-21  |  28.6 KB  |  616 lines
  1.  
  2.  
  3.                ADoc - Manuel de référence
  4.  
  5.  
  6.  
  7.  
  8.  
  9. AboutThisDoc
  10.  
  11.       Ce manuel décrit la version 3.00 de l'utilitaire ADoc. Ce  programme
  12.   est (c)1990-1993 par Denis GOUNELLE, toute utilisation commerciale ou  vente
  13.   sans autorisation écrite est strictement interdite. Vous  pouvez  copier  et
  14.   diffuser ce programme aux conditions suivantes :
  15.  
  16.     - l'ensemble des fichiers doit être fourni
  17.     - aucun fichier ne doit avoir été modifié
  18.     - vous ne devez pas demander plus de 40FF pour cela
  19.  
  20.       Malgré de nombreux tests, je ne peux garantir que ADoc  ne  contient
  21.   aucune erreur. VOUS UTILISEZ CE PROGRAMME A VOS RISQUES  ET  PERILS.    Je  ne
  22.   pourrai en aucun cas être tenu pour responsable de tout dommage,  direct  ou
  23.   indirect, résultant de l'utilisation de ADoc.
  24.  
  25.   AREXX est (c)1987 par William Hawes.
  26.   PowerPacker 2.3b est (c)1989 par PowerPeak et Nico FRANCOIS
  27.   PowerPacker Pro 3.0b est (c)1990 par PowerPeak et par UGA Software.
  28.   La bibliothèque "powerpacker.library" est (c)1990 par Nico FRANCOIS.
  29.   La bibliothèque "reqtools.library" est (c)1990-1993 par Nico FRANCOIS.
  30.  
  31.           >>> FERMEZ CETTE FENETRE POUR CONTINUER <<<
  32.  
  33. Introduction
  34.  
  35.       ADoc2  est  une  nouvelle  version  de  ADoc,  qui  a  été   réécrit
  36.   entièrement afin de supprimer certaines limitations et de pouvoir ajouter de
  37.   nombreuses  améliorations.  Notez  que   certaines   incompatibilités   sont
  38.   apparues, principalement au niveau des arguments. Ce programme fonctionne de
  39.   la même façon sous les versions 1.3 et 2.0 du système.
  40.       ADoc est un utilitaire permettant de gérer  des  documentations  sur
  41.   n'importe quel sujet. Il est capable de lancer automatiquement la  recherche
  42.   d'un mot désigné à la souris, et peut travailler sur plusieurs fichiers à la
  43.   fois. ADoc peut également  utiliser  directement  les  fichiers  AutoDoc  et
  44.   AmigaGuide, ainsi que  des  fichiers    compactés  à  l'aide  de  l'utilitaire
  45.   "PowerPacker".
  46.  
  47.       Vos critiques et suggestions sur ce programme  seront  toujours  les
  48.   bienvenues. N'hésitez pas à m'écrire, à l'adresse suivante :
  49.  
  50.                    M. GOUNELLE Denis
  51.                     Boite 71
  52.                   6, rue des cailloux
  53.                  92110 CLICHY - FRANCE
  54.  
  55.       Vous pouvez également m'adresser un  message  à  l'adresse  Internet
  56.   "gounelle@alphanet.ch". Notez qu'il s'agit d'une boite à lettre  mise  à  ma
  57.   disposition par un ami, aussi veuillez n'envoyer que de courts messages.  De
  58.   plus, n'ayant pas accès directement à mes messages, n'espérez pas avoir  une
  59.   réponse avant une dizaine de jours.
  60.  
  61.       Merci  à  Jean-Yves  PROUX  et  à  Helmut  J.  ESENWEIN  pour  leurs
  62.   nombreuses suggestions, à Reza ELGHAZI pour son aide à propos  des  fichiers
  63.   AmigaGuide, ainsi qu'à Simon HEWINSON  pour  la  traduction  en  anglais  du
  64.   fichier "amiga.doc". Remerciements particuliers à  Jean-Philippe  RAPP  pour
  65.   ses idées, et pour son aide à propos des fichiers AutoDoc.
  66.  
  67.       En France, la dernière version de ce programme est disponible auprès
  68.   de Serge HAMMOUCHE, 3 rue Anatole France,  13220  Chateauneuf-les-Martigues.
  69.   Pour recevoir le catalogue complet, il vous suffit d'envoyer deux timbres  à
  70.   cette adresse.
  71.  
  72. Installation
  73.  
  74.       ADoc utilise la bibliothèque    "reqtools.library"  (version  2.0c  ou
  75.   supérieure). Vous devez donc copier cette bibliothèque  dans    le  répertoire
  76.   "LIBS:", si ce n'est déjà fait.
  77.       ADoc est désormais localisé, c'est-à-dire qu'il peut s'adapter à  la
  78.   langue par défaut si vous avez le système 2.1 ou plus. Il vous faudra  alors
  79.   copier le fichier catalogue désiré dans le répertoire correspondant à  votre
  80.   langue par défaut. Par exemple, s'il s'agit du français, copiez  le  fichier
  81.   "français.catalog" dans le répertoire  "SYS:Locale/Catalogs/Français",  sous
  82.   le nom "ADoc.catalog"
  83.  
  84. PrincipesDeFonctionnement
  85.  
  86.       ADoc travaille à partir de fichiers de documentation, qui  associent
  87.   un texte à un mot-clé (appelé "terme" dans cette  documentation).  A  chaque
  88.   fichier  de  documentation  est  associé  un    fichier  d'index,  qui  permet
  89.   d'accéder presque instantanément aux termes recherchés  (notez  que  ceci  a
  90.   pour conséquence qu'il faudra  reconstruire  le  fichier  d'index  à  chaque
  91.   modification du fichier de  documentation).  Seul  le  fichier  d'index  est
  92.   chargé en mémoire lors de l'utilisation.  Le  nom  du  fichier  d'index  est
  93.   obtenu en ajoutant le suffixe ".index" au nom du fichier de documentation.
  94.  
  95.       Les fichiers de documentation, que vous  pouvez  créer  vous-même  à
  96.   l'aide de votre éditeur de texte favori,  sont  constitués  d'une  série  de
  97.   définitions, chaque définition ayant la syntaxe suivante :
  98.  
  99.           terme
  100.               première ligne de texte
  101.               seconde ligne de texte
  102.  
  103.               etc...
  104.  
  105.               n-ième ligne de texte
  106.  
  107.       Dans un premier temps, considérez que les deux premières  lignes  du
  108.   fichier doivent être vides (ou à la rigueur commencer par un espace  ou  une
  109.   tabulation). Il est absolument indispensable que  le    premier  caractère  du
  110.   terme soit en colonne 1, et que les lignes de texte commencent par un espace
  111.   ou une tabulation. Les lignes vides sont autorisées.
  112.  
  113.  
  114.  
  115.                    NOTE IMPORTANTE :
  116.  
  117.       Le format des fichiers de documentation n'est plus  le  même
  118.       que pour les version 3.xx et 4.xx. 
  119.  
  120.       Un terme ne peut faire plus de 32 caractères, et ne peut contenir ni
  121.   espaces  ni  tabulations  :  les  caractères    autorisés  sont  les   lettres
  122.   minuscules et majuscules,  les  chiffres,  le  souligné  et  les  caractères
  123.   accentués (codes ASCII compris entre 217 et 246). Il est cependant  possible
  124.   d'étendre le  jeu  des  caractères  autorisés  si  besoin  (voir  paragraphe
  125.   ConceptsAvancés).
  126.       Le nombre de termes par fichier, et de lignes de texte par terme, ne
  127.   sont pas limités (ou plutôt, cette limite est si grande  que  vous  serez  à
  128.   court de mémoire bien avant).
  129.  
  130.       La longueur maximale d'une ligne de texte  est  de  256  caractères.
  131.   Afin de mettre en valeur certaines parties du texte,    vous  pouvez  utiliser
  132.   les séquences ANSI suivantes :
  133.  
  134.           ESC[1m  début caractères gras
  135.           ESC[3m  début caractères italiques
  136.           ESC[4m  début caractères soulignés
  137.           ESC[22m fin caractères gras
  138.           ESC[23m fin caractères italiques
  139.           ESC[24m fin caractères soulignés
  140.           ESC[0m  caractères normaux
  141.  
  142. AppelDepuisLeCLI
  143.  
  144.   ADoc peut s'utiliser aussi bien depuis le CLI que depuis le Workbench.  Lors
  145.   de l'appel depuis le CLI, vous pouvez indiquer les arguments suivants :
  146.  
  147.   WBENCH
  148.       Demande à ADoc d'utiliser l'écran du  Workbench.  Si  cet  argument  est
  149.       omis, ADoc ouvrira son propre écran, de la même taille  que  l'écran  du
  150.       Workbench. En cas d'erreur  lors  de  l'ouverture  de  cet  écran,  ADoc
  151.       passera automatiquement sur l'écran du Workbench.
  152.  
  153.   LACE
  154.       Demande à ADoc d'utiliser un écran  en  mode  entrelacé.  Si  vous  avez
  155.       demandé à utiliser l'écran du Workbench, et que cet écran n'est  pas  en
  156.       mode entrelacé, cet argument sera ignoré.
  157.  
  158.   FONT nom
  159.       Demande à ADoc d'utiliser la police de caractères indiquée,  plutôt  que
  160.       la   police   par   défaut.   Le     nom   doit   être   de    la     forme
  161.       <NomDeLaPolice><TailleEnY>,  par    exemple  "topaz8".  ADoc  est  capable
  162.       d'utiliser n'importe quelle police non proportionnelle,  pourvu  que  sa
  163.       taille soit d'au moins 8.
  164.       Si ADoc ne peut ouvrir la police demandée,  il  essaiera    d'utiliser  la
  165.       police par défaut. Si cette police ne convient pas, ou si ADoc  ne  peut
  166.       l'ouvrir, il essaiera d'accéder à la police Topaz,  en  taille  8.  S'il
  167.       échoue, le programme s'arrêtera immédiatement.
  168.  
  169.   MAKEIDX
  170.       Indique à ADoc que la seule opération à effectuer est  la  création  des
  171.       fichiers d'index.
  172.  
  173.   QUICK
  174.       Demande  à  ADoc    de  ne    pas  afficher  le  texte  associé   au     terme
  175.       "AboutThisDoc" au démarrage. Normalement, à chaque fois que  ADoc  ouvre
  176.       un fichier, il cherche le terme "AboutThisDoc"  dans  ce  fichier  puis,
  177.       s'il existe,  affiche le texte correspondant et attend que l'utilisateur
  178.       ferme la fenêtre pour continuer.
  179.  
  180.   AREXX
  181.       Demande à ADoc de passer en mode AREXX.  L'utilisation  avec  AREXX  est
  182.       détaillée au paragraphe ModeAREXX.
  183.  
  184.   ONEWINDOW
  185.       Demande à ADoc de n'ouvrir qu'une seule fenêtre à la fois.
  186.  
  187.   NOCASE
  188.       Demande à ADoc de ne pas différencier minuscules et majuscules  lors  de
  189.       la gestion des fichiers. Cela ne concernera que les fichiers dont le nom
  190.       est indiqué après cette option.
  191.  
  192.   NOSORT
  193.       Demande à ADoc de ne pas trier l'index des  fichiers  dont  le  nom  est
  194.       indiqué après cette option.
  195.  
  196.   TABSIZE n
  197.       Indique la taille des tabulations pour les  fichiers  dont  le  nom  est
  198.       indiqué après cette option. La taille par défaut est de 8.
  199.  
  200.   Tout autre argument est considéré comme un nom de fichier de documentation à
  201.   utiliser. Vous pouvez indiquer plusieurs fichiers, en séparant les noms  par
  202.   des espaces ou par une virgule (par  exemple  "ADoc  fichier1  fichier2"  ou
  203.   "ADoc fichier1,fichier2"). Vous pouvez mélanger noms de fichiers et options,
  204.   mais    n'oubliez  pas  que  les  options  NOCASE,  NOSORT,  et   TABSIZE   ne
  205.   concerneront que les fichiers indiqués après ces options. ADoc  ouvrira  les
  206.   fichiers dans l'ordre indiqué.  A  moins  que  vous  n'indiquiez  un  chemin
  207.   complet, les fichiers sont recherchés d'abord dans  le  répertoire  courant,
  208.   puis dans le répertoire "ADOC:". Si vous indiquez un nom  de  répertoire  au
  209.   lieu d'un nom de fichier, tous les fichiers de ce répertoire (à  l'exception
  210.   des fichiers ".info" et ".index") seront ouverts.
  211.  
  212. AppelDepuisLeWorkbench
  213.  
  214.   Depuis le Workbench, vous pouvez appeler ADoc de plusieurs façons :
  215.  
  216.     - en double-cliquant sur l'icône de ADoc (le fichier de documentation  par
  217.       défaut sera utilisé)
  218.     - en double-cliquant sur l'icône d'un fichier qui a ADoc comme  outil  par
  219.       défaut (champ "DEFAULT TOOL")
  220.     - en cliquant sur les icônes de plusieurs fichiers,  tout  en  gardant  la
  221.       touche SHIFT appuyée, puis en double-cliquant sur l'icône de ADoc.
  222.  
  223.   Dans tous les cas, ADoc commence par    examiner  le  champ  "TOOL  TYPES"  de
  224.   l'icône du programme, qui peut contenir :
  225.  
  226.       FONT=nom
  227.       OPTIONS=[WBENCH][LACE][MAKEIDX][QUICK][AREXX][ONEWINDOW]
  228.  
  229.   Pour plus de détails sur ces options, voir le  paragraphe  AppelDepuisLeCLI.
  230.   Notez que les noms des options doivent être séparés par  un  caractère  "|".
  231.   ADoc ouvre ensuite les fichiers  de  documentation  éventuellement  indiqués
  232.   exactement de la même façon que lors de l'appel  depuis  le  CLI  (notamment
  233.   vous pouvez indiquer un répertoire au lieu d'un fichier),  à  la  différence
  234.   que le champ "TOOL TYPES" de chaque icône est examiné, et peut contenir :
  235.  
  236.       TABSIZE=n
  237.       OPTIONS=[NOCASE][NOSORT]
  238.  
  239.   Pour plus de détails sur ces options, voir le  paragraphe  AppelDepuisLeCLI.
  240.   Notez que ces trois options ne concerneront que le fichier  correspondant  à
  241.   l'icône.
  242.  
  243. DémarrageDuProgramme
  244.  
  245.       Comme expliqué dans les deux paragraphes précédents,    ADoc  commence
  246.   par ouvrir le (ou les) fichier(s) indiqué(s).  Lors  de  cette  phase,  ADoc
  247.   tente également de charger le fichier d'index correspondant à chaque fichier
  248.   de documentation. Si vous n'avez indiqué aucun nom de fichier à ouvrir, ADoc
  249.   regarde si la variable "ADocFile" est  définie  :  si  oui,  sa  valeur  est
  250.   utilisée. Si non, le fichier de documentation par  défaut  est  "Amiga.doc".
  251.   Notez  que  vous  pouvez  indiquer  plusieurs  fichiers  dans  la   variable
  252.   "ADocFile", de la même façon que depuis la ligne de commande  (par  exemple:
  253.   setenv ADocFile "exec.doc dos.doc").
  254.       Si le fichier d'index est introuvable, ADoc  vous  proposera  de  le
  255.   créer. Si vous refusez, ce fichier de documentation ne sera pas  utilisable,
  256.   mais ADoc essaiera quand même d'ouvrir les autres fichiers.
  257.       Si ADoc détecte que le fichier de documentation a été modifié  après
  258.   la création de l'index, il vous proposera de mettre  le  fichier  d'index  à
  259.   jour. Si vous refusez, le fichier de documentation sera quand  même  ouvert,
  260.   mais ADoc pourra détecter des erreurs ultérieurement si  le  contenu    de  ce
  261.   fichier a été changé. Notez que la date de création du fichier  d'index  est
  262.   mémorisée dans le fichier d'index lui-même.
  263.  
  264.       Une fois tous les  fichiers  ouverts,  ADoc  affiche    une  boîte  de
  265.   requête,  indiquant  la  liste  des  termes  du  premier   fichier   ouvert.
  266.   L'utilisation  de  cette  boîte  de  requête  est  décrite   au   paragraphe
  267.   RequêteDeTerme.
  268.  
  269. RequêteDeTerme
  270.  
  271.       Vous pouvez désigner un terme à l'aide de  la  souris,  en  cliquant
  272.   dessus. Le terme s'affiche alors dans une autre couleur. Si vous cliquez une
  273.   seconde fois sur ce terme, la requête disparait et  ADoc  affiche  le  texte
  274.   correspondant au terme dans une fenêtre. L'utilisation de ces  fenêtres  est
  275.   décrite au paragraphe GestionDesFenêtres.
  276.  
  277.       Vous pouvez également vous servir du clavier pour faire votre choix.
  278.   Si vous appuyez sur une lettre quelconque,  cette  lettre  sera  ajoutée  au
  279.   "préfixe" courant (affiché dans le rectangle en  dessous  de  la  liste  des
  280.   termes), et l'affichage de la liste des termes se fera à partir  du  premier
  281.   terme commençant  par  ce  préfixe.  ADoc  complètera  ce  préfixe  le  plus
  282.   possible. Si vous appuyez sur la touche <BACKSPACE> (au-dessus de la  touche
  283.   <RETURN>), le dernier caractère du préfixe sera effacé et l'affichage de  la
  284.   liste mis à jour également. Si vous appuyez sur  la  touche  <RETURN>,  ADoc
  285.   affichera le texte correspondant au premier terme commençant par le préfixe.
  286.   Notez que ADoc ne différenciera pas  minuscules et majuscules si le  fichier
  287.   courant a été indiqué après une option NOCASE.
  288.  
  289.       Vous pouvez fermer la requête sans rien choisir, en appuyant sur  la
  290.   touche <ESC> ou en cliquant sur le gadget  de  fermeture.  Si  aucune  autre
  291.   fenêtre n'est ouverte à ce moment, le programme s'arrêtera.
  292.  
  293.       La requête de terme est en fait capable de vous permettre  un  choix
  294.   parmi trois listes : la liste des termes du fichier courant,    la  liste  des
  295.   fichiers (à condition qu'il y ait plusieurs fichiers ouverts)  et  la  liste
  296.   des termes trouvés  lors  de    la  dernière  recherche  (à  condition  qu'une
  297.   recherche ait déjà été effectuée,  voir  paragraphe  Recherche).  La    lettre
  298.   écrite dans le coin inférieur droit de la requête vous indique quelle  liste
  299.   est affichée : liste des termes (T),  liste  des  fichiers  (F),  liste  des
  300.   termes trouvés (S).
  301.       Pour passer d'une liste à l'autre, appuyez sur le bouton droit de la
  302.   souris tout en appuyant sur une des touches  SHIFT.  Lorsque    la  liste  des
  303.   fichiers est affichée et que sélectionnez un des fichiers  de  cette    liste,
  304.   ADoc repasse automatiquement à la liste des termes et affiche la  liste  des
  305.   termes du fichier que vous avez choisi.
  306.  
  307.       Si aucune autre fenêtre n'est ouverte, la requête de  terme  dispose
  308.   d'un menu avec quatre options :
  309.  
  310.       Ouvre fichier   voir paragraphe LeMenuSpecial
  311.       Cherche          voir paragraphe Recherche
  312.       Iconifie          voir paragraphe LeMenuProjet
  313.       Quitte          vous permet de quitter ADoc
  314.  
  315. GestionDesFenêtres
  316.  
  317.       Lorsque vous sélectionnez un terme,  ADoc  ouvre  une  fenêtre  pour
  318.   afficher le texte correspondant. Si le terme est défini plusieurs fois  dans
  319.   le même fichier, ou dans plusieurs fichiers différents, toutes les lignes de
  320.   texte seront mises à la suite les unes des autres,  et  affichées  dans  une
  321.   seule fenêtre. La hauteur de    la  fenêtre  dépend  du  nombre  de  lignes  à
  322.   afficher. S'il y a trop de lignes, seule la première page sera  affichée  et
  323.   ADoc ajoutera deux gadgets en forme  de  flèches  (dans  le  coin  supérieur
  324.   droit) à la fenêtre, pour vous permettre de faire défiler le texte.
  325.  
  326.       Bien entendu, il est possible d'avoir plusieurs fenêtres ouvertes  à
  327.   la fois. Dans ce cas, la fenêtre qui était active lors de l'ouverture  d'une
  328.   nouvelle fenêtre est considérée comme la fenêtre parente de cette  dernière.
  329.       Par  défaut,    les  fenêtres  disposent  des  gadgets    standards   de
  330.   fermeture, de déplacement, de  changement  de  plan,    et  de    changement  de
  331.   taille. Si vous modifiez la taille d'une fenêtre, ADoc ajoutera ou  enlevera
  332.   automatiquement les gadgets en forme de flèches suivant les besoins.    Chaque
  333.   fenêtre dispose également de trois menus, les menus  "Projet",  "Outils"  et
  334.   "Spécial" (ces menus sont décrits aux paragraphes LeMenuProjet, LeMenuOutils
  335.   et LeMenuSpécial). Notez enfin que ADoc reconnait les touches suivantes :
  336.  
  337.       HELP          rappelle les touches reconnues
  338.       ESC          ferme la fenêtre courante
  339.       HAUT          page précédente
  340.       BAS          page suivante
  341.       BACKSPACE      ouvre la fenêtre parente
  342.       Shift-HAUT      terme précédent
  343.       Shift-BAS      terme suivant
  344.  
  345.       Si vous cliquez sur un mot quelconque, ce mot sera affiché dans  une
  346.   couleur différente. Si vous cliquez  une  seconde  fois  sur    ce  mot,  ADoc
  347.   lancera automatiquement la recherche du terme correspondant, dans  tous  les
  348.   fichiers ouverts. En    cas  d'échec  l'écran  flashera,  sinon  une  nouvelle
  349.   fenêtre apparaitra.
  350.  
  351. LeMenuProjet
  352.  
  353.   Autre terme
  354.       Fait apparaître la requête de terme (voir paragraphe RequêteDeTerme).
  355.  
  356.   Imprime
  357.       Imprime  le  texte  contenu  dans  la  fenêtre  active.  Notez  que  les
  358.       éventuelles  séquences  ANSI  seront   correctement   interprétées   par
  359.       l'imprimante.
  360.  
  361.   Iconifie
  362.       Met ADoc en sommeil : si ADoc avait ouvert son propre écran celui-ci est
  363.       fermé, puis toutes les fenêtres disparaissent et ADoc ouvre  une    petite
  364.       fenêtre en haut de l'écran du Workbench. Si vous cliquez sur  le  gadget
  365.       de fermeture de cette fenêtre, ADoc vous demandera confirmation avant de
  366.       quitter. Pour "réveiller" ADoc, activez la fenêtre  et  appuyez  sur  le
  367.       bouton droit de la souris.
  368.       Normalement, ADoc garde en mémoire toutes les lignes de  texte  afin  de
  369.       pouvoir remettre rapidement toutes les fenêtres en  place  lors  de  son
  370.       réveil. Ceci a  l'inconvénient  de  ne  pas  libérer  toute  la  mémoire
  371.       possible aussi, lorsque vous lui demanderez de  s'iconifier,  ADoc  vous
  372.       demandera si vous voulez fermer toutes les fenêtres.  Si    vous  répondez
  373.       oui, la mémoire sera complètement libérée, et lorsque  vous  réveillerez
  374.       ADoc, il affichera la requête de terme.
  375.  
  376.   Aide...
  377.       Rappelle quelles touches ADoc reconnait (équivalent  à  appuyer  sur  la
  378.       touche HELP).
  379.  
  380.   A propos...
  381.       Affiche quelques informations sur ADoc.  Cliquez    à  l'intérieur  de  la
  382.       fenêtre ou appuyez sur une touche pour continuer.
  383.  
  384.   Quitter
  385.       Vous permet de quitter ADoc (avec confirmation).
  386.  
  387. LeMenuOutils
  388.  
  389.   Ecran avant
  390.       Permet d'utiliser ADoc sur un écran déjà ouvert (par  exemple  celui  de
  391.       votre éditeur de texte). Il vous suffit de  mettre  l'écran  sur  lequel
  392.       vous voulez placer ADoc au premier plan, puis de le faire  glisser  vers
  393.       le bas pour dévoiler l'écran  où  est  ADoc.  Sélectionnez  alors  cette
  394.       option : ADoc ferme toutes les fenêtres ouvertes,  ferme    éventuellement
  395.       son écran, et ré-ouvre les fenêtres sur l'écran au premier plan.
  396.  
  397.  
  398.  
  399.                  NOTE IMPORTANTE :
  400.  
  401.       Vous aurez certainement droit à une visite  du  "Gourou"  si
  402.       l'écran où vous avez placé ADoc est  fermé  avant  que  vous
  403.       n'ayez quitté ADoc (ou que vous ne l'ayez placé sur un autre
  404.       écran) 
  405.  
  406.       Notez que cette commande ne marchera pas si vous n'avez pas  indiqué  de
  407.       police de caractères à utiliser (voir  paragraphe  AppelDepuisLeCLI)  et
  408.       que la police de l'écran au premier plan ne convient pas.
  409.  
  410.   Ferme tout
  411.       Vous permet de fermer toutes les fenêtres d'un  seul  coup.  Après  vous
  412.       avoir demandé confirmation, ADoc fermera les fenêtres  et  affichera  la
  413.       requête de terme.
  414.  
  415.   Cherche
  416.       Vous permet de lancer une recherche (voir le paragraphe Recherche).
  417.  
  418.   Information
  419.       Affiche le nombre de fichiers et de termes  disponibles,    ainsi  que  le
  420.       nombre de fenêtres ouvertes et  de  lignes  affichées.  Cliquez  sur  le
  421.       gadget "Ok" pour continuer.
  422.  
  423. LeMenuSpécial
  424.  
  425.   Ouvre fichier
  426.       Vous permet d'ouvrir un fichier  de  documentation  supplémentaire.  Une
  427.       requête de fichier apparait afin que vous puissiez indiquer le fichier à
  428.       ouvrir.
  429.  
  430.   Ferme fichier
  431.       Vous permet de fermer le fichier courant (c'est-à-dire le fichier où est
  432.       défini le terme affiché  dans  la  fenêtre  active).  Après  vous  avoir
  433.       demandé confirmation, ADoc fermera toutes les fenêtres  correspondant  à
  434.       ce fichier puis fermera le fichier.
  435.       Notez que cette commande ne marchera que si au moins deux fichiers  sont
  436.       ouverts.
  437.  
  438.   Une fenêtre
  439.       Si cette option est sélectionnée, ADoc n'ouvrira qu'une seule fenêtre  à
  440.       la fois.
  441.  
  442. Recherche
  443.  
  444.       ADoc est capable de chercher jusqu'à  quatre  chaines  simultanément
  445.   dans    les  lignes  de  texte,  puis    d'afficher   la   liste   des   termes
  446.   correspondants.  Lorsque  vous  sélectionnez    l'option  "Cherche"  du   menu
  447.   "Outils", une fenêtre apparait  avec  quatre  gadgets  de  chaine.  Il  y  a
  448.   également  un  gadget  "ANNULER"  pour  abandonner  l'opération,  un  gadget
  449.   "VALIDER" pour lancer la recherche, et un menu "Options" :
  450.  
  451.       min = MAJ
  452.       Demande à ADoc de ne pas différencier les minuscules des  majuscules
  453.       lors de la recherche.
  454.  
  455.       Toutes chaines
  456.       Normalement, ADoc cherche tous les termes qui  contiennent  une  des
  457.       chaines que vous avez entrées. Cette option vous permet de  chercher
  458.       au  contraire  les  termes  qui  contiennent    TOUTES     les   chaines
  459.       indiquées.
  460.  
  461.       Tous fichiers
  462.       Demande à ADoc de faire la recherche dans tous les fichiers ouverts,
  463.       et non seulement dans le fichier courant.
  464.  
  465.       Lorsque vous lancez la recherche, une boîte de requête apparait.  Le
  466.   gadget "Arrêter"  vous  permet  d'interrompre  la  recherche.  Une  fois  la
  467.   recherche terminée, l'écran flashera si aucun terme n'a été  trouvé.  Sinon,
  468.   la requête de terme apparaitra, et affichera la liste  des  termes  trouvés.
  469.   Cette liste est triée, et elle est conservée en mémoire jusqu'à ce que  vous
  470.   lanciez une autre recherche.
  471.  
  472. ConceptsAvancés
  473.  
  474.       La version 1.40 de ADoc a introduit la notion d'alias,  c'est-à-dire
  475.   un moyen de d'associer un même texte à  plusieurs  termes  différents,  sans
  476.   avoir à répéter le texte plusieurs fois. Pour créer un alias, il vous suffit
  477.   de définir un terme de la façon suivante :
  478.  
  479.       nom1 alias nom2
  480.  
  481.   Le premier caractère de "nom1" doit, comme pour toute définition  de  terme,
  482.   se trouver en colonne 1.  Il    doit  y  avoir    au  moins  un  espace  ou  une
  483.   tabulation entre  les  trois    mots.  Le  mot    "alias"  doit  être  écrit  en
  484.   minuscules. L'effet de cette définition est le suivant  :  si  l'utilisateur
  485.   demande à accéder au terme "nom1", ADoc affichera automatiquement  le  terme
  486.   "nom2". Les alias apparaissent dans la requête de terme,  et  sont  pris  en
  487.   compte par la fonction de recherche. Notez  qu'il  n'y  a  *AUCUN*  test  de
  488.   récursivité entre les différents alias !
  489.       Une  application  pratique  de  ces  alias  est   par   exemple   la
  490.   documentation d'une bibliothèque  de  fonctions  :  il  arrive  souvent  que
  491.   plusieurs fonctions soient définies ensemble. Avec le mécanisme des alias on
  492.   peut accéder à cette définition avec le nom de chaque fonction, alors que le
  493.   texte n'est défini qu'une seule fois.
  494.  
  495.       ADoc est capable d'associer automatiquement  plusieurs  fichiers  de
  496.   documentation. Il vous suffit d'indiquer le (ou les)  noms  des  fichiers  à
  497.   associer sur la première ligne du fichier auquel vous voulez    les  associer.
  498.   Si cette ligne reste vide, ou commence par un espace ou une tabulation,  son
  499.   contenu est ignoré. Les noms peuvent être séparés par des espaces ou par une
  500.   virgule. Vous pouvez indiquer un nom de  répertoire,    auquel    cas  tous  les
  501.   fichiers de ce répertoire seront  ouverts  (sauf  les  fichiers  ".info"  et
  502.   ".index").
  503.  
  504.       Pour étendre le jeu des caractères pouvant  être  utilisés  dans  un
  505.   terme, il vous suffit  d'indiquer  les  caractères  supplémentaires  sur  le
  506.   seconde ligne du fichier de documentation. Si cette  ligne  reste  vide,  ou
  507.   commence par un espace ou une tabulation, son  contenu  est  ignoré.    Sinon,
  508.   tous les caractères de cette ligne  (jusqu'au  premier  espace,  tabulation,
  509.   barre de fraction ou saut de page) sont ajoutés au  jeu  de  caractères  par
  510.   défaut. Notez que cette extension du jeu de caractères ne concernera que  ce
  511.   fichier.
  512.  
  513.       ADoc est capable de charger directement des fichiers    compactés  par
  514.   "PowerPacker", à condition  que  la  bibliothèque  "powerpacker.library"  se
  515.   trouve dans le répertoire "LIBS:". Il  n'est  pas  nécessaire  de  créer  le
  516.   fichier d'index avant le compactage, mais cela est recommandé. ADoc refusera
  517.   de charger un fichier crypté.
  518.       Après  décompactage,    le  fichier  sera  recopié  dans  un   fichier
  519.   temporaire  placé  dans  le  répertoire  "T:".  L'utilisation  de   fichiers
  520.   compactés peut donc poser des problèmes de mémoire, particulièrement    si  le
  521.   répertoire "T:" se trouve sur le disque "RAM:". Le fichier  temporaire  sera
  522.   détruit après sa fermeture.
  523.  
  524. ModeAREXX
  525.  
  526.       ADoc    ouvre  systématiquement  un  port  compatible    AREXX,     nommé
  527.   "ADoc_rexx". Les messages sur ce port sont attendus en même  temps  que  les
  528.   messages Intuition sur les fenêtres de texte, et peuvent prendre les    formes
  529.   suivantes :
  530.  
  531.       quit      quitte ADoc
  532.       request fait apparaître la requête de terme
  533.       fscreen ADoc ré-ouvre ses fenêtres sur l'écran au premier plan
  534.       tofront fait passer l'écran de ADoc au premier plan
  535.       toback  fait passer l'écran de ADoc au dernier plan
  536.       ?terme  lance la recherche du terme indiqué,    et  affiche  le  texte
  537.           correspondant s'il est trouvé
  538.       @fic      ouvre le fichier de documentation indiqué
  539.  
  540.       Le code retour (variable RC) est en général à zéro,  sauf  dans  les
  541.   cas suivants : requête  inconnue  (code  retour  20),  requête  "?terme"  et
  542.   "terme" non trouvé (code retour 5), requête  "request"  et  pas  de  nouveau
  543.   terme choisi (code retour 5). Voici  un  exemple  de  programme  AREXX,  qui
  544.   demande de l'aide sur le terme "alias" :
  545.  
  546.       /* Demande de l'aide sur "alias" */
  547.       ADDRESS "ADoc_rexx"
  548.       "?alias"
  549.       IF RC = 5 THEN SAY "not found !"
  550.  
  551.       Notez les guillemets autour des commandes !
  552.       Si vous lancez  ADoc    avec  l'option  AREXX,  le  fonctionnement  du
  553.   programme sera un peu différent : une fois le(s) fichier(s) de documentation
  554.   ouvert(s), ADoc n'ouvrira pas la requête de terme mais affichera le  message
  555.   "En attente d'un message AREXX" et attendra des messages sur le  port  AREXX
  556.   (ou CTRL-C pour quitter). De plus, lorsque la dernière fenêtre sera  fermée,
  557.   le programme ne se terminera pas  mais  repassera  en  attente  de  messages
  558.   AREXX.
  559.  
  560. Support_des_fichiers_AutoDoc
  561.  
  562.       ADoc est capable de reconnaitre et d'utiliser les  fichiers  AutoDoc
  563.   de Commodore. Dans la plupart des cas, aucune modification de  ces  fichiers
  564.   n'est nécessaire, mais il est quand même conseillé de vérifier leur format :
  565.   il doit y avoir au moins deux lignes vides au début, suivies de la table des
  566.   matières, et chaque terme doit commencer en colonne 1.
  567.       Dans certains cas, il manque les  lignes  vides  au  début,  et  les
  568.   termes commencent en colonne 2, précédés par un caractères  "saut  de  page"
  569.   (CTRL-L). Le programme "AutoConvert", distribué avec ADoc, vous permettra de
  570.   convertir ces fichiers au bon format (Note: ce programme ne peut  s'utiliser
  571.   que depuis le CLI). Dans tous les autres cas, il vous faudra    convertir  les
  572.   fichiers "à la main".
  573.  
  574. Support_des_fichiers_AmigaGuide
  575.  
  576.       ADoc est désormais capable de  reconnaitre  un  fichier  AmigaGuide,
  577.   d'en construire l'index et d'en afficher le contenu, en gérant  correctement
  578.   les différentes formes de la directive @node :
  579.  
  580.       @node nom
  581.       @node "titre"
  582.       @node nom "titre"
  583.  
  584.   Dans ce dernier cas, un alias "nom" est automatiquement défini pour le terme
  585.   "titre". La directive "@title" est reconnue également.
  586.       Comme ADoc ne permet pas d'utiliser des espaces  dans  les  noms  de
  587.   termes, ceux-ci sont remplacés par un caractère souligné. Les liens dans  le
  588.   texte sont affichés en gras. Les noms étant tronqués    à  32  caractères,  il
  589.   pourra arriver que certains liens ne fonctionnent pas. Notez que  ADoc  gère
  590.   les liens entre fichiers, comme par exemple :
  591.  
  592.             @{"toto" link help:general/titi}
  593.  
  594.   Pour permettre cela, les  délimiteurs  sont  automatiquement    initialisés  à
  595.   ":/." pour tous les fichiers AmigaGuide.
  596.  
  597. LesMessagesDeADoc
  598.  
  599.       Lorsqu'une erreur se produit, ADoc affiche dans une  petite  fenêtre
  600.   un nom (de fichier en général) et un code d'erreur.  Ce  code  d'erreur  est
  601.   soit un code d'erreur AmigaDOS soit un code interne. Dans  le  premier  cas,
  602.   reportez-vous à votre manuel de l'AmigaDOS (ou utilisez la commande "Fault")
  603.   pour avoir plus de détails sur ce code d'erreur.
  604.       Les codes d'erreur internes sont :
  605.  
  606.       -1      fichier vide
  607.       -2      erreur de lecture
  608.       -3      fichier incorrect (mauvais format, etc...)
  609.       -4      fichier compacté, et "powerpacker.library" absente
  610.       -5      problème lors du décompactage
  611.  
  612.  
  613.  
  614.  
  615.  
  616.