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
Wrap
Text File
|
1990-12-07
|
5KB
|
147 lines
ADoc v3.10 - User's manual
Programmed by : Denis GOUNELLE
Original idea : Jean-Yves PROUX
This file describe release 3.10 of the utility ADoc. This program
is public domain, and permission is granted to freely distribute and copy
it, provided no charge or fee is ask for, and no modification is done to
this package.
ADoc is copyright (C)1990 by Denis GOUNELLE, any commercial usage
or selling of this program, without writing authorization, is forbiden.
No warranty is made that there's no errors in this program. YOU USE
THIS PROGRAM AT YOUR OWN RISKS. In no event will I be liable for any
dammage, direct or indirect, resulting of the use of ADoc. This file is a
quick translation of the french documentation file, and no warranty is
given about the quality of this translation.
Sommaire :
----------
1. Introduction
2. How does it work
3. User's manual
3.1 Running from CLI
3.2 Running from WorkBench
3.3 User's manual
1.Introduction :
----------------
ADoc is a help utility that allow you to have permanent help on
any subject you want. Major feature is automatic searching of the word on
which you click.
You can send suggestions and criticism (or gifts...) writing to :
M. GOUNELLE Denis
Boite n° 71
6, rue des cailloux
92110 CLICHY - FRANCE
2. How does it work :
---------------------
ADoc works with a help file created with a text editor. This file
contains a list of terms, each terms having the following syntax :
term
explanation line 1
explanation line 2
. . .
. . .
explanation line n
The first letter of each term MUST be at column 1, and the
explanation lines MUST begin with at leat one space or tab. A term can't be
more than 31 characters long and can't contain any space or tab. An
explanation line can't be longer than 78 characters, and there can't be no
more than 25 lines (for PAL screens, 20 for NTSC screens) for each term.
Once the help file have been created, ADoc builts an index file, to
speed up term searching. The name of the index file is the name of the help
file with a '.index' suffix. This index file is loaded in memory to speed
up things again.
CAUTION : you MUST re-create the index file each time you
modify the help file.
3. User's manual :
------------------
ADoc can be called from CLI and WorkBench. Default help file is
"ADOC:Amiga.doc", but you can (in both cases) specify another file. This
mean that you can have several help files at the same time, each on one
different subject, and select the appropriate file when you need help.
3.1 Running from CLI
--------------------
Command line syntax is :
ADoc -i [-f<file>]
ou ADoc [-e] [-f<file>] [<term>]
The first form ask for index creation, and the second one ask for
help. Use the -f<file> option to specify another help file than the default
one, and -e option to tell ADoc that you want it to open its own screen
(instead of using WorkBench screen).
When you use the second form, you can specify the term on which you
want help, but it's optional.
3.2 Running from WorkBench
--------------------------
From WorkBench, you can call ADoc by three ways :
- double-click on ADoc's icon (assuming you use default
help file)
- click on ADoc's icon and double-click on help file's icon,
holding the SHIFT key down
- click on help file's icon and double-click on ADoc's icon,
holding the SHIFT key down
When ADoc is called from WorkBench, it always open its own screen.
3.3 User's manual
-----------------
If the index file doesn't exist, ADoc opens a requester and ask you
if you want to create it. If you answer "YES", the index file is created
(this operation can take some time...). If you answer "NO", ADoc stops and
displays an error message.
If you have called ADoc from WorkBench, or from CLI but without
giving a term to search, a requester appears with a list of the known
terms. You can click twice on the chosen term, or use the string gadget on
the bottom of the requester.
If the term isn't found, or if you click on the close gadget of the
requester, ADoc stops.
Else, a window apears and shows the explanation lines of the term.
You can now click twice on a word of the text, to activate the automatic
searching function. If you want help upon something that isn't in the text,
use the `Other term' command of the `Project' menu : a requester with the
list of the known terms will apear.
If the term isn't found the screen will flash, else another window
will be opened. If you asked help upon a term which has already an opened
window, this window will come in front of the others windows.
To quit ADoc, you can close all windows (ADoc stops when the last
window is closed) or use the `Quit' command of the `Project' menu.