home *** CD-ROM | disk | FTP | other *** search
/ Online Bible 1995 March / ROM-1025.iso / olb / biblemsc / gnt / wordstat.doc < prev    next >
Text File  |  1994-05-31  |  10KB  |  210 lines
  1.  
  2.   ════════════════════════════════════════════════════════════════════════
  3.     WordStat v.3.1                                           1 June 1994
  4.   ════════════════════════════════════════════════════════════════════════
  5.  
  6.                         Word Statistician - ver.3.1
  7.             Copyright (c)1994, Bob Rinker - All Rights Reserved
  8.  
  9.                                by Bob Rinker
  10.  
  11.                            Bitnet:  rrinker@fccj
  12.                 Internet: rrinker%fccj.bitnet@uga.cc.uga.edu
  13.  
  14.  
  15.   WORDSTAT is a special-purpose text processing program.  It reads an
  16.   ASCII file and produces certain statistics about the file. Specifically,
  17.   it can produce a list of all the unique words in the file and the number
  18.   of times each occurs.  This list can be presented in lexicographic
  19.   order, in order of frequency of occurrence (most frequent first), and in
  20.   order by length of word (longest first). The program can also produce a
  21.   count of the number of times each letter in the alphabet occurs in the
  22.   file.
  23.  
  24.   When looking at words, case is ignored.  Strings of characters that
  25.   start with numerals or with most non-alphabetic characters are ignored.
  26.   However, words immediately preceded by a left parenthesis [(] or a
  27.   double quote mark ["] WILL be recognized.  Hyphenated words appearing on
  28.   an individual line will be counted as a single word.  Should hyphenation
  29.   occur over a line break, the hyphenated term will be treated as two
  30.   separate words.
  31.  
  32.   WORDSTAT is not limited by available DOS memory in the number of unique
  33.   words it can handle.  As it processes your file, it creates temporary
  34.   files on your hard disk and swaps data out to them. The number of unique
  35.   words it can handle is limited only by the amount of free space on your
  36.   drive.  For this reason, WORDSTAT is NOT designed to be run on systems
  37.   with no hard drive.
  38.  
  39.   No particular installation is required to use WORDSTAT.  The program
  40.   supports all video display modes and all text printers.  The syntax for
  41.   invoking the program is the following:
  42.  
  43.            WORDSTAT <-s | /s> <inputfile.ext> <outputfile.ext>
  44.  
  45.   Typing WORDSTAT alone and pressing ENTER will start the program.
  46.   However, the command line may have up to three optional parameters.
  47.  
  48.   The command "WORDSTAT" may be followed by at least one space and the
  49.   name of the input file to be analyzed.  That may in turn be followed by
  50.   at least one space and the name to be used for the output file.  After
  51.   the program starts, a menu screen will allow you to specify or change
  52.   filenames, as well as select desired options.
  53.  
  54.   The -s or /s switch for "sound" (if selected) must precede any input or
  55.   output filenames.  This switch will activate a series of "alert tones"
  56.   once WORDSTAT has completed all of its statistical searches.  The
  57.   activation of this switch can be helpful when an extremely long document
  58.   is being analyzed.  The default is no sound whatsoever.
  59.  
  60.   If input or input-and-output filenames were specified on the command
  61.   line, these will already be entered for you in the menu.  Otherwise, you
  62.   will be prompted for at least an input filename, without which the
  63.   program will not be able to function.
  64.  
  65.   If no output filename was specified, the output name WORDSTAT.OUT will
  66.   be suggested.  Should you desire a different output filename, use the
  67.   arrow keys or the ENTER key to highlight the filename, then type your
  68.   desired filename in place of WORDSTAT.OUT.  Should you prefer no file
  69.   output in this category, change this entry to NONE.
  70.  
  71.   Other options selectable on the menu screen are the following:
  72.  
  73.      (a) echoing program output to the screen
  74.          (not recommended for lengthy files);
  75.  
  76.      (b) producing the frequency count for individual letters
  77.          (trivial, but an option nevertheless);
  78.  
  79.      (c) sorting the words by frequency; and
  80.  
  81.      (d) sorting the words by length.
  82.  
  83.   Any or all of these can be selected or deselected by moving the
  84.   highlight to the line describing the option and pressing the space bar
  85.   to toggle the option.  When toggled to ON, the ( ) will appear as (X).
  86.  
  87.   If you select the "sort by frequency" or "sort by word length" options, 
  88.   you also will be able to select an output filename to receive the
  89.   specific output of those selections.  If no output filename was
  90.   specified on the command line, the default filenames for these options
  91.   are WORDSTAT.FRQ and WORDSTAT.SIZ; otherwise, the specified output
  92.   filename will appear, followed by the extensions .FRQ and .SIZ in each
  93.   case.
  94.  
  95.   Should you desire to change any of the suggested filenames, these can be
  96.   edited as noted above: first use the arrow keys or the ENTER key to
  97.   highlight the name to be changed, then use the left and right arrow keys
  98.   as well as the backspace and delete keys to make the necessary changes.
  99.  
  100.   If you do not desire any output disk files to be created, but would like 
  101.   to view the output on-screen, select the desired options as instructed, 
  102.   but type "NONE" in each of the filename entry sections.  On-screen 
  103.   display of the output from the selected categories requires toggling the
  104.   "Echo Output to Screen" menu selection to ON (X).  Without such a
  105.   toggle, there will be NO output whatsoever from any category that has
  106.   "NONE" selected as the output filename.
  107.  
  108.   Should the DEL or backspace key be used to completely blank out the 
  109.   filename, "NONE" will be inserted automatically in that category.  If 
  110.   you do not want ANY sorting or display of the frequency or size options, 
  111.   simply use the spacebar to deselect the menu option entirely rather than
  112.   alter the category entry to "NONE" (whenever "NONE" is selected, sorting
  113.   will ALWAYS occur, whether or not the on-screen display or an output
  114.   filename has been selected).
  115.  
  116.   All output files will be in ASCII form, viewable with any display
  117.   utility or word processor, as well as printable on any text printer.
  118.  
  119.      NOTE: for lengthy files, it is NOT recommended that you view the
  120.      results on-screen, since there is no page-pause feature built in.
  121.      On-screen viewing is only a viable option when dealing with very
  122.      short text files.
  123.  
  124.   When you have finished selecting filenames and options, press the F10
  125.   key to continue.  The program will first check to see that the file
  126.   names are in order -- i.e., that the input file exists, and that there
  127.   are not two output files specified with the same file name.  Should
  128.   there be a problem with the files as named, the program will indicate
  129.   the nature of the problem and will return you to the options menu.  You
  130.   then must change the items on the menu and try again, or press the
  131.   escape key to exit the program.
  132.  
  133.   As the program runs, a display will show the progress of its work.  If
  134.   the -s or /s option has been selected, a series of musical tones will
  135.   announce the end of the process.  A summary total will be displayed once
  136.   the program has finished.
  137.  
  138.  
  139.                            WARNINGS AND CAUTIONS
  140.  
  141.   WARNING: If the file to be analyzed is in the form of a list ALREADY in
  142.   alphabetical order, WORDSTAT may not function properly.  The initial
  143.   function of the program is to create an alphabetically-sorted list with
  144.   frequency counts.  A list already sorted in alphabetical order may cause
  145.   havoc to WORDSTAT, possibly locking up your computer and leaving lost
  146.   clusters as a result of having to reboot.
  147.  
  148.   CAUTION: When naming output files, should you accidentally specify
  149.   identical filenames in one or more of the categories, an error message
  150.   will result.  You must manually rename or eliminate one or more of the
  151.   filenames in question to resolve this conflict.
  152.  
  153.  
  154.                          COMMENTS AND SUGGESTIONS
  155.  
  156.   Comments, bug reports, and suggestions for improvement are welcomed.
  157.   Please contact the author at the above Bitnet or Internet address.
  158.  
  159.  
  160.   ════════════════════════════════════════════════════════════════════════
  161.                             LICENSE AND WARRANTY
  162.   ════════════════════════════════════════════════════════════════════════
  163.  
  164.                         Word Statistician - ver. 3.1
  165.             Copyright (c)1994, Bob Rinker  - All Rights Reserved
  166.  
  167.   WORDSTAT was authored and is copyrighted by Bob Rinker with all rights
  168.   being reserved.
  169.  
  170.   This program is distributed as FREEWARE to individuals, and may be
  171.   freely copied and distributed to individuals and electronic bulletin
  172.   board systems by any means so long as the complete distribution package
  173.   is included without alteration or change.
  174.  
  175.   The complete distribution package consists of the executable file
  176.   WORDSTAT.EXE as well as the file WORDSTAT.DOC, containing the program
  177.   documentation as well as this license agreement.
  178.  
  179.   WORDSTAT may be distributed as part of another program or package, so
  180.   long as that program or package is also distributed as Freeware.
  181.   Shareware and commercial program authors who wish to include WORDSTAT as
  182.   part of their product must make prior arrangements with the author.
  183.  
  184.   Shareware authors can expect the granting of a free license.  Commercial 
  185.   authors must expect a small royalty arrangement.  For network, business, 
  186.   organizational, or governmental use, contact the author for site license
  187.   rates.  The author may be contacted via BITNET or the INTERNET at the
  188.   addresses given below.
  189.  
  190.   Note that the bundled distribution of this package as part of a
  191.   shareware or commercial product does not preclude the distribution
  192.   of this package as a separate Freeware product.
  193.  
  194.   WORDSTAT is offered as-is, with no actual or implied warranty.  Users
  195.   run the program at their own risk.  The author will not be responsible
  196.   for any damages or loss incurred by users of this program.  Use of the
  197.   program constitutes acceptance by the user of these terms.
  198.  
  199.  
  200.                                  Bob Rinker
  201.  
  202.                            Bitnet:  rrinker@fccj
  203.                 Internet: rrinker%fccj.bitnet@uga.cc.uga.edu
  204.  
  205.   ════════════════════════════════════════════════════════════════════════
  206.     WordStat v.3.1                                           1 June 1994
  207.   ════════════════════════════════════════════════════════════════════════
  208.  
  209.                                    -eof-
  210.