home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / txtutl / fig.arc / FIG.DOC < prev   
Encoding:
Text File  |  1988-04-29  |  5.0 KB  |  133 lines
  1.                                 F I G
  2.  
  3.                         "FOG Index Generator"
  4.  
  5.                          by Lee David Rimar
  6.                       1988, No Rights Reserved
  7.  
  8.  
  9.                             -- PURPOSE --
  10.  
  11. FIG.COM analyzes ASCII text files.  It generates some statistics 
  12. which pertain to "readability."
  13.  
  14. FIG also offers comments and suggestions on ways to make the text 
  15. more readable.  For example, if the sentences tend to be too long, 
  16. FIG might display this:
  17.  
  18.      Average sentence length:  22 words.
  19.        ->  Sentences may be too wordy.
  20.  
  21. Among the other stats is a FOG index.  This number roughly matches 
  22. the reading-level needed to comprehend the text.  For example, a FOG 
  23. index of 8 means the text should be understandable by an 8th grader.
  24.  
  25. When writing for the general public, a FOG index of 8 to 10 is 
  26. desirable.  If it's much higher, the writing may seem overbearing.
  27. If it's much lower, the writing seem choppy.
  28.  
  29. By paying attention to FIG's comments and suggestions, you can make 
  30. your text easier to for others to read.
  31.  
  32.  
  33.                             -- ORIGINS --
  34.  
  35. This is an extensive re-work of WRITER.BAS, which originally appeared 
  36. in CODEWORKS magazine.
  37.  
  38. FIG.BAS was tested and debugged with BASIC-80 (MBASIC v5.21).  The
  39. version distributed in this ARChive should also run correctly under
  40. any of the 16-bit BASICs which have their roots in Microsoft:
  41. BASICA, PCBASIC, GWBASIC, et al.
  42.  
  43.  
  44.                          -- HOW TO USE IT --
  45.  
  46. At your system prompt, enter:      BASIC FIG
  47.  
  48. BASIC (or GWBASIC, or whatever Basic you use) will load FIG.  FIG
  49. will then prompt for a filename.  It will take anywhere from 5 to
  50. 30 seconds to analyze the file.
  51.  
  52. FIG reads only "normal" ASCII files.  Lines must be shorter than 128 
  53. characters, and should be terminated with standard carriage return- 
  54. line feed combinations.
  55.  
  56. Those limitations exclude WordStar document files, but these may be 
  57. processed with any of several utility programs available to convert 
  58. them to ASCII.
  59.  
  60.                       -- HOW FIG READS FILES --
  61.  
  62. FIG usually needs at least 100 words of text to generate accurate 
  63. statistics.  Up to a point, more text means more reliable results.  
  64. To balance accuracy against extra analysis time, FIG "samples" long 
  65. files instead of reading them completely.
  66.  
  67. On short files (under 400 words) FIG reads and analyzes the whole 
  68. thing.  But on longer files, FIG stops reading at the end of the 
  69. first sentence it finds past the 400-word mark.  Normally this is a 
  70. large enough sample to give reliable results.
  71.  
  72. If FIG can't find the end of a sentence after 400 words, it will just 
  73. stop reading on the 500th word.  Also, FIG will never read more than 
  74. the first 100 text lines of a file.
  75.  
  76.  
  77.                        -- OTHER LIMITATIONS --
  78.  
  79. FIG doesn't "understand" what it reads; it only analyzes some of the 
  80. "mechanics" of writing.  It might not be reliable analyzing technical 
  81. writing or material with a specialized vocabulary.
  82.  
  83. FIG works best on "blocks" of text, paragraph or line oriented.  
  84. Using it on files with many headings (like this document) or columns 
  85. will not give accurate results.
  86.  
  87. FIG doesn't generate a word-frequency list or count unique words.  
  88. That was a feature in WRITER.BAS (of which FIG is an offshoot), and I 
  89. had originally planned to include it.  But it slowed the program down 
  90. so much that I left it out.  I don't consider this a great loss; most 
  91. spelling checkers generate that kind of information.
  92.  
  93. FIG is stupid about hyphens; it treats a hyphenated word as two 
  94. words.  This will throw off the word count.  But unless you use a LOT 
  95. of hyphens, it won't affect the other statistics appreciably.
  96.  
  97.  
  98.                          -- LEGAL? NOTICE --
  99.  
  100. This program is "public domain" in the full sense of the word.  So 
  101. many people have contributed to this work (see CREDITS below) that 
  102. all I can take credit for is the current structure and details of the 
  103. code.
  104.  
  105. Use it at home, at work, give it to your friends, whatever.  You can 
  106. even (try to) sell it, but I doubt you'll find any buyers.  Modify it 
  107. it if you like -- but at least be nice and pass your changes on; back 
  108. into the public domain.
  109.  
  110. The flip side of the coin:  No warranties are expressed or implied on 
  111. the suitability of this program for any purpose.  I will not be held 
  112. responsible for anything related to it, period.  You're on your own.
  113.  
  114.  
  115.                        -- CLOSING COMMENTS --
  116.  
  117. I can be contacted on either of the following bulletin boards:
  118.  
  119.      Detroit Area Kaypro User's Group RBBS:  (313) 772-0522
  120.      Tony's Corner QBBS (FidoNet 120/13):    (313) 754-1131
  121.  
  122. Comments, questions, or other notes relating to this program are 
  123. always welcome; as are modifications, enhancements, gifts of food 
  124. and/or money, and/or marriage proposals.
  125.  
  126.  
  127.  
  128. Lee David Rimar                                        29 April, 1988
  129.  
  130.  
  131.  
  132.                                 -eof-
  133.