home *** CD-ROM | disk | FTP | other *** search
/ PD ROM 1 / PD ROM Volume I - Macintosh Software from BMUG (1988).iso / Text / MacWrite Utilities / Index.help < prev    next >
Encoding:
Text File  |  1986-02-16  |  5.6 KB  |  150 lines  |  [TEXT/ttxt]
  1.  
  2. Index is a very simple program which aids in producing indexes for MacWrite 
  3. 4.5 files.  In a nutshell, Index reads in one page at a time from a 
  4. MacWrite file, and allows you to select words to be added to the index.  
  5. The file created by Index is simply a list of words (un-sorted) with page 
  6. numbers next to them, one per line.  A Unix utility such as 'sort' may then 
  7. be used to alphabetize the list.  For instance, if you have created a list 
  8. called 'Book.Index' with Index, upload it to your Unix mainframe, and do 
  9. the following:
  10.  
  11. sort -f Book.Index > Book.Index.sort
  12.  
  13. This creates an alphabetically sorted list on your mainframe, which you can 
  14. then download to your mac and clean up.  
  15.  
  16. So as you can see from the above, Index is not the total solution to 
  17. creating indexes -- you still need some method of sorting the resulting 
  18. index file.
  19. >>
  20.  
  21. Menu Commands:
  22.  
  23. Index Menu:  Commands on this menu refer to the files of index entries
  24.      created by Index. 
  25.  
  26.   New...  When you select this item, you are asked to specify the name
  27.           and location of the new index file.  This file is then created,
  28.           and an index window will appear at the bottom of your screen.
  29.           
  30.   Open... Select this item when you wish to continue working on a 
  31.           previously created index file.
  32.           
  33.   Save    While you are working on an index, individual entries are
  34.           saved to the file as soon as you enter them -- select Save
  35.           to flush the volume and make sure that the file is o.k.
  36.  
  37. >>
  38.   FeedBack  When there is a checkmark next to this item, the Macintosh
  39.           will beep each time you add a new index entry.
  40.  
  41.   Help    Answers to simple questions.
  42.   
  43.   Run...  Select this item when you are through indexing, and wish to
  44.           directly start up another application.
  45.  
  46.   Quit    Select this when you are all through, and wish to return to
  47.           the Finder.
  48.             
  49. Edit Menu
  50.   
  51.   All items on this menu work only with desk accessories...
  52.  
  53. >>
  54.  
  55. Document Menu: All items on this menu refer to the MacWrite file currently 
  56.      being indexed.
  57.  
  58.   Open... Select this item when you wish to load the first page of
  59.           some MacWrite file in to be indexed.
  60.           
  61.   Next Page  Reads the next page of the MacWrite file in.  Index will
  62.           beep at you when there are no more pages to read in.
  63.   
  64.   Up      Scroll the document display window back one screenful.
  65.   Down    Scroll the document display window forward one screenful.
  66.   
  67.   True Numbering   When there is a checkmark next to this item, the
  68.           page number in the index window will always agree with the
  69.           true page number of the current MacWrite file page.  If there
  70.           is no checkmark by 'True Numbering', Index will just increment 
  71.           the page number each time  a new page is read in.
  72. >>
  73.  
  74. Words Menu:  The two items on this menu perform the exact same functions as 
  75.      the buttons in the index window (described below) with the same 
  76.      titles.
  77.  
  78.  
  79. The Index Window
  80.  
  81.      When you open a new index file, a dialog window will appear at the 
  82. bottom of your screen: this is the index window.  The general idea here
  83. is that the index entry, section name or abbreviation, and page number
  84. are entered and maintained in different fields of the index window.  When
  85. you select 'Add Entry', these three pieces of information are concatenated
  86. and placed in the current index file as a single line of text.
  87. >>
  88.  
  89. The fields and controls of the index window are as follows:
  90.  
  91. Index Entry Field (long skinny editable text box):  Whenever a word or
  92.      range of text is selected in the document display window, it will
  93.      be copied into this area.  You can edit or type directly into here,
  94.      too. 
  95.  
  96. Section Entry Field (small editable text box at the far left)  If you put 
  97.      text in this field, it will be concatenated with the page number
  98.      and added to each entry when you select 'Add Entry'.
  99.      
  100. Page Number Field (editable text item to the left of the 'Back Up'
  101.      button)  This field contains the current page number of the 
  102.      text appearing in the document display window.  You can change
  103.      this number any time (see comments about 'True Numbering', above).
  104. >>
  105.  
  106.  
  107.  
  108. Add Entry   Click in this button to add the current entry to the index
  109.      file.
  110.  
  111. Back Up  Click in this button if you want to remove the last index entry
  112.      added to the file with Add Entry.  You can only remove the most
  113.      recent entry (Index will beep at you if you try to back up further
  114.      than this).
  115.      
  116. >>
  117.  
  118. Caveats:
  119.  
  120. Index does not break up paragraphs on page boundaries: if a paragraph
  121. spills over from one page to the next, Index will indicate that it is
  122. all located on the initial page.  
  123.  
  124. Occasionally, paragraphs that are less than a line long, and are also the
  125. first line on a given page will be read in as part of the previous page.
  126.  
  127. Error handling is not magnificent.  In general, if some kind of i/o error
  128. occurs, Index will just beep at you.  So, if you start hearing beeps,
  129. beware.  
  130.  
  131. Since each new entry is added to the disk file as soon as you select
  132. Add Entry, the disk will run a lot.  Running Index on a floppy is
  133. not too bad, but there is a noticeable pause for each write (unless
  134. you have disk caching).
  135. >>
  136.  
  137.  
  138. Given Index's imperfections, we have found that it is desirable to 
  139. have a hardcopy of the file or manuscript sitting next to the 
  140. keyboard during index creation.  Index is clearly not a total solution
  141. to this task but it is definitely better than nothing.  I have been told
  142. that a commercial index program is due 'real-soon-now', so keep your
  143. eyes open for that.
  144.  
  145.  
  146. Scott Gillespie
  147. Reed College
  148. February 10, 1986
  149.  
  150.