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