home *** CD-ROM | disk | FTP | other *** search
/ Oakland CPM Archive / oakcpm.iso / cpm / sysutl / egutil53.lbr / WINDEX.DZC / WINDEX.DOC
Encoding:
Text File  |  1988-07-12  |  9.0 KB  |  196 lines
  1. ;;09-21-86
  2. Eric Gans
  3. French Department UCLA
  4. Los Angeles, CA 90024
  5.                            WINDEX.DOC
  6.                               v3.01
  7.  
  8. WINDEX features:
  9.  
  10. - allows indexing of words or strings up to 49 characters.
  11. - allows free capitalization format in index entries.
  12. - allows a page offset between -254 and 9999.
  13. - allows tagging keys (once!) within the text file.
  14. - allows indexing of (hard-)hyphenated words.
  15. - uses entire free memory (maximum of about 11000 page references 
  16. and a 17 K NDX file for a 60 K system -- e.g., Kaypro-10).
  17.  
  18. A  number of features have been added in versions 2 and 3 at  the 
  19. request of users, whom I thank for their interest.  
  20.  
  21. Version 3.01 (released 01/10/87)
  22.      Allows   straightforward  indexing  of  strings  (up  to  50 
  23. characters).    Streamlined  command  structure;  eliminated  all 
  24. internal prompts (for use in batch files).  Creates index entries
  25. exactly as entered.
  26.  
  27. Version 2.2 (3/20/86)
  28.      Allows  words  up  to 49 characters  (suggestion  of  Walter 
  29. Becker),  fixed  bug  in tree-sort routine;  improved version  of 
  30. ALPHA.COM (2.0).
  31.  
  32. Version 2.1 (2/21/86)
  33.      Calculates  BIOS  addresses so as to work with Wordstar  "R" 
  34. command. 
  35.  
  36.                               *****
  37.  
  38. WINDEX  creates  indexes for  Wordstar files written in  document 
  39. mode.   It  can  be  used to index a manuscript  of  any  length, 
  40. including books of up to 9999 pages, with a maximum of 254 keys.
  41.  
  42. Command line: windex [d:]fn.ft [@] [/offset] [*|#]
  43.  
  44. o     The index file (fn.NDX) will be placed on the same drive as 
  45. the file to be indexed.
  46.  
  47. o     Include @ in the command line if you want the index  output 
  48. to the screen (the file will be created in any case).  The output 
  49. can be aborted by typing ^C after the first page.
  50.  
  51. o     The  page offset (if any) should be entered  as  a  decimal 
  52. number between -255 and 9999.  All page numbers in the index will 
  53. be  increased by this offset.   This feature allows you to  index 
  54. manuscripts  that  do not start at page 1  (say,  chapters  in  a 
  55. book).  A  negative  offset may be used if page 1 is preceded  by 
  56. prefatory material; index entries that come before page 1 will be 
  57. listed as "-#".
  58.  
  59. o      The keywords to be WINDEXed can be entered in three modes, 
  60. indicated  by the last character on the command line:  <nothing>, 
  61. *, or #. 
  62.  
  63. 1.  (default)  Direct keyboard entry; you will be prompted at the 
  64. console.  This is the simplest approach for short indexes.
  65.  
  66. 2.  * (NB:  * replaces / used in earlier versions)  Keywords will 
  67. be  sought in a file fn.KWD on the same drive/user.  In  creating 
  68. this file, you need only avoid hyphens and the exotic punctuation 
  69. marks  [\]^_` The character / can be used between words to  index 
  70. strings;  it  will be treated as the equivalent of a space in the 
  71. file.  The  KWD  entry:  blurk/zap/zlonk will search  the  string 
  72. "blurk  zap  zlonk".  To tag this string in your  text  file,  it 
  73. should  appear as:  "^Pblurk zap  zlonk^P".  (NB:  the  non-break 
  74. spaces  [^O]  between words required in previous versions are  no 
  75. longer  necessary.)   
  76.  
  77.      All other characters,  including numbers,  periods,  commas, 
  78. semicolons or blanks,  are permitted as separators:  the simplest 
  79. way is to list the words with a CR after each.  Hyphenated  words 
  80. may be indexed.  The program will not find indexed words that are 
  81. contained in hyphenated groups: Mac will not be found in a search 
  82. for Big-Mac.   No other internal punctuation (e.g.,  apostrophes) 
  83. is  permitted.   Whatever  capitalization you choose for  entries 
  84. will be respected in the output (the search function will not pay 
  85. attention  to  capitalization).   You should avoid  entering  the 
  86. words in alphabetical order; letting the program alphabetize them 
  87. will  speed  up the indexing operation.   The same criteria  hold 
  88. true if you prefer to enter your word list from the keyboard.
  89.  
  90. 3.  (#)  Keywords will be tagged in the file to be indexed.  This 
  91. allows you to create your index as you go along.  ^P (entered  as 
  92. ^PP) must precede and follow each keyword or string.  The maximum 
  93. string  length permitted is 49 characters (v2.2).  
  94.  
  95. o    You  only  have to tag keywords ONCE,  not every  time  they 
  96. appear as with STARINDEX.  Duplicates will be ignored.
  97.  
  98. o    Because of the string-indexing feeature added in  v3.0,  all 
  99. index  entries  indicated  within the file itself  must  be  both 
  100. preceded and followed by ^P.
  101.  
  102.  
  103. The  output  file  (on  the  same  drive)  will  be  fn.NDX.   An 
  104. approximate  right margin of 65 will be adhered to;  CR's will be 
  105. added  after each line and second and succeeding lines  of  index 
  106. entries  will be tabbed.   This file can be edited with  Wordstar 
  107. and  converted  if you like to document mode (this  doesn't  seem 
  108. appropriate for an index, however).
  109.  
  110. If  you  have  more than 254 keywords,  you  should  divide  them 
  111. alphabetically  into two or more groups.  (ALPHA.COM will do this 
  112. for you.)  You can then combine the indexes later in alphabetical 
  113. order using PIP or Wordstar's ^KR command.
  114.  
  115. WINDEX  allocates  about  2/3 of the free  memory  to  the  page-
  116. reference buffer and about 1/3 for the NDX file.  This allows (on 
  117. a  60  K Kaypro-10) for about 17 K for the file and 34 K for  the 
  118. buffer,  or  about  11000  references  at  3  bytes  each.  (This 
  119. proportion is based on the fact that many references are multiple 
  120. appearances on the same page that do not appear in the NDX file.) 
  121. This  should  be enough for any normal use of  the  program  (110 
  122. references/page in a 100-page manuscript!) In case you somehow do 
  123. run  out  of  memory,  WINDEX  will recognize  when  the  CCP  is 
  124. overwritten  and do a Warm Boot,  but it doesn't check if you  go 
  125. even further.  But long before you get to that point,  you should 
  126. divide  your  keyword list into smaller alphabetical  groups  and 
  127. index them separately.  As long as you keep the different indexes 
  128. in  alphabetical order (you'll also have to change their names if 
  129. you keep them on the same disk),  you can PIP them together  with 
  130. no internal editing save removal of a few headings.
  131.  
  132. Hyphens:
  133.  
  134. Wordstar  distinguishes  between hard hyphens  (those  you  enter 
  135. yourself)  and  soft hyphens (entered for  formatting  purposes).  
  136. WINDEX skips over soft hyphens,  since they merely break words at 
  137. the  end  of lines;  hard hyphens are treated as letters  in  the 
  138. keyword and in the file.  This remains true even when they  occur 
  139. at the end of a line;  the difference is that you entered them as 
  140. part of a hyphenated word.
  141.  
  142. Features:
  143.      - makes  use of a binary tree for maximum search speed  (5-6 
  144. seconds for a 40K file)
  145.      - occupies less than 3K on disk
  146.  
  147. Limitations: 
  148.      - won't    recognize   words   with   internal   punctuation 
  149. other than hyphens (apostrophes, accents, &c.) 
  150.      - only  works  with files saved in document mode  (it  needs 
  151. this  for  its page-count feature)  
  152.      - all  files (fn.ft,  fn.KWD,  fn.NDX) must be on same drive 
  153.  
  154. Warning:  
  155.      - WINDEX will create a new NDX file each time it is run  and 
  156. delete  any previous file of the same name.  You must rename  old 
  157. index files you want to save before rerunning the program.
  158.  
  159. Trick:
  160.      - You  can rename an old NDX file as a KWD file,  since  the 
  161. program  won't notice the numbers following the  entries.  Before 
  162. you  do this,  don't forget to delete the heading within the  NDX 
  163. file.
  164.  
  165. *****************************************************************
  166.  
  167. ALPHA.COM v2.0 (3/19/86)
  168.  
  169. Command line: alpha [d:]fn.ft [/]
  170.  
  171. Partly  in  response to a request from Donald Giroux,  ALPHA  now 
  172. makes  a  file  containing the alphabetized list  (one  word  per 
  173. line);  it  now  counts words and different words but  no  longer 
  174. keeps  track of the number of times each word is used  (this  was 
  175. eliminated to save 2 bytes per word - if protests are heard I can 
  176. reintroduce  it  as  an  option).    Also  added  is  support for
  177. hyphens  and  non-break spaces (^O).   (The latter are no  longer 
  178. required by WINDEX,  but if you use them,  ALPHA will alphabetize 
  179. strings.)
  180.  
  181. ALPHA is meant to facilitate finding keywords in your  files;  it 
  182. can also be used (as Mr. Giroux remarks) for fast spell-checking.  
  183. ALPHA  uses  a  binary tree to sort all the words in  a  file  in 
  184. alphabetical order and put the list in a file of type ALP as well 
  185. as printing it on the screen.   Up to 3072 different words can be 
  186. accommodated  (this means about 15-20 K total words,  or say  90-
  187. 120K  bytes).  
  188.  
  189. The / option will limit the word list to capitalized words.  Many 
  190. of  these  will be The or This,  but you will also find  all  the 
  191. proper names in your file.  ALPHA allows internal apostrophes  as 
  192. well as hyphens.  (I didn't allow for apostrophes in WINDEX since 
  193. when  you write an index you usually want to include  possessives 
  194. under  the  possessor:  if  you are indexing  "Smith,"  you  want 
  195. instances of "Smith's" to be included, not listed separately.)
  196.