home *** CD-ROM | disk | FTP | other *** search
/ CP/M / CPM_CDROM.iso / cpm / programs / ppspell / speled.dqc / SPELED.DOC
Encoding:
Text File  |  1985-02-09  |  4.9 KB  |  107 lines
  1.                            "SPELL-ED"
  2.                  A Utility Program For Use With
  3.                         Alan Bomberger's
  4.                  POOR PERSON'S SPELLING CHECKER
  5.  
  6.                                by
  7.                         David Grenewetzki
  8.                            DG/Systems
  9.  
  10.  
  11.      Alan  Bomberger's program SPELL (the Poor  Person's  Spelling 
  12. Checker) which first appeared in "Dr.  Dobbs Journal" has become a 
  13. success  in  the  world of public domain  software.   The  program 
  14. described in this documentation,  SPELL-ED, extends the utility of 
  15. the original SPELL program by adding a number of features  usually 
  16. found only in "commercial" products.
  17.  
  18.      SPELL  reads  in a text file,  constructs a list of  distinct 
  19. words contained in the file,  and compares this list with a number 
  20. of  lexicon files.   Next,  SPELL outputs a list of the words  not 
  21. found  in  the lexicon files to the terminal and optionally  to  a 
  22. file  called  SPELL.LEX.   Other command line  options  allow  the 
  23. output list to be also directed to the printer.
  24.  
  25.      In  normal operation,  SPELL's output file of potential "bad" 
  26. words,   SPELL.LEX,  must  then  be  edited  to  sort  out  "true" 
  27. misspelled  words from those which are merely not "known"  by  the 
  28. lexicon.   Finally,  the original text file must be examined,  and 
  29. the true "bad" words found and corrected.  This editing process is 
  30. time  consuming  and  often takes more time  than  manually  proof 
  31. reading the original document.
  32.  
  33.      The program described in this document, SPELL-ED, was created 
  34. to  speed  up  the  process  of editing  the  file  SPELL.LEX  and 
  35. correcting the errors in the text file.  SPELL-ED reads in SPELL's 
  36. output file,  SPELL.LEX, and displays each potential "bad" word on 
  37. the console.   The user is asked whether the word should be  added 
  38. to the lexicon, marked for later editing in the original text file 
  39. or merely ignored.
  40.  
  41.      Assume  that you wish to check the spelling of an ASCII  file 
  42. called  FILE.TXT.   First use SPELL to check the file against your 
  43. lexicon files using the command:
  44.  
  45.                     SPELL d:FILE.TXT F
  46.  
  47. The "d:" in the command line is an optional disk  specifier.   The 
  48. "F"  in the command line forces the output list of potential "bad" 
  49. words  to  be  placed in a file called SPELL.LEX  on  the  default 
  50. drive.  Next, invoke SPELL-ED with the following command:
  51.  
  52.                     SPELL-ED d:FILE.TXT
  53.  
  54. SPELL-ED  assumes  that  the file SPELL.LEX  is  resident  on  the 
  55. default drive.   When SPELL.LEX file is successfully opened,  each 
  56. word  in  the  file is displayed on the terminal and the  user  is 
  57. asked for one of three inputs:
  58.  
  59.                     A --> (A)dd to NEW.LEX
  60.                     M --> (M)ark in FILE.TXT
  61.                     I --> (I)gnore this word
  62.  
  63.      If "A" is depressed,  the displayed word will be added to the 
  64.      end of the lexicon file,  NEW.LEX.   If the file NEW.LEX does 
  65.      not  exist,  it  will be created by SPELL-ED on  the  default 
  66.      drive.   If the file already exists on the default drive, the 
  67.      new entries will be appended to the end of NEW.LEX.
  68.  
  69.      If "M" is depressed, each occurrence of the displayed word in 
  70.      the  file d:FILE.TXT will be marked with a pair  of  trailing 
  71.      #'s.   For  example,  the  misspelled word  "calender"  would 
  72.      appear as "calender##" in the marked file. 
  73.  
  74.      If  "I" (or any other key) is depressed,  the displayed  word 
  75.      will  be ignored i.e.  neither sent to NEW.LEX nor marked  in 
  76.      FILE.TXT.
  77.  
  78.      Typing a Control-C during this process will cause a graceful 
  79.      abort of the program.
  80.  
  81. When  the end of the list of "bad" words is reached,  a  temporary 
  82. file,  TEMP.$$$,  will  be created (if necessary) to hold a marked 
  83. copy of FILE.TXT.  When this file write is successfully completed, 
  84. the following steps occur:
  85.  
  86.           1. Erase FILE.BAK (if it exists)
  87.           2. Rename FILE.TXT to FILE.BAK
  88.           3. Rename TEMP.$$$ to FILE.TXT
  89.           4. Erase SPELL.LEX
  90.  
  91. At  this point,  most word processors can easily search  FILE.TXT 
  92. for  the "##" pattern and find all words requiring correction  in 
  93. minimum  time.   Also,  your lexicon file NEW.LEX will have  been 
  94. updated to include any "new" words found by SPELL.
  95.  
  96. The  source  code  for SPELL-ED is written in  Software  Toolworks 
  97. C/80.   This  program is copyright 1982 by David  Grenewetzki  and 
  98. DG/Systems.   Unlimited  non-commercial  distribution and  use  of 
  99. SPELL-ED  is  authorized.   Send  comments,  suggestions  and  bug 
  100. reports to:
  101.  
  102.                         David Grenewetzki
  103.                            DG/Systems
  104.                        23145 Bigler Street
  105.                     Woodland Hills, CA 91364
  106.                          (213) 716-1655
  107.