home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / apps / word / gram_151 / read_me.1st < prev   
Text File  |  1994-03-08  |  7KB  |  168 lines
  1.  
  2.  
  3. Grammarian
  4.  
  5.     Version 1.5.1 by Dan Panke
  6.  
  7.     Total Register Users (as of 94-02-06): 4
  8.  
  9.  
  10. **********************************************************************
  11. Grammarian is POSTCARDWARE/LETTERWARE. If you use any of the files
  12. located in this archive you are required to send a postcard/letter to:
  13.  
  14.                     Dan Panke
  15.                     3559 Trappers Road,
  16.                     Gloucester, Ontario
  17.                     Canada  K1T 2R1
  18.  
  19. Please include your name and return address on the postcard as well
  20. as the words:
  21.                     Grammarian 1.5.1
  22. **********************************************************************
  23.  
  24.  
  25. OVERVIEW
  26.  
  27.     Grammarian is a program designed to examine text files for word
  28. usage, spelling, and grammatical rules. Grammarian may not be right in
  29. everything it finds but it does present some good reminders.
  30.  
  31.  
  32. HOW TO USE GRAMMARIAN
  33.  
  34.     Use of Grammarian is simple. Place 'GRAMMAR.PRG' and 'GRAMMAR.INF'
  35. in the same path, and run 'GRAMMAR.PRG' in medium or high resolution.
  36. Choose the text file you wish Grammarian to check via the file
  37. selector then pick an OPTION for the Grammarian check.
  38.  
  39.  
  40. OPTIONS
  41.  
  42.     An Option can be selected by moving the inverse text bar with the
  43. UP or DOWN arrow keys and pressing RETURN when the desired Option is
  44. highlighted. The mouse can also be used to highlight the desired
  45. Option and a second click on the highlighted line will begin
  46. execution.
  47.  
  48.     CHECK TO SCREEN: All Grammarian display will be directed to your
  49.     monitor. If Grammarian finds anything of interest in the file, the
  50.     program will stop and display some text about the possible problem
  51.     encountered. To continue with the check, press any key or click
  52.     the mouse. You may also exit Grammarian at any point by pressing
  53.     'ESCAPE'.
  54.  
  55.     NON-STOP CHECK TO FILE (filename.CHK): As well as checking to the
  56.     screen, this option creates a text file with the Grammarian check
  57.     embedded in the file. The file will be created in the same path
  58.     as the current file being checked but will have a file extender of
  59.     'CHK'. Be cautious if you use 'CHK' for file extenders as
  60.     Grammarian makes no check for existing files and will overwrite
  61.     them. As well, Grammarian makes no check for available disk space
  62.     so make sure you have enough.  The embedded text added to the
  63.     'filename.CHK' file will be enclosed between lines of number signs
  64.     ([## - Grammarian error report - ##]). You may stop the
  65.     Grammarian non-stop check by pressing 'ESCAPE'.
  66.  
  67.     CONFIRM CHECK TO FILE (filename.CHK): This option is very similar
  68.     to the NON-STOP CHECK except you will be prompted by Grammarian to
  69.     send or not send the error report to the CHK file. To have
  70.     Grammarian send the error report to the CHK file, either press 'Y'
  71.     (for YES) on the keyboard or click the LEFT mouse button. Anything
  72.     else will NOT send the error report to the CHK file.
  73.  
  74.     EXIT [RETURN TO FILE SELECTOR]: Allows you to go back and reselect
  75.     another file if you've made an incorrect choice.
  76.  
  77.     QUIT [END GRAMMARIAN]: Take a guess.
  78.  
  79.  
  80. THE 'GRAMMAR.TXT' FILE
  81.  
  82.     With a standard text editor or word processor that loads and saves
  83. in ASCII format you can edit or delete the grammatical checks. The
  84. format of the 'GRAMMAR.TXT' file is as follows:
  85.  
  86.     FIRST LINE - will be displayed when any grammatical error is
  87.     found.
  88.  
  89.     ANY LINE BEGINNING WITH '>' - indicates a word or group of words
  90.     to check for within your document. Added spaces may be
  91.     appropriate to narrow the search field. (i.e. If you are wanting to
  92.     find 'its' and you entered a line in 'GRAMMAR.TXT' of '>its',
  93.     Grammarian would give you a warning at 'zits', 'itself', 'bitset',
  94.     etc. To narrow the search, type an entry of '> its '.) A wild
  95.     card '*' may be used to represent any letter of the alphabet in
  96.     upper or lower case (a-Z).
  97.  
  98.     ANY LINE BEGINNING WITH '/' - is considered a comment line and
  99.     will be ignored. However, the slash ('/') will not be ignored on
  100.     the FIRST LINE (see above).
  101.  
  102.     TEXT LINES - these lines describe the grammatical error
  103.     encountered and are displayed on the screen. View the
  104.     'GRAMMAR.TXT' file for a complete understanding of how the file is
  105.     constructed.
  106.  
  107.     Once you're edited the 'GRAMMAR.TXT' file and saved it, run the
  108. 'COMPILE.PRG' and select the 'GRAMMAR.TXT' file via the File Selector.
  109. The Compiler will create your new 'GRAMMAR.INF' file.
  110.  
  111.  
  112.     If you have any problems, suggestions or additions for Grammarian,
  113. please contact me on the following systems:
  114.  
  115.                             GEnie:  D.PANKE
  116.                            Delphi:  DPANKE
  117.                          Internet:  dpanke@proton.resudox.net
  118.         Bullet BBS (613)731-2779 :  SysOp
  119.  
  120.  
  121. UPDATES:
  122.  
  123. Version 1.0.1
  124.     Added- Informed user to boot in medium or high resolution if
  125.         incorrect resolution is used.
  126.  
  127. Version 1.1.0
  128.     Added- Use of 'GRAMMAR.INF' file so users can enter their own
  129.         checks.
  130.  
  131. Version 1.2.0
  132.     Added- Colour for medium resolution.
  133.     Removed- Checking of zero length lines.
  134.     Added- Option to save a document to a text file (.CHK).
  135.     Changed- Multiple printing of the same document line (unless more
  136.         then one error is encountered in a single line).
  137.  
  138. Version 1.3.0
  139.     Added- Stripped 'tabs' from input file for a more thorough search
  140.         of file.
  141.     Added- Wild card '*' for search strings.
  142.     Added- More entries to the GRAMMAR.INF file.
  143.     Fixed- A bug reported in the CHK files produced by Grammarian.
  144.         (Thanks for reporting it, Bruno. BTW, where's your
  145.         postcard/letter?)
  146.     Added- Confirm CHK routine, so unwanted errors would not be added
  147.         to the CHK file.
  148.  
  149. Version 1.4.0
  150.     Added- The use of a slash ('/') to indicate a comment line.
  151.     Added- More entries to the GRAMMAR.INF file.
  152.     Added- Simple routine to make sure the Grammarian text would be
  153.         displayed properly no matter what file is loaded.
  154.     Fixed- A coding bug that occasionally gave an improper display of
  155.         the error report.
  156.  
  157. Version 1.5.0
  158.     Shortened code and added the compiler program to speed up
  159.         execution of the checking process.
  160.     Added- More entries in the GRAMMAR.INF file.
  161.  
  162. Version 1.5.1
  163.     Fixed- Minor bug that hindered display of the first line of the
  164.         error message. The program worked uncompiled but didn't when
  165.         compiled.
  166.     Added- More entries to the GRAMMAR.INF file.
  167.  
  168.