ADoc v3.10 - Manuel d'utilisation Réalisation : Denis GOUNELLE Idée originale : Jean-Yves PROUX Avertissement : --------------- Ce manuel décrit la version 3.10 de l'utilitaire ADoc. Ce programme est placé dans le domaine public, avec autorisation de le copier librement et de le diffuser par n'importe quel moyen, à condition qu'aucune contre- partie (financière ou autre) ne soit reclamée en échange, que le produit soit diffusé dans son intégralité, et sans aucune modification. ADoc est (C)1990 par Denis GOUNELLE, toute utilisation commerciale ou vente de ce programme (sans autorisation écrite) est STRICTEMENT INTERDITE. Malgrès de nombreux tests, je ne peux garantir que ce programme ne contient aucune erreur. VOUS UTILISEZ CE PROGRAMME A VOS RISQUES ET PERILS. Je ne pourrais en aucun cas être tenu responsable de tout dommage, direct ou indirect, résultant de l'utilisation de ce programme. Sommaire : ---------- 1. Introduction 2. Principe de fonctionnement 3. Mode d'emploi 3.1 Appel depuis le CLI 3.2 Appel depuis le WorkBench 3.3 Mode d'emploi 1.Introduction : ---------------- ADoc est un utilitaire permettant de disposer d'une aide permanante sur n'importe quel sujet. Il dispose d'une fonction (unique ?) de recherche d'un mot désigné à la souris. Vous pouvez me faire part de vos remarques ou critiques sur ADoc, en écrivant à l'adresse suivante : M. GOUNELLE Denis Boite n° 71 6, rue des cailloux 92110 CLICHY - FRANCE 2. Principe de fonctionnement : ------------------------------- ADoc travaille à partir d'un fichier d'aide, que vous pouvez créer vous-même au moyen d'un éditeur de texte. Ce fichier contient une suite de termes, chaque terme ayant la syntaxe suivante : terme ligne explication 1 ligne explication 2 . . . . . . ligne explication n Il est absolument indispensable que la première lettre de terme soit sur la colonne 1, et que les lignes d'explications commencent par au moins un espace ou une tabulation, car c'est le seul moyen pour ADoc de distinguer un terme d'une explication. Une ligne d'explication ne peut pas dépasser 78 caractères. On peut mettre au plus 25 lignes d'explication par terme en mode PAL (20 en mode NTSC). Un terme ne peut pas faire plus de 31 caractères et ne peut contenir d'espace ni de tabulation. Une fois ce fichier d'aide constitué, ADoc construit un index qui permet d'accéder presque instantanément au terme recherché. Le nom du fichier d'index est obtenu en ajoutant le suffixe '.index' au nom du fichier d'aide. Cet index est chargé en mémoire pour accélérer encore la recherche. ATTENTION : vous devez reconstruire l'index à chaque modification du fichier d'aide. 3. Mode d'emploi : ------------------ ADoc peut s'utiliser depuis le CLI ou depuis le WorkBench. Le fichier d'aide par défaut est "ADOC:Amiga.doc" mais on peut, dans les deux cas, indiquer un autre fichier. Ceci veut dire que vous pouvez avoir plusieurs fichiers d'aide en même temps, chacun sur un sujet différent, et sélectionner le fichier approprié quand vous avez besoin d'aide. 3.1 Appel depuis le CLI ----------------------- Depuis le CLI, la syntaxe de l'appel est la suivante : ADoc -i [-f] ou ADoc [-e] [-f] [] La première forme demande de créer ou de mettre à jour l'index du fichier d'aide, la seconde forme demande de l'aide. L'option -f permet de préciser le fichier d'aide à utiliser. L'option -e demande à ADoc d'ouvrir son propre écran, plutôt que d'utiliser l'écran WorkBench. Dans la seconde forme on peut indiquer le terme sur lequel on désire de l'aide, mais ce n'est pas obligatoire. 3.2 Appel depuis le WorkBench ----------------------------- Depuis le WorkBench, on peut appeler ADoc de trois façons : - en double-cliquant sur l'icone d'ADoc - en cliquant sur l'icone d'ADoc puis en double-cliquant sur l'icone d'un fichier d'aide, le tout en gardant la touche SHIFT appuyée - en cliquant sur l'icone d'un fichier d'aide puis en double- cliquant sur l'icone d'aide, le tout en gardant la touche SHIFT appuyée Quand ADoc est utilisé à partir du WorkBench, il ouvre son propre écran. 3.3 Mode d'emploi ----------------- Si le fichier d'index n'existe pas, ADoc ouvre une boite de requête pour vous proposer de le créer. Si vous répondez "OUI", l'index est créé, ce qui peut prendre un certain temps. Si vous répondez "NON", ADoc s'arrête et affiche un message d'erreur. Si vous appelez ADoc depuis le WorkBench, ou depuis le CLI mais sans indiquer le terme à chercher, une boite de requête apparait, avec la liste des termes connus. Vous pouvez alors cliquer deux fois sur le terme choisi, ou utiliser le gadget de chaine en bas de la fenêtre. Si le terme n'est pas trouvé, ou si vous cliquez sur le gadget de fermeture de la boite de requête, ADoc s'arrête. Si le terme est trouvé dans le fichier d'aide, une fenêtre apparait, avec le texte d'explication correspondant. Vous pouvez alors cliquer deux fois sur un mot du texte d'explication, ce qui lancera automatiquement la recherche de ce terme. Si vous désirez de l'aide sur un terme qui n'est pas dans l'explication, vous pouvez utiliser la commande `Autre terme' du menu `Projet' : une boite de requête apparait, avec la liste des termes connus. Si le terme n'est pas trouvé l'écran flashe, sinon l'aide est affichée dans une nouvelle fenêtre qui vient se superposer à l'ancienne. Si vous demandez de l'aide sur un terme dont l'aide est déjà affichée, la fenêtre correspondante est mise au premier plan. Pour quitter ADoc, vous pouvez soit fermer toutes les fenêtres une par une (NOTE : ADoc s'arrête automatiquement quand la dernière fenêtre est fermée), soit utiliser la commande `Quitte' du menu `Projet'.