home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 445.lha / ADoc_v3.10 / ADocEnglish.doc.pp / ADocEnglish.doc
Encoding:
Text File  |  1990-12-07  |  5.4 KB  |  147 lines
  1.  
  2.                             ADoc v3.10 - User's manual
  3.  
  4.                          Programmed by : Denis  GOUNELLE
  5.                          Original idea : Jean-Yves PROUX
  6.  
  7.  
  8.  
  9.  
  10.  
  11.         This file describe release 3.10 of the utility ADoc.  This  program
  12. is public domain, and permission is granted to freely distribute  and  copy
  13. it, provided no charge or fee is ask for, and no modification  is  done  to
  14. this package.
  15.  
  16.         ADoc is copyright (C)1990 by Denis GOUNELLE, any  commercial  usage
  17. or selling of this program, without writing authorization, is forbiden.
  18.  
  19.         No warranty is made that there's no errors in this program. YOU USE
  20. THIS PROGRAM AT YOUR OWN RISKS. In no  event  will  I  be  liable  for  any
  21. dammage, direct or indirect, resulting of the use of ADoc. This file  is  a
  22. quick translation of the french documentation  file,  and  no  warranty  is
  23. given about the quality of this translation.
  24.  
  25.  
  26. Sommaire :
  27. ----------
  28.  
  29.         1. Introduction
  30.         2. How does it work
  31.         3. User's manual
  32.            3.1 Running from CLI
  33.            3.2 Running from WorkBench
  34.            3.3 User's manual
  35.  
  36.  
  37. 1.Introduction :
  38. ----------------
  39.  
  40.         ADoc is a help utility that allow you to  have  permanent  help  on
  41. any subject you want. Major feature is automatic searching of the  word  on
  42. which you click.
  43.  
  44.         You can send suggestions and criticism (or gifts...) writing to :
  45.  
  46.                         M. GOUNELLE Denis
  47.                            Boite n° 71
  48.                        6, rue des cailloux
  49.                       92110 CLICHY - FRANCE
  50.  
  51.  
  52. 2. How does it work :
  53. ---------------------
  54.  
  55.         ADoc works with a help file created with a text editor.  This  file
  56. contains a list of terms, each terms having the following syntax :
  57.  
  58.                 term
  59.                         explanation line 1
  60.                         explanation line 2
  61.                            .    .    .
  62.                            .    .    .
  63.                         explanation line n
  64.  
  65.         The first letter of  each  term  MUST  be  at  column  1,  and  the
  66. explanation lines MUST begin with at leat one space or tab. A term can't be
  67. more than 31 characters long  and  can't  contain  any  space  or  tab.  An
  68. explanation line can't be longer than 78 characters, and there can't be  no
  69. more than 25 lines (for PAL screens, 20 for NTSC screens) for each term.
  70.  
  71.         Once the help file have been created, ADoc builts an index file, to
  72. speed up term searching. The name of the index file is the name of the help
  73. file with a '.index' suffix. This index file is loaded in memory  to  speed
  74. up things again.
  75.  
  76.         CAUTION : you MUST re-create the index file each time you
  77.                   modify the help file.
  78.  
  79.  
  80. 3. User's manual :
  81. ------------------
  82.  
  83.         ADoc can be called from CLI and WorkBench.  Default  help  file  is
  84. "ADOC:Amiga.doc", but you can (in both cases) specify  another  file.  This
  85. mean that you can have several help files at the same  time,  each  on  one
  86. different subject, and select the appropriate file when you need help.
  87.  
  88.  
  89.         3.1 Running from CLI
  90.         --------------------
  91.  
  92.         Command line syntax is :
  93.  
  94.                         ADoc  -i  [-f<file>]
  95.                      ou ADoc [-e] [-f<file>] [<term>]
  96.  
  97.         The first form ask for index creation, and the second one  ask  for
  98. help. Use the -f<file> option to specify another help file than the default
  99. one, and -e option to tell ADoc that you want it to  open  its  own  screen
  100. (instead of using WorkBench screen).
  101.         When you use the second form, you can specify the term on which you
  102. want help, but it's optional.
  103.  
  104.  
  105.         3.2 Running from WorkBench
  106.         --------------------------
  107.  
  108.         From WorkBench, you can call ADoc by three ways :
  109.  
  110.         - double-click on ADoc's icon (assuming you use default
  111.           help file)
  112.         - click on ADoc's icon and double-click on help file's icon,
  113.           holding the SHIFT key down
  114.         - click on help file's icon and double-click on ADoc's icon,
  115.           holding the SHIFT key down
  116.  
  117.         When ADoc is called from WorkBench, it always open its own screen.
  118.  
  119.  
  120.         3.3 User's manual
  121.         -----------------
  122.  
  123.         If the index file doesn't exist, ADoc opens a requester and ask you
  124. if you want to create it. If you answer "YES", the index  file  is  created
  125. (this operation can take some time...). If you answer "NO", ADoc stops  and
  126. displays an error message.
  127.  
  128.         If you have called ADoc from WorkBench, or  from  CLI  but  without
  129. giving a term to search, a requester appears  with  a  list  of  the  known
  130. terms. You can click twice on the chosen term, or use the string gadget  on
  131. the bottom of the requester.
  132.  
  133.         If the term isn't found, or if you click on the close gadget of the
  134. requester, ADoc stops.
  135.  
  136.         Else, a window apears and shows the explanation lines of the  term.
  137. You can now click twice on a word of the text, to  activate  the  automatic
  138. searching function. If you want help upon something that isn't in the text,
  139. use the `Other term' command of the `Project' menu : a requester  with  the
  140. list of the known terms will apear.
  141.         If the term isn't found the screen will flash, else another  window
  142. will be opened. If you asked help upon a term which has already  an  opened
  143. window, this window will come in front of the others windows.
  144.  
  145.         To quit ADoc, you can close all windows (ADoc stops when  the  last
  146. window is closed) or use the `Quit' command of the `Project' menu.
  147.