home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / wp / pc_idx30.zip / SAMPLE2.DOC < prev    next >
Text File  |  1990-08-05  |  17KB  |  409 lines

  1.    
  2.  
  3.  
  4.  
  5.                                    FILE menu:
  6.  
  7.      The FILE menu has nine available selections:  Extract Single Words,
  8.      Extract Capitalized Words, Build Single Word Index, Word Frequency,
  9.      Spinoff Unique Words, Extract Phrases, Build Phrase Index, Save 
  10.      Settings, and Quit.
  11.  
  12.      +---------------------------------------------------------------+
  13.      |    File   Edit   Options   Document                           |
  14.      |  +-------------------------------------+                      |
  15.      |  | Extract Single Words                |                      |
  16.      |  | Extract Capitalized Words           |                      |
  17.      |  | Build Single Word Index             |                      |
  18.      |  | Word Frequency                      |                      |
  19.      |  | Spinoff Unique Words                |                      |
  20.      |  +-------------------------------------+                      |
  21.      |  | Extract Phrases                     |                      |
  22.      |  | Build Phrase Index                  |                      |
  23.      |  +-------------------------------------+                      |
  24.      |  | Save Settings                       |                      |
  25.      |  | Quit                                |                      |
  26.      |  +-------------------------------------+                      |
  27.      |                                                               |
  28.      |                                                               |
  29.      | PC-INDEX 3.0-Index Generator Copyright  1989-90 Help Software | 
  30.      +---------------------------------------------------------------+
  31.  
  32.      This menu is broken down into three categories.  The first category is
  33.      single word functions, the second section contains phrase functions, 
  34.      and the last is for saving settings and quitting.
  35.  
  36.  
  37.                               Extract Single Words
  38.  
  39.      Extract Single Words is the first item in the menu.  It is also the
  40.      first step performed in creating a single word index.  It's function
  41.      is to extract each individual word from the document and record it.  
  42.  
  43.      This option will extract all words in the document, one at a time, and
  44.      record them in sorted order along with the page number that they occur
  45.      on.  
  46.  
  47.      Before you begin with the Extract Words selection, you need to select
  48.      the proper document type from the Document menu and you need to check
  49.      the options in the Option menu.  For more information, see the Option
  50.      menu description later in this section.
  51.       
  52.      Select the Extract Single Words option from the FILE menu, by using
  53.      the cursor keys and pressing ENTER.  You should now see a new window
  54.      asking you for an input filename, an output filename, the page size,
  55.      the first page number to start indexing on, and the first page number
  56.      to use.
  57.  
  58.  
  59.                                 1
  60.  
  61.  
  62.  
  63.  
  64.      For the input filename, enter the name of the document that you want
  65.      to index and press enter.  For the output filename type any name you
  66.      want and press enter.  The output file is not the index, but a sorted
  67.      list of all words in the document and the page numbers that they occur
  68.      on.  It is recommended that you use the same name as the document with 
  69.      '.srt' as the extension.  
  70.  
  71.      The entry for page size is only used if you are using a Text or
  72.      ASCII file.  If you are using a word processor supported directly by
  73.      PC-INDEX then you can ignore this entry.  For a list of word
  74.      processors supported by PC-INDEX, look in the Document menu.
  75.  
  76.      The next entry is Start Indexing on Page.  This entry allows you to
  77.      skip a few pages at the beginning of a document before the indexing
  78.      starts.  This will let you skip a title page, table of contents, or
  79.      anything else at the beginning of a document that you don't want to
  80.      index. 
  81.  
  82.      The First Page Number to use setting will determine what page number
  83.      PC-INDEX will use as the first page number.   This entry can be used
  84.      with the Start Indexing on Page setting so that you can start indexing
  85.      on page four, but the first page number will be page one.  
  86.  
  87.      The completed window should look like this:
  88.      +---------------------------------------------------------------+
  89.      |                                                               |
  90.      |  Input File Name:   (Name of Document to process)             |
  91.      |  pci.doc                                                      |
  92.      |                                                               |
  93.      |  Output File Name:                                            |
  94.      |  pci.srt                                                      |
  95.      |                                                               |
  96.      |  Page Size  Start Indexing on Page    First Page Number to use|
  97.      |     66               4                           1            |
  98.      +---------------------------------------------------------------+
  99.      When you have finished entering the filenames and other
  100.      information, press F10 to begin processing.
  101.  
  102.  
  103.                             Extract Capitalized Words
  104.  
  105.      The Extract Capitalized Words selection works in exactly the same
  106.      manner as Extract Single Words, except that it only extracts
  107.      capitalized words (like names).
  108.  
  109.                              Build Single Word Index
  110.  
  111.      Build Single Word Index  is the final step in creating a single word
  112.      index.  It takes the file created by the 'Extract Single Words'
  113.      selection and edited by the 'Edit Extracted Word File' selection and
  114.      creates an index.
  115.  
  116.  
  117.                                 2
  118.  
  119.  
  120.  
  121.  
  122.      Select 'Build Single Word Index' from the FILE menu.  You will be
  123.      asked for the input file and output file.  Enter the name of the
  124.      extracted word file that you created with the Extract Words process. 
  125.      This file should have '.SRT' as the filename extension.
  126.  
  127.      Next you will be asked what name you want to use for the output file. 
  128.      This is the filename that the actual index will be called.  It is
  129.      recommended that you use the original document name with the extension 
  130.      '.NDX'.
  131.        
  132.      The Wildcard Description file is only used if you are processing a
  133.      group of files together.  If you indexed a group of files then use the
  134.      same wildcard description filename here.  It contains information that
  135.      PC-INDEX needs to complete the index.
  136.  
  137.      Next, PC-INDEX wants to know the page length (how many lines per page)
  138.      you want to use.  The default setting is 66 which is the proper
  139.      setting for letter size paper.  If you are using legal size paper, the
  140.      proper setting would be 88.  This number does not need to match the
  141.      lines per page setting you used when you selected 'Extract Words'. 
  142.      Most laser printers will only output 60 lines per page.  If you will
  143.      be printing the index on a laser printer, you will probably want to
  144.      set this option to 60.
  145.  
  146.      The next item to fill in is the page width.  Here you will enter the
  147.      total number of characters that will fit on one line of your printer. 
  148.      The maximum width accepted by PC-INDEX is 132 characters.  The number
  149.      next to page width in reverse video is the calculated width required
  150.      for the settings you have selected.  This number (required width) must
  151.      be smaller than the Page Width setting or an error will occur.
  152.       
  153.      Next, PC-INDEX asks you the number of columns you would like the
  154.      output to be in.  You will be able to produce an index up to four
  155.      columns wide.  An example of a two column index is included at the end
  156.      of this document.
  157.  
  158.      The column width is the next entry.  This entry controls the width of
  159.      each column in the index.  The minimum allowable width is 30
  160.      characters and the maximum is 99.
  161.  
  162.      The number of spaces between columns can range from 1 to 9 characters.
  163.  
  164.      Next fill in the top, bottom, left, and right margins to the settings
  165.      that you wish.
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.                                 3
  176.  
  177.  
  178.  
  179.      The completed input window should look like this:
  180.      +---------------------------------------------------------------+
  181.      |  Input File Name:                                             |
  182.      |  pci.srt                                                      |
  183.      |                                                               |
  184.      |  Output File Name:                                            |
  185.      |  pci.ndx                                                      |
  186.      |                                                               |
  187.      |  Wildcard Description File Name: (Leave Blank if not needed)  |
  188.      |                                                               |
  189.      |                                                               |
  190.      |  Page Size   Page Width  (Columns)    Number of Columns       |
  191.      |     66             80       78               2                |
  192.      |  Column Width   Space Between Columns    Top Margin           |
  193.      |     30                   3                   5                |
  194.      |  Bottom Margin       Left Margin         Right Margin         |
  195.      |      5                  10                   5                |
  196.      +---------------------------------------------------------------+
  197.       
  198.      When you have finished entering the filenames and other information,
  199.      press F10 to begin processing.
  200.  
  201.      You should see a status box which tells you the number of words to be
  202.      processed, the number of words actually processed, the letter of the
  203.      alphabet currently being processed, percentage completed, and the
  204.      elapsed time.
  205.  
  206.      When this is finished, you will be returned to the main menu and the
  207.      completed index is contained in the text file that you named.  If you
  208.      wish to view the file you can QUIT PC-INDEX and enter 'TYPE filename'
  209.      from the DOS command line, where filename is the name you gave the
  210.      index file.  You could also send the document to the printer by
  211.      entering 'TYPE filename >PRN' from the command line.  Since the index 
  212.      is an ASCII file, you could also load it into almost any word
  213.      processor and edit it further if you wish.  
  214.  
  215.  
  216.                                  Word Frequency
  217.  
  218.      Word Frequency builds a word frequency list. This file contains all
  219.      unique words in alphabetical order and the number of times that each
  220.      word was used.  This file is built from an extracted single word file. 
  221.      If you want a complete listing of all words, be sure to extract words
  222.      using the 'Don't use any Word List' option (found in the Options
  223.      menu).  
  224.  
  225.      Enter the name of the extracted word file that you want to process for
  226.      the Input File Name.  If you have not already created an extracted
  227.      single word file, then you will need to do this first.
  228.  
  229.      Enter any name you want for the output file name.  This file will
  230.      be an ASCII text file when finished.  For consistency, it is
  231.  
  232.  
  233.                                 4
  234.  
  235.  
  236.  
  237.      recommended that you use the document name with the extension '.frq'.
  238.  
  239.      The minimum word count that you are asked for will allow you to set a
  240.      minimum number of occurrences for a word to be included in the word
  241.      frequency file.  In other words, if you want only the most frequently
  242.      used words in the word frequency list, you might enter 20 or some
  243.      other large number in the Minimum Word Count entry.  This way only
  244.      words occurring 20 or more times would be included in the word
  245.      frequency list.
  246.  
  247.                                   Spinoff List
  248.  
  249.      Spinoff List creates an ASCII text file of words from an extracted
  250.      single word file.  This can be particularly helpful when you are
  251.      creating a customized include word list or discard word list.
  252.  
  253.      This option will quickly go through an extracted word file and
  254.      write out all unique words to a file.  This file can then be used as
  255.      either an include or discard word list.  By editing the file with the
  256.      Edit Extracted word file (found under the Edit Menu) you can mark or
  257.      un-mark unique words.  Then when you spin off a list you can spin off
  258.      either the marked words or the un-marked words.
  259.  
  260.      First select Spinoff List from the File menu.  Enter the Input
  261.      File Name.  It must be an extracted single word file.
  262.  
  263.      Next enter the Output File Name.  This will be an ASCII file and
  264.      you may name it whatever you wish.
  265.  
  266.      Finally enter 'a' or 'i' to spin off either active or inactive
  267.      words.  Press F10 and processing will begin.  
  268.  
  269.      If you plan to use this file as an include word list or a discard word
  270.      list you will probably want to use '.WRD' as the filename extension. 
  271.      You can change the default file names that PC-INDEX uses for include
  272.      and discard word lists by using the Edit Word List Filenames under the
  273.      Edit menu.
  274.  
  275.                                  Extract Phrases
  276.  
  277.      Extract Phrases will search through a document and find all
  278.      occurrences of a list of phrases.  It is the first step performed in
  279.      creating a phrase index.  It's function is to extract each individual
  280.      phrase from a document and record it.  
  281.  
  282.      Before you begin with the Extract Phrases selection, you need to
  283.      select the proper document type from the Document menu.
  284.       
  285.      Select the Extract Phrases option from the FILE menu by using the
  286.      cursor keys and pressing ENTER.  You should now see a new window
  287.      asking you for an input filename, an output filename, the page size,
  288.      the first page number to start indexing on, and the first page number
  289.  
  290.  
  291.                                 5
  292.  
  293.  
  294.  
  295.      to use.
  296.  
  297.      For the input filename, enter the name of the document that you want
  298.      to index and press enter.  For the output filename type any name you
  299.      want and press enter.  
  300.  
  301.      The output file is not the index, but a sorted list of all phrases in
  302.      the document and the page numbers that they occur on.  It is
  303.      recommended that you use the same name as the document with  '.srt' as
  304.      the extension.  
  305.  
  306.      The entry for page size is only used if you are using a Text or ASCII
  307.      file.  If you use a word processor supported directly by PC-INDEX then
  308.      you can ignore this entry.  For a list of word processors supported by
  309.      PC-INDEX, look in the Document menu.
  310.  
  311.      The next entry is Start Indexing on Page.  This entry allows you to
  312.      skip a few pages at the beginning of a document before the indexing
  313.      starts.  This will let you skip a title page, table of contents, or
  314.      anything else that you don't want to index. 
  315.  
  316.      The First Page Number to use setting will determine what page number
  317.      PC-INDEX will use as the first page number.   This entry can be used
  318.      with the Start Indexing on Page setting so that you can start indexing
  319.      on page four, but the first page number will be page one.  
  320.  
  321.      The completed window should look like something like this:
  322.      +---------------------------------------------------------------+
  323.      |                                                               |
  324.      |  Input File Name:   (Name of Document to process)             |
  325.      |  pci.doc                                                      |
  326.      |                                                               |
  327.      |  Output File Name:                                            |
  328.      |  pci.srt                                                      |
  329.      |                                                               |
  330.      |  Page Size  Start Indexing on Page    First Page Number to use|
  331.      |     66               4                           1            |
  332.      +---------------------------------------------------------------+
  333.  
  334.      When you have finished entering the filenames and other information,
  335.      press F10 to begin processing.
  336.  
  337.  
  338.                                Build Phrase Index
  339.  
  340.      Build Phrase Index  is the final step in creating a phrase index. 
  341.      Build Phrase Index takes the file created by the 'Extract Phrases'
  342.      selection and creates the phrase index.
  343.  
  344.      Select 'Build Phrase Index' from the FILE menu.  You will be asked for
  345.      the input file and output file.  Enter the name of the extracted word
  346.      file that you created with the Extract Words process.  This file
  347.  
  348.  
  349.                                 6
  350.  
  351.  
  352.  
  353.      should have '.SRT' as the filename extension.
  354.  
  355.      Next you will be asked what name you want to use for the output file. 
  356.      This is the filename that the actual index will be called.  It is
  357.      recommended that you use the original document name with the extension 
  358.      '.NDX'.
  359.        
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.                                 7
  408.  
  409.