home *** CD-ROM | disk | FTP | other *** search
/ Current Shareware 1994 January / SHAR194.ISO / clipart / grfbook.zip / INDEX.DOC < prev    next >
Text File  |  1993-05-28  |  6KB  |  141 lines
  1.                       INDEX, ver. 1.5 (c)1993 EFD Systems
  2.                               All Rights Reserved
  3.  
  4. INDEX is a simple (and somewhat crude) utility designed to help compile a
  5. standard word/page type index or a table of contents for TXTBook and GRFBook
  6. documents.  This utility can be used interactively, to index one word at a time,
  7. or in batch mode by using DOS redirection to read and write to and from files.
  8. Most word processors (WordPerfect, WordStar, etc.) have built-in features to
  9. perform these tasks.  These built-in features are probably more convenient and
  10. should be used if available; otherwise, use this utility.
  11.  
  12.  
  13. * INTERACTIVE MODE
  14.  
  15. To use this utility interactively, type:  INDEX bookname.txt options
  16.  
  17. 'bookname.txt' is the name of the ASCII document file.  Options MUST designate
  18. the document type, either "T" (TXTBook file, 24 lines/pg), or "G" (GRFBook file,
  19. 29 lines/pg).  Option "E" can be added to echo as output the lines found
  20. containing the given index word.
  21.  
  22. EXAMPLES:  INDEX mybook.doc g     (GRFBook file)
  23.            INDEX mybook.doc te    (TXTBook file, echo lines)
  24.  
  25. In interactive mode, the user is prompted to enter each word to be indexed one
  26. at a time.   Type "END" to exit the utility and return to DOS.
  27.  
  28.  
  29. * BATCH MODE
  30.  
  31. Batch mode makes use of DOS redirection to read/write to/from files instead of
  32. reading the keyboard and writing to the screen.  For batch mode use type:
  33.  
  34.                   INDEX bookname.txt options <wordlist >output
  35.  
  36. Wordlist is an ASCII file containing a list of the words that you wish to index,
  37. one word per line.  Use "END" as the last word in the list, otherwise; the
  38. program will hang at the end of the file waiting for input and you will have to
  39. re-boot the computer since keyboard input is no longer recognized.  Output is
  40. the name of the file that you wish to send the index results to.  "<" and ">"
  41. are DOS redirection symbols.  See your DOS manual if you need more details on
  42. DOS re-direction.  Note that the time required to index each word increases with
  43. the size of the file.
  44.  
  45.  
  46. * BUILDING A WORD/PAGE INDEX
  47.  
  48. This utility is a general purpose tool which can be used in a variety of
  49. different ways depending upon the user's needs, preferences, skills and
  50. imagination.  For example, to create a standard back-of-the-book word/page index
  51. for a GRFBook document, any of the following options could be used.
  52.  
  53. Option 1
  54.  
  55. Use INDEX interactively by typing:
  56.  
  57.                                INDEX mybook.txt g
  58.  
  59. Manually type each word to be indexed.  Results are displayed on the screen and
  60. must be manually copied or printed with the DOS Print Screen key.  After the
  61. index has been built, edit the document file and manually add the index
  62. information.  This option is good for short, simple documents.
  63.  
  64. Option 2
  65.  
  66. Use your editor/word processor to prepare an ASCII file containing a list of the
  67. words you wish to index, one word per line.  Use DOS redirection to pipe the
  68. prepared word list into INDEX.  Use DOS redirection again to send results out to
  69. yet another file.  The command line should look something like this:
  70.  
  71.                    INDEX mybook.txt g <words.lst >results.txt
  72.  
  73. Use your editor to dress up the results stored in 'results.txt' and then merge
  74. results.txt into the document using your editor; or, use the DOS copy command to
  75. append results.txt to the end of the document file like this:
  76.  
  77.                      COPY mybook.txt+results.txt mybook.txt
  78.  
  79. This option is better for long documents.
  80.  
  81. Option 3
  82.  
  83. Any combination of the above options is also possible.  You can read a word list
  84. from a file but display the results to the screen like this :
  85.  
  86.                          INDEX mybook.txt g <words.lst
  87.  
  88. Likewise, you can enter words interactively while re-directing the results to a
  89. file like this :
  90.                         INDEX mybook.txt g >results.txt
  91.  
  92.  
  93. * BUILDING A TABLE OF CONTENTS
  94.  
  95. The [E]CHO option can be put to good use to help build a table of contents for a
  96. document.  As you are preparing the document, use any unique character or string
  97. of characters to mark the section headings that you would like to list as
  98. entries in the table.  For example, in this document, an asterisk marks each
  99. section heading.  Leave a blank page(s) in the document as a place holder for
  100. the table of contents.  This is essential if you are to avoid changing all of
  101. the document page numbers when the table of contents is merged in.  When the
  102. document is almost finished, use INDEX with echo to find the unique character or
  103. string and display the section headings followed by a comma and the heading page
  104. number.
  105.  
  106. This file provides an example.  Exit to DOS now and type : INDEX index.doc ge
  107. When prompted for a word to index, type an asterisk, [*], and press [ENTER].
  108. Each heading, followed by it's page number, should be echoed to the screen.  As
  109. was the case earlier, results can be re-directed to a file.  This allows the
  110. table of contents to be refined and then merged into the actual document.  To
  111. re-direct the table, use a command line similiar to this:
  112.  
  113.                          INDEX mybook.txt ge >table.txt
  114.  
  115.  
  116. * NOTES
  117.  
  118. - To get a feel for how this utilty works, practice using it on this file.
  119.   Start INDEX in interactive, GRFBook, echo mode by typing:
  120.  
  121.                                INDEX INDEX.DOC ge
  122.  
  123.   When prompted for the word to index, type: '*' <enter>.  A list of the major
  124.   headings for this document (which all begin with '*') should be displayed on
  125.   the screen.  Type: END <enter> to exit.
  126.  
  127. - Unique characters for identifying section headings and preparing a table of
  128.   contents can be placed out of sight beyond column 80 and left in place as part
  129.   of the document.
  130.  
  131. - Words are indexed without regard to capitalization (case-insensitive).
  132.  
  133. - Only exact matching words are indexed.  For example, SUPERSTITION is not
  134.   considered to be a match for the index word SUPER.
  135.  
  136. - In interactive mode, all input is accepted on the top line of the screen. This
  137.   may initially be somewhat confusing since the cursor is always located where
  138.   the next output will take place.
  139.  
  140. - See TXTBOOK.DOC or GRFBOOK.DOC for license and disclaimer information.
  141.