home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / wp / pc_idx30.zip / PCI.HLP < prev    next >
Text File  |  1990-08-04  |  36KB  |  833 lines

  1.                        |INTRODUCTION TO PC-INDEX^
  2.  
  3. PC-INDEX is designed to produce the type of an index that you would
  4. find in the back of a book or reference manual.  There are many
  5. options available and two types of indexes that can be created with
  6. PC-INDEX.
  7.  
  8. Both index types are described here along with a section of that 
  9. index type as an example.  
  10. |
  11. 1) Single Word Index:^  An index can be created listing every
  12. occurrence of every single word in a document.  Optionally, you can
  13. include only the words you specify, or you can eliminate all
  14. occurrences of the 1000 most common words in the English language. 
  15. You can even tell PC-INDEX to only index capitalized words (like
  16. names).  
  17.                
  18.                 |Single Word Index Example:
  19.  
  20.  
  21. -----  A  -----                    bottom 9-10, 13
  22. abbreviation 8                     box 10, 14
  23. abort 22                           boxes 15
  24. absence 8                          brackets 8, 18
  25. acceptance 2                       BRADLEY 1-2
  26. accordingly 20                     breaks 5
  27. accurate 5                         brief 11
  28. accurately 5                       broken 12
  29. active 8, 15, 18                   Brown 4
  30. actual 9, 13                       Build 2, 9, 11-12
  31. adapter 20                         building 4
  32. add 16-18                          builds 14
  33. added 4                            built 14
  34. addition 4                         bw 20^
  35.  
  36. |
  37. 2) Phrase Index:^  An index can be generated listing all phrases that
  38. you specify.  PC-INDEX will even find phrases that wrap from one line
  39. to another or from one page to another.  
  40.  
  41.                     |Phrase Index Example:
  42.  
  43. -----  A  -----                      -----  I  -----
  44. automatically 21                     index 1-22
  45.                                      
  46.                                      
  47. -----  B  -----                      -----  O  -----
  48. Black and White monitor 20           on line help 4
  49. Bradley 1-2                          Option Menu 2, 11
  50. build index 2, 9, 11-12              options 3, 6-8, 11, 15-20
  51.                                      
  52.                                      
  53. -----  C  -----                      -----  Q  -----
  54. copyright 1-2, 11, 15, 19-20         Quick Start Example 2, 5
  55. Court 1-2                            
  56. created 3, 5-6, 8-9, 12-14, 21-22    ^
  57.  
  58.  
  59.  
  60.  
  61.  
  62.                        |SYSTEM REQUIREMENTS^
  63.  
  64. The minimum requirements for PC-INDEX are 640K of RAM, one floppy disk
  65. drive, and DOS 2.1.   A hard disk drive is highly recommended and may
  66. be necessary for larger files.
  67.  
  68. @
  69.  
  70.  
  71.                   |INDEX TYPE ONE:  SINGLE WORD INDEX^
  72.  
  73. There are two single word indexes available with PC-INDEX.  The first
  74. is capable of producing an index on every single word in a document. 
  75. The second index type will only index capitalized words.  Both single
  76. word indexes function identically, except for this.
  77.  
  78. Controls are available which allow you to either include only the
  79. words you want or to automatically discard common words like 'a',
  80. 'and', 'the', etc.
  81.  
  82. To begin using PC-INDEX type PCI and press enter.
  83.  
  84.  
  85.  
  86.                    |STEP ONE:  Extract Single Words^
  87.  
  88. This option will extract each word in a document, one at a time, and
  89. record them in sorted order along with the page number that they occur
  90. on.  Many words like a, and, the, if, of, etc will be eliminated and
  91. will not be recorded unless you change the options.
  92.  
  93. First, select Text (ASCII) as the document type from the Document
  94. menu.  If the wrong document type is selected, results will be
  95. unpredictable (and incorrect).  
  96.  
  97. Next, select the Extract Single Words option or the Extract
  98. Capitalized Words option from the FILE menu, by using the cursor keys
  99. and pressing ENTER.  You should now see a new window asking you for an
  100. input filename, an output filename, the page size, the first page
  101. number to start indexing on, and the first page number to use.
  102.  
  103. For the input filename type 'PCI.DOC' and press enter.  For the
  104. output filename type 'PCI.SRT' and press enter.  Since this document
  105. was created using 60 lines per page (the standard for letter size
  106. paper is usually 66, but to accommodate those with laser  printers we
  107. used 60 here) we will leave this setting as it is.  Next enter 5 for
  108. the Start Indexing on Page entry, (we want to skip the first 4 pages
  109. that contain the title page, the disclaimer, and the table of
  110. contents) and leave the First Page Number to use setting at 1.
  111.  
  112.  
  113. The completed window should look like this:
  114. |
  115. ┌───────────────────────────────────────────────────────────────┐
  116. │                                                               │
  117. │  Input File Name:   (Name of Document to process)             │
  118. │  <pci.doc                                                %    │
  119. │                                                               │
  120. │  Output File Name:                                            │
  121. │  <pci.srt                                                %    │
  122. │                                                               │
  123. │  Page Size  Start Indexing on Page    First Page Number to use│
  124. │    < 60^           <  5^                       <   1%         │
  125. └───────────────────────────────────────────────────────────────┘
  126. ^
  127. When you have finished entering the filenames and other information,
  128. press F10 to begin processing 'PCI.DOC'.
  129.  
  130. You should now see a window which gives you the current status and
  131. tells you how the processing of PCI.DOC is going.  You will be kept
  132. informed of how many characters, lines, words, and pages have been
  133. processed as well as how many matches have been found. 
  134.  
  135. This process should only take a few seconds for PCI.DOC.
  136.  
  137.  
  138.                  |STEP TWO:  Edit Extracted word file^
  139.  
  140. This step is optional, although you will probably want to use it.  It
  141. gives you a chance to fine tune the index before you complete it.  By
  142. using this option, you can deactivate words so that they will not be
  143. included in the index and change the case of words that are included
  144. from lowercase to uppercase and vice versa. 
  145.  
  146. Select the 'Edit Extracted word file' option from the EDIT menu.  You
  147. will be asked for an input filename.  PC-INDEX will enter the name of
  148. the output file from the Extract Words option, PCI.SRT.  Just leave
  149. the name alone and press enter.  After a few seconds you will see a
  150. list of each unique word in PCI.DOC and the number of times that each
  151. word occurred.
  152.  
  153. To the far left of each word are a set of brackets and an asterisk. 
  154. The presence or absence of an asterisk indicates whether or not the
  155. word is active.  If a word is active, it will be included in the index
  156. when it is created.  Words can be toggled one at a time between being
  157. active and inactive by using the spacebar.  The words can also be
  158. toggled as a group between being active and inactive by pressing F2. 
  159. By pressing F2 all words will be alternately set to active or
  160. inactive.
  161.  
  162. If you have individual words which need to be different you may change
  163. them here.  For instance go to the entry 'ASCII'.  Since ASCII is an
  164. abbreviation it needs to be listed in uppercase.  By pressing F3, the
  165. entry will be changed immediately to all uppercase if it isn't
  166. already.  You may have a name which needs to have the first letter
  167. uppercase and the rest lowercase.  For example go to the entry
  168. 'Australia'.  By pressing F5 you can change the word from australia to
  169. Australia.  In the same manner, pressing F4 would change the word to
  170. all lower case.
  171.  
  172. If you are processing a large document, you may have more words than
  173. the Edit Extracted Word File option will allow you to work with at one
  174. time.  Edit Extracted Word File allows up to 1000 unique words to be
  175. in memory at any one time.  If your list contains more than 1000
  176. words, you can get the next group of words by pressing F7.  You can
  177. continue this process until you have worked with the entire list.  You
  178. can go back to the first group  (the top of the list) by pressing F6.
  179.  
  180. When you are done editing the word list press ESCape to return to the
  181. main menu.  All changes have already been saved.
  182.  
  183.  
  184.  
  185.                  |STEP THREE:  Build Single Word Index^
  186.  
  187. The third and final step 'Build Single Word Index' is found under the
  188. FILE menu.  This step takes the file created by the 'Extract Single
  189. Words' selection and edited by the 'Edit Extracted Word File'
  190. selection and creates the index.
  191.  
  192. Select 'Build Single Word Index' from the FILE menu.  You will be
  193. asked for the input file and output file.  PC-INDEX remembers the name
  194. that you gave the file ('PCI.SRT') when you extracted the word list. 
  195. You should leave this name as it is.
  196.  
  197. Next you will be asked what name you want to use for the output file. 
  198. This is the name that the actual index will be called.  For this
  199. example we'll call it 'PCI.NDX'.
  200.  
  201. The next entry is the Wildcard Description File Name.  This entry is
  202. only used if you are processing several files at the same time.  We
  203. won't use it here.
  204.  
  205. Next, PC-INDEX wants to know the page length (how many lines per page)
  206. you want to use.  The default setting is 66 which is the proper
  207. setting for letter size paper.  If you are using legal size paper, the
  208. proper setting would be 88.  This number does not need to match the
  209. lines per page setting you used when you selected 'Extract Words'. 
  210. Most laser printers will only output 60 lines per page.  If you will
  211. be printing the index to a laser printer you will want to set this
  212. option to 60.
  213.  
  214. The next item to fill in is the page width.  Here you will enter the
  215. total number of characters that will fit on one line.  The maximum
  216. width accepted by PC-INDEX is 132 characters.  The number next to page
  217. width in reverse video is the calculated width required for the
  218. settings you have selected.
  219.  
  220. Next, PC-INDEX asks you the number of columns you would like the
  221. output to be in.  You will be able to produce an index up to four
  222. columns wide.  An example of a two column index is included at the end
  223. of this document.
  224.  
  225. The column width is the next entry.  This entry controls the width of
  226. each column in the index.  The minimum allowable width is 30
  227. characters and the maximum is 99.
  228.  
  229. The number of spaces between columns can range from 1 to 9 characters.
  230.  
  231. Next fill in the top, bottom, left, and right margins to the settings
  232. that you wish.
  233.  
  234. The completed input window should look something like this:|
  235. ┌────────────────────────────────────────────────────────────┐
  236. │ Input File Name:                                           │
  237. │ <pci.srt                                          %        │
  238. │                                                            │
  239. │ Output File Name:                                          │
  240. │ <pci.ndx                                          %        │
  241. │                                                            │
  242. │ Wildcard Description File: (Leave blank if not needed)     │
  243. │ <                                                 %        │
  244. │                                                            │
  245. │ Page Size    Page Width  (Columns)    Number of Columns    │
  246. │    < 66^         < 80^     < 78^             <  2%         │
  247. │ Column Width   Space Between Columns       Top Margin      │
  248. │    < 30^              <  3^                  <  5%         │
  249. │ Bottom Margin       Left Margin            Right Margin    │   
  250. │    <  5^              < 10^                  <  5%         │   
  251. └────────────────────────────────────────────────────────────┘
  252. ^
  253. When you have finished entering the filenames and other information,
  254. press F10 to begin processing 'PCI.SRT'.
  255.  
  256. You should see a status box which tells you the number of words to be
  257. processed, the number of words actually processed, the letter of the
  258. alphabet currently being processed, percentage completed, and the
  259. elapsed time.
  260.  
  261. @
  262.  
  263.                     |INDEX TYPE TWO:  PHRASE INDEX^
  264.  
  265. The phrase index feature of PC-INDEX will quickly create an index
  266. listing the page number(s) of all phrases that you provide.  You can
  267. create this list using any word processor, or you can use PC-INDEX to
  268. create it for you.
  269.  
  270.                       |STEP ONE:  Extract Phrases^
  271.  
  272. To begin using PC-INDEX type PCI and press enter.
  273.  
  274. This option will extract all phrases that you provided and record them
  275. in sorted order along with the page number that they occur on.  
  276.  
  277. First, select Text (ASCII) as the document type from the Document
  278. menu.  If the wrong document type is selected, results will be
  279. unpredictable.  
  280.  
  281. Next, select the Extract Phrases option from the FILE menu, by using
  282. the cursor keys and pressing ENTER.  You should now see a new window
  283. asking you for an input filename, an output filename, the page size,
  284. the first page number to start indexing on, and the first page number
  285. to use.
  286.  
  287. For the input filename type 'PCI.DOC' and press enter.  For the
  288. output filename type 'PCI.SRT' and press enter.  Since this document
  289. was created using 60 lines per page (the standard for letter size
  290. paper is usually 66, but to accommodate those with laser printers we
  291. used 60 here) we will leave this setting as it is.  Next enter 5 for
  292. the Start Indexing on Page entry, (we want to skip the first 4 pages
  293. that contain the title page, the disclaimer, and the table of
  294. contents) and leave the First Page Number to use setting at 1.
  295.  
  296. The completed window should look something like this:|
  297. ┌───────────────────────────────────────────────────────────────┐
  298. │                                                               │
  299. │  Input File Name:   (Name of Document to process)             │
  300. │  <pci.doc                                           %         │
  301. │                                                               │
  302. │  Output File Name:                                            │
  303. │  <pci.srt                                           %         │
  304. │                                                               │
  305. │  Page Size  Start Indexing on Page    First Page Number to use│
  306. │    < 60^           <  5^                        <  1%         │
  307. └───────────────────────────────────────────────────────────────┘
  308. ^
  309. When you have finished entering the filenames and other information,
  310. press F10 to begin processing 'PCI.DOC'.
  311.  
  312. You should now see a window which gives you the current status and
  313. tells you how the processing of PCI.DOC is going.  You will be kept
  314. informed of how many characters, lines, words, and pages have been
  315. processed as well as how many matches have been found.
  316.  
  317. This process should only take a few seconds for PCI.DOC.
  318.  
  319.  
  320.                     |STEP TWO:  Build Phrase Index^
  321.  
  322. The second and final step 'Build Phrase Index' is found under the FILE
  323. menu.  This step takes the file created by the 'Extract Phrases'
  324. selection and creates the final index.
  325.  
  326. Select 'Build Phrase Index' from the FILE menu.  You will be asked for
  327. the input file and output file.  PC-INDEX remembers the name that you
  328. gave the file ('PCI.SRT') when you extracted the phrases.  You should
  329. leave this name as it is.
  330.  
  331. Next you will be asked what name you want to use for the output file. 
  332. This is the name that the actual index will be called.  For this
  333. example we'll call it 'PCI.NDX'.  
  334.  
  335. The next entry is the Wildcard Description File Name.  This entry is
  336. only used if you are processing several files at the same time.  We
  337. won't use it here.
  338.  
  339. Next, PC-INDEX wants to know the page length (how many lines per page)
  340. you want to use.  The default setting is 66 which is the proper
  341. setting for letter size paper.  If you are using legal size paper, the
  342. proper setting would be 88.  This number does not need to match the
  343. lines per page setting you used when you selected 'Extract Phrases'. 
  344. Most laser printers will only output 60 lines per page.  If you will
  345. be printing the index on a laser printer you will want to set this
  346. option to 60. 
  347.  
  348. The next item to fill in is the page width.  Here you will enter the
  349. total number of characters that will fit on one line.  The maximum
  350. width accepted by PC-INDEX is 132 characters.  The number next to page
  351. width in reverse video is the calculated width required for the
  352. settings you have selected.
  353.  
  354. Next, PC-INDEX asks you the number of columns you would like the
  355. output to be in.  You will be able to produce an index up to four
  356. columns wide if your phrases are small enough.  An example of a two
  357. column phrase index is included at the end of this document.
  358.  
  359. The column width is the next entry.  This entry controls the width of
  360. each column in the index.  The minimum allowable width is calculated
  361. by PC-INDEX and is equal to the longest phrase that you entered.  The
  362. maximum is 99 characters. 
  363.  
  364. The number of spaces between columns can range from 1 to 9 characters.
  365.  
  366. Next fill in the top, bottom, left, and right margins to the settings
  367. that you wish.
  368.  
  369. The completed input window should look something like this:
  370. |
  371. ┌────────────────────────────────────────────────────────────┐
  372. │ Input File Name:                                           │
  373. │ <pci.srt                                          %        │
  374. │                                                            │
  375. │ Output File Name:                                          │
  376. │ <pci.ndx                                          %        │
  377. │                                                            │
  378. │ Wildcard Description File: (Leave blank if not needed)     │
  379. │ <                                                 %        │
  380. │                                                            │
  381. │ Page Size    Page Width  (Columns)    Number of Columns    │
  382. │    < 66^        < 80^      < 78^              < 2%         │
  383. │ Column Width   Space Between Columns       Top Margin      │
  384. │    < 30^              <  3^                   < 5%         │
  385. │ Bottom Margin       Left Margin            Right Margin    │   
  386. │    <  5^              < 10^                   < 5%         │   
  387. └────────────────────────────────────────────────────────────┘
  388. ^
  389. When you have finished entering the filenames and other information,
  390. press F10 to begin processing 'PCI.SRT'.
  391.  
  392. You should see a status box which tells you the number of phrases to
  393. be processed, the number of phrases actually processed, the letter of
  394. the alphabet currently being processed, percentage completed, and the
  395. elapsed time.
  396.  
  397.  
  398.  
  399. @ this is where the kwic menu type info was stored. ---
  400.  
  401.  
  402.  
  403. @
  404.  
  405.                               |FILE menu:^
  406.  
  407. The FILE menu has nine available selections:  Extract Single Words,
  408. Extract Capitalized Words, Build Single Word Index, Word Frequency,
  409. Spinoff Unique Words, Extract Phrases, Build Phrase Index, Save 
  410. Settings, and Quit.
  411.  
  412. This menu is broken down into three categories: single word functions,
  413. phrase functions, and save settings and quit.
  414.  
  415.  
  416.                          |Extract Single Words^
  417.  
  418. Extract Single Words is the first item in the menu.  It is also the
  419. first step performed in creating a single word index.  It's function
  420. is to extract each individual word from the document and record it.  
  421.  
  422. This option will extract all words in the document, one at a time, and
  423. record them in sorted order along with the page number that they occur
  424. on.  
  425.  
  426.  
  427.                       |Extract Capitalized Words^
  428.  
  429. The Extract Capitalized Words selection works in exactly the same
  430. manner as Extract Single Words, except that it only extracts
  431. capitalized words (like names).
  432.  
  433.  
  434.                        |Build Single Word Index^
  435.  
  436. Build Single Word Index  is the final step in creating a single word
  437. index.  It takes the file created by the 'Extract Single Words'
  438. selection and edited by the 'Edit Extracted Word File' selection and
  439. creates an index.
  440.  
  441.                             |Word Frequency^
  442.  
  443. Word Frequency builds a word frequency list. This file contains all
  444. unique words in alphabetical order and the number of times that each
  445. word was used.  This file is built from an extracted single word file. 
  446. If you want a complete listing of all words, be sure to extract words
  447. using the 'Don't use any Word List' option (found in the Options
  448. menu).  
  449.  
  450. If you have not already created an extracted single word file, then
  451. you will need to do this first.
  452.  
  453.  
  454.                              |Spinoff List^
  455.  
  456. Spinoff List creates an ASCII text file of words from an extracted
  457. single word file.  This can be particularly helpful when you are
  458. creating a customized include word list or discard word list.
  459.  
  460. This option will quickly go through an extracted word file and
  461. write out all unique words to a file.  This file can then be used as
  462. either an include or discard word list.  By editing the file with the
  463. Edit Extracted word file (found under the Edit Menu) you can mark or
  464. un-mark unique words.  Then when you spin off a list you can spin off
  465. either the marked words or the un-marked words.
  466.  
  467.  
  468.                            |Extract Phrases^
  469.  
  470. Extract Phrases will search through a document and find all
  471. occurrences of a list of phrases.  It is the first step performed in
  472. creating a phrase index.  It's function is to extract each individual
  473. phrase from a document and record it.  
  474.  
  475.  
  476.                          |Build Phrase Index^
  477.  
  478. Build Phrase Index  is the final step in creating a phrase index. 
  479. Build Phrase Index takes the file created by the 'Extract Phrases'
  480. selection creates the phrase index.
  481.  
  482.  
  483.                             |Save Settings^
  484.  
  485. Save Settings saves the current settings in the OPTIONS and DOCUMENT
  486. menus.  It will also save all numeric settings in the various dialogue
  487. boxes and save the word list filenames.
  488.  
  489.                                  |Quit^
  490.  
  491. Quit exits PC-INDEX and returns you to the DOS prompt.
  492.  
  493.  
  494. @
  495.  
  496.                               |EDIT menu:^
  497.  
  498. The EDIT menu has six available selections:  Edit Custom Character
  499. Set, Edit Discard Word File, Edit Include Word File, Edit Phrase File,
  500. Edit Extracted Word File, and Edit Word List Filename.
  501.  
  502.  
  503.                      |Edit Custom character set:^
  504.  
  505. The custom character set is a list of characters that will be allowed
  506. to be part of a word.  This feature gives you a great deal of
  507. flexibility in determining what characters a word can contain.  For
  508. instance you will obviously want to include all alphabetical
  509. characters, but you may or may not want numbers, hyphens, apostrophes,
  510. or other punctuation characters to be allowed in a word.  
  511.  
  512. There are 256 possible characters and any character except a space can
  513. be valid in a word.  To allow or disallow a character simply position
  514. it under the highlight bar and press the spacebar.
  515.  
  516. If a character is not valid in a word then PC-INDEX assumes that a new
  517. word begins there.  There are a few cases which you need to plan for. 
  518. For instance, the way PC-INDEX comes configured, hyphens and
  519. apostrophes will not be included in a word.  Words like wouldn't and
  520. couldn't will not be kept together.  If this is going to be a problem
  521. for you, then use the custom character set and mark the hyphen and
  522. apostrophe and any other character which may cause a problem for you.
  523.  
  524.  
  525.                         |EDIT Discard word file^
  526.  
  527. The Discard word file contains a list of words which can be searched
  528. during the Extract words selection.  If the 'Use Discard Word List'
  529. option is selected from the options menu, when a word is extracted
  530. from a document, the Discard word file is searched.  If a match is
  531. found then the extracted word will be discarded and will not be
  532. included in the index.
  533.  
  534. Over 1000 words are included in the Discard word list right now.  Many
  535. words are words like a, and, the, if, or, etc.  You may want to take a
  536. look at the words currently in the list to see if they meet your
  537. needs.
  538.  
  539. By using the EDIT Discard word file, you can add, edit, or delete
  540. words from the list to customize it.  Up to 3000 words can be included
  541. in the list.
  542.  
  543. By pressing F3, you will be allowed to edit the word that is under the
  544. highlight bar.  By pressing F4, you will be allowed to add words to
  545. the list.  As you add new words to the list, they will be inserted in
  546. the correct place so that the list remains in alphabetical order.  You
  547. can have up to 3000 words in the discard word list.  Press F2 when you
  548. are ready to save the modified discard word list.
  549.  
  550.  
  551.                         |EDIT Include word file^
  552.  
  553. The Include word file contains a list of words which can be searched
  554. during the Extract words selection.  If the Use Include Word List
  555. option is selected from the options menu, when a word is extracted
  556. from a document, the Include word file is searched.  If a match is
  557. found then the extracted word will be included in the index.
  558.  
  559. There are no words included in the Include word list as it ships.  By
  560. using the EDIT Include word file option, you can add, edit, or delete
  561. words from the list to customize it.  Up to 3000 words can be included
  562. in the list.
  563.  
  564. There is a shortcut you can use to create a customized include word
  565. list very easily.  By using the Spinoff List option (under the file
  566. menu) you can quickly spin off a list of unique words in alphabetical
  567. order.  This list can then be used as an include word list or a
  568. discard word list.
  569.  
  570. See the Spinoff List option for more information. 
  571.  
  572.  
  573.                            |Edit Phrase List^
  574.  
  575. The Phrase List file contains a list of phrases which will be searched
  576. during the Extract Phrases selection.  As PC-INDEX processes the
  577. document, the Phrase List file is continuously searched.  If a match
  578. is found then the extracted phrase will be included in the index.
  579.  
  580. There are no phrases in the phrase list as it ships.  By using the
  581. EDIT Phrase List option, you can add, edit, or delete phrases from the
  582. list to customize it.  Up to 3000 phrases can be included in the list.
  583.  
  584.  
  585.  
  586.                        |EDIT Extracted word file^
  587.  
  588. This is an optional step in creating a single word index.  It gives
  589. you a chance to fine tune the index before you complete it.  By using
  590. this option, you can deactivate words so that they will not be
  591. included in the index and change the case of words that are included
  592. (from lowercase to uppercase and vice versa).
  593.  
  594. After selecting Edit Extracted word file from the Edit Menu.  Enter
  595. the name of the extracted word file that you want to edit.  This may
  596. take a few seconds to load.
  597.  
  598. On the far left you will see a set of brackets with an asterisk.  The
  599. asterisk means that the word is active and will be included in the
  600. index.  By pressing the spacebar you can toggle individual words
  601. between active and inactive.  With this technique you can quickly cut
  602. out words that you don't want to include.
  603.  
  604. By pressing F2 you can toggle all words between being active and
  605. inactive.  This function will allow you to clear all entries and then
  606. go through the list and mark only the words that you want.  By using
  607. this technique along with the Spinoff List option, you can quickly and
  608. easily create an include word file or a discard word file.
  609.  
  610. By pressing F3 you can change individual words to all upper case, by
  611. pressing F4 you can change individual words to all lower case, and by
  612. pressing F5 you can change individual words so that the first
  613. character is upper case and the rest of the word is lower case.
  614.  
  615. The Edit Extracted Word File function will load a maximum of 1000
  616. unique words at one time.  If you have a very large file, it may be
  617. larger than 1000 words.  If that is the case, then PC-INDEX will only
  618. load the first 1000 unique words.  By pressing F7, you can move
  619. through the file so that you can edit the entire file.  F6 will move
  620. you back to the beginning of the file. 
  621.  
  622.  
  623.                        |Edit Word List Filenames^
  624.  
  625. PC-INDEX allows you to change the names of the INCLUDE, DISCARD, and
  626. PHRASE lists that it uses.  This way you can use a word processor or
  627. PC-INDEX to create new lists without destroying existing lists or
  628. having to constantly rename the files.  Select Edit Word List
  629. Filenames from the Edit Menu and you will see a window that looks like
  630. this:
  631. |
  632. ┌───  Edit Word List Filenames   ──────────────────────────────┐
  633. │                                                              │
  634. │  Discard Word List Filename:                                 │
  635. │  <DISCARD.WRD                                       %        │
  636. │                                                              │
  637. │  Include Word List Filename:                                 │
  638. │  <INCLUDE.WRD                                       %        │
  639. │                                                              │
  640. │  Phrase List Filename:                                       │
  641. │  <PHRASE.WRD                                        %        │  
  642. └──────────────────────────────────────────────────────────────┘
  643. ^
  644. You can now select the filename that you want to change and type in
  645. any name that you wish.
  646.  
  647.  
  648. @
  649.  
  650.                              |OPTIONS menu^
  651.  
  652. The OPTIONS menu has eight available selections.  There are three
  653. basic groups of selections:  case selection, compare list, and
  654. eliminate duplicates.
  655.  
  656. The first group of options determines what case the characters will be
  657. converted to when written to disk.
  658.  
  659. For consistency, PC-INDEX can convert all words to be the same case as
  660. they are being extracted.  If you want to do any conversion, you have
  661. three choices.  Convert words to UPPER CASE will convert all words to
  662. upper case, Convert words to lower case will convert all words to
  663. lower case, and Convert words to UPPER & lower case will convert the
  664. first letter in the word to upper case and the rest of the word to
  665. lower case.  If you select No Conversion then no conversion will take
  666. place.
  667.  
  668. The second group of options determines which words will be included in
  669. the extracted word list.
  670.  
  671. You have three options to determine which words will be included. 
  672.  
  673. Don't Use any Word List:  When this option is selected every word in
  674. the document will be included.  Common words like 'a', 'and', 'the',
  675. etc. will be indexed using this option.
  676.  
  677. Use Discard Word List:  When the Use Discard Word List option is
  678. selected, PC-INDEX will compare the extracted word to the discard word
  679. list.  If a match is found, the extracted word will be discarded and
  680. will not be included in the extracted word list or the index.  
  681.  
  682. Use Include Word List:  When the Use Include Word list option is
  683. selected, PC-INDEX will compare the extracted word to the include
  684. word list.  If a match is found, the extracted word will be included
  685. in the extracted word list and the index.
  686.  
  687. The last option is Eliminate Duplicate Words.  It will speed up 
  688. processing of large files and reduce the size of files produced by
  689. PC-INDEX.  When this option is selected any duplicates that occur 
  690. on the same page will be deleted.
  691.  
  692.  
  693.  
  694. @
  695.  
  696.                          |DOCUMENT menu:^
  697.  
  698. If you are using the shareware version of PC-INDEX you will only be
  699. able to index ASCII files.  The ability to process files without
  700. converting them to ASCII is only available with the registered version
  701. of PC-INDEX.
  702.  
  703. The registered version of PC-INDEX has the ability to process
  704. documents of several popular word processors without any conversion. 
  705. If you wish to process Microsoft Word 4.0, Microsoft Word 5.0,
  706. Wordperfect 4.2, 5.0, 5.1, Multimate, Wordstar 2000, or Wordstar
  707. Professional  in their original formats, simply select the document
  708. type that you are using and PC-INDEX will process the document without
  709. any conversion.
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722. @
  723.  
  724.                         |ERROR MESSAGES:^
  725.  
  726. The following list contains some of the error messages you may
  727. encounter while running PC-INDEX.
  728. |
  729. Can't find Discard word file. -^The file 'DISCARD.WRD' could not
  730. be found.  If you select the Edit Discard Word File option,
  731. 'DISCARD.WRD' should be created automatically and this problem
  732. should not occur.
  733. |
  734. Can't find Include word file. -^The file 'INCLUDE.WRD' could not
  735. be found.  If you select the Edit Include Word File option,
  736. 'INCLUDE.WRD' should be created automatically and this problem
  737. should not occur.
  738. |
  739. Can't find Phrase word file. -^The file 'PHRASE.WRD' could not
  740. be found.  If you select the Edit Phrase Word File option,
  741. 'PHRASE.WRD' should be created automatically and this problem
  742. should not occur.
  743. |
  744. Can't close file 'filename'. -^You may have a problem with your
  745. system. 
  746. |
  747. Can't locate the text in this document. -^You may have selected the
  748. wrong document format or your document may not have any text.
  749. |
  750. Can't open custom character set. -^The file 'CUSTOM.SET' could
  751. not be found.  If you select the Edit Custom Character Set
  752. option, 'CUSTOM.SET' should automatically be created and this
  753. problem should not occur.
  754. |
  755. Can't open file 'filename'. -^The file may not exist.  Check to
  756. see if it does or not.  You may also not have enough file handles
  757. available.  If you have the 'FILES=' setting in your CONFIG.SYS
  758. file set to less than 10 or if you do not have a 'FILES=' setting
  759. you may need to correct it.
  760. |
  761. Can't open file 'PCI.DEF'. -^Try selecting the Save Defaults
  762. option from the FILE menu.
  763. |
  764. Couldn't save custom character set. -^You may have a problem with
  765. your system.
  766. |
  767. CUSTOM.SET could not be found and could not be created. -^You may
  768. have a problem with your system.
  769. |
  770. File 'filename' already exists. -^This is just a warning.
  771. |
  772. File 'filename' couldn't be created. -^Make sure that you have
  773. space available on your disk.
  774. |
  775. File 'filename' is not an extracted word file. -^The file that
  776. you selected to index is not an extracted word file.  If you
  777. continue, the results will be unpredictable at best and you may
  778. crash PC-INDEX.
  779. |
  780. Information is needed from the wildcard description file 'filename'
  781. and it could not be found. -^The wildcard description file does not
  782. exist or you entered the wrong name.  The wildcard description file
  783. will be created automatically when you are extracting words or phrases
  784. from a group of files. 
  785. |
  786. Not enough memory to continue ... -^There are a number of places
  787. where this message could occur.  Make sure that you have 640K of
  788. memory.
  789. |
  790. Out of memory. -^Make sure that you have 640K of memory.
  791. |
  792. Problem reading extracted word file. -^You may have a problem
  793. with your system.
  794. |
  795. Problem writing to extracted word file. -^You may have a problem
  796. with your system.
  797. |
  798. The page width you have entered is not wide enough to handle the
  799. selections you have chosen.  Please modify your selections. -^The
  800. printer width you entered is not wide enough to handle the settings
  801. that you entered.  You may need to use fewer columns or narrow the
  802. column width somewhat.  Experiment with the settings until the
  803. required width (in reverse video) is less than the printer page width.
  804. |
  805. The Phrase file 'filename1' has been modified after the file
  806. 'filename2' was created. -^PC-INDEX uses the phrase file to look up
  807. each phrase as it creates the index.  If you have edited the phrase
  808. file then the index will not be accurate at all.  You will need to run
  809. extract phrases again.
  810. |
  811. There may not be enough files available. -^This is just a warning
  812. that you may have problems later.  If you are processing very
  813. large files, PC-INDEX may have to abort in the middle of
  814. extracting the word list if it needs more files than your system
  815. has available.  If you have the 'FILES=' setting in your
  816. CONFIG.SYS file set to less than 10 or if you do not have a
  817. 'FILES=' setting you may need to correct it.
  818. |
  819. This is not a Wordperfect 5.0 document. -^You have set the
  820. document format as Wordperfect 5.0 and the document that you are
  821. trying to process was not created using Wordperfect 5.0.
  822. |
  823. Word list file could not be found and could not be created. -^
  824. Either the include word file or the discard word file could not
  825. be found or created.  You may have a problem with your system.
  826. |
  827. Word list file could not be opened. -^Either the include word
  828. file or the discard word file could not be found.  If you attempt
  829. to edit them using the Edit Discard Word File or Edit Include
  830. Word File options, they will be created automatically.
  831.  
  832.  
  833.