[futurebasic] [FB^3] Indexing manual with eDOC

Message: < previous - next > : Reply : Subscribe : Cleanse
Home   : November 1999 : Group Archive : Group : All Groups

From: Ken Shmidheiser <kshmidheiser@...>
Date: Mon, 1 Nov 1999 11:28:50 -0500
I think we've all been struggling with optimizing use of FB^3's eDOC 
Reference Manual. Unfortunately, the manual was delivered without an 
index. For those on the list interested in creating a very handy 
index, you may find the following suggestions helpful:

1). To perform the indexing, you will need to download the latest 
shareware version of eDOC Reader 2.1.1 from:

http://perso.wanadoo.fr/michel.touchot/

2). Install eDOC Reader. (Note: A new Chooser extension which allows 
creation of  eDOC documents is installed without notification to the 
user.)

3). Prior to launching the eDOC Reader application, I suggest you 
increase the application's memory allocation to as much as you can 
afford for the one-time indexing operation. (I set mine at 50MB). The 
default settings may cause eDOC to run out of memory before indexing 
is completed. (I did not experiment to determine the minimum memory 
partition to peform the indexing.)

4). From inside eDOC Reader, open your FB^3 Reference.

5). In your menu bar, go to Edit -> Edit Index. This creates a 
double-arrow split window adjuster in the lower left-hand corner of 
your FB^3 Reference window. Once this is created, you can move the 
adjuster to open the new blank index window.

6). Indexing is based on font point size, giving the user several 
options. After being certain Edit -> Copy/Drag -> Text was selected, 
I chose to go to Page 3 and selected the word "Introduction."

7). With "Introduction" still selected, I went to Index -> Set Item 
Level -> Level 1.

8). I next scrolled down to Page 13 and selected the heading "#DEFINE 
statement".

9). With "#DEFINE statement" still selected, I went to Index -> Set 
Item Level -> Level 2.

10). Optionally, you may want to go yet another level deeper (I did) 
and while still on Page 13 lasso the subheading "Syntax:" and set it 
as Index -> Set Item Level -> Level 3.

11). With your levels set, you can go to Index -> Build Index (or Cmd 
K), and in less than a minute (on my G3 converted 8100) your new 
index is ready. You can monitor the process by watching the pages 
being indexed in the box at the lower right corner of the window. If 
indexing stalls before completion, increase eDOC's memory partition 
and try again.

12). Once your index is created, you can use the standard Mac 
convention of holding down the Option key while clicking on the Index 
expander triangles to collapse or expand the thread. The completed 
index is very similar to FB's  familiar help menus. The index also 
can be collapsed or hidden. When you reopen the completed stand-alone 
Reference, you will find that the index has changed to a much nicer 
appearance than when opened in eDOC.

The indexing process is one that is simpler to do than explain. I 
hope these instructions have not obsfucated that fact. The index has 
greatly improved my ability to use the FB^3 Reference efficiently and 
I hope it does the same for you.

Let me know what you think.

Ken


___________________________________________________________________
Ken Shmidheiser               Systems Administrator/General Manager
Internet: kshmidheiser@...       Fax:  606.679.9225
Somerset, KY 42502-0221                        Phone:  606.679.4266
___________________________________________________________________