home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d6xx / d645 / dmd.lha / DMD / Doc / SpellChecker.doc < prev    next >
Text File  |  1992-04-26  |  10KB  |  219 lines
  1.                  DMD Spell Checker Evaluation Version 1.00
  2.                       Copyright © 1992 Fergus Duniho
  3.  
  4.         The DMD Spell Checker consists of three ARexx macros
  5. (ListWords.dme, SpellChecker.dme, and LookUp.dme), the SpellCheck program,
  6. and a dictionary. The dictionary is public domain, but the macros and
  7. program belong to me, Fergus Duniho. I took the dictionary from Jonathan
  8. Potter's SuperSpell, deleted some words from it, and added others to it
  9. while testing the "Add" feature of my Spell Checker.
  10.  
  11.         DISTRIBUTION
  12.  
  13.         The macros are subject to the same distribution requirements as the
  14. rest of DMD, and I have already outlined those in DMD2.readme. Since the
  15. dictionary is public domain, however, it is not subject to the same
  16. requirements. You may freely add to or subtract from it before you
  17. redistribute it. If you do change the dictionary, however, please add no
  18. misspelled or duplicate words to it, and please keep all the words in ASCII
  19. order. SpellCheck may be distributed separately from DMD. See
  20. SpellCheck.doc for further details.
  21.  
  22.         DISCLAIMER
  23.  
  24.         I am not responsible for any mishap or catastrophe that may result
  25. from the use of this product. You use it at your own peril. Should you
  26. encounter any bugs, however, please tell me about them, so that I can
  27. correct them.
  28.  
  29.         GETTING THE REGISTERED VERSION
  30.  
  31.         The registered version should be available sometime this summer. It
  32. uses a more compact dictionary, and so takes less time to spell check a
  33. document. The registered version will not be freely distributable. You can
  34. receive it only from me. For $10.00 (check or cash) ($15.00 outside the
  35. U.S.A.), I will send you a copy of the registered version, along with the
  36. latest version of DMD, once I have finished it. I intend to make it just as
  37. easy to use as this evaluation version.
  38.  
  39.         USING THE SPELL CHECKER
  40.  
  41.         To spell check the document in the current window, first make sure
  42. that the disk with the dictionary is in one your disk drives. Then select
  43. "Check Spelling" from the "Misc." menu. DME will first call a macro called
  44. ListWords. This macro will create a capitalized list of all the words in
  45. your document. It counts as a word any string of letters, both English and
  46. foreign, whose length is greater than one. It also recognizes apostrophes
  47. as parts of words. So, it will recognize "DON'T" and "I'LL" as words. But
  48. it won't recognize an apostrophe-S as part of a word, and it won't
  49. recognize apostrophes that appear at the beginning or the end of a word.
  50. So, when such words as "'TIS" and "IT'S" appear in your document, it will
  51. recognize them as "TIS" and "IT". After ListWords creates a list of the
  52. words in your document, it will sort that list into alphabetical order.
  53.  
  54.         DME then calls the SpellChecker macro. If you have not already
  55. selected a dictionary, it will pop up a file requester for you to choose
  56. which dictionary it will use. After it knows which dictionary to use, it
  57. will compare the alphabetized list of words in your document to the
  58. dictionary. Whenever it finds that a word from the list is not in the
  59. dictionary, it adds that word to another list. Once the Spell Checker has
  60. determined which words are not in the dictionary, it either tells you that
  61. there were no misspelled words, or it pops up a requester for going through
  62. the list of words that were not in the dictionary. It goes through this
  63. list in alphabetical order. It goes to the first line in the document where
  64. the word appears, highlights that line for your convenience, and displays
  65. the word in the requester.
  66.  
  67.         The requester has a string gadget and twelve button gadgets. The
  68. button gadgets are "Skip," "Back," "Keep," "Add," "Unadd," "Add All,"
  69. "Done," "Guess," "Forward," "Backward," "Replace," and "Replace All."
  70.  
  71.         "Skip" moves you to the next word in the list of words not in the
  72. dictionary. If you were at the last word, it moves you to the first word.
  73. It finds the first occurence of the word in your document and highlights
  74. the line. It displays the word on the requester.
  75.  
  76.         "Back" moves you to the previous word in the list of words not in
  77. the dictionary. If you were at the first word, it moves you to the last
  78. word. It otherwise works the same as "Skip."
  79.  
  80.         "Keep" tells the Spell Checker that you want to leave unchanged the
  81. current occurence of the word in your document. It then finds the next
  82. occurence of the word and highlights the line it is on.
  83.  
  84.         "Add" tells the Spell Checker to add the current word to the
  85. dictionary's '.new' file when you press "Done." It then works the
  86. same as "Skip." Whenever you go back to a word you chose to add, the
  87. requester will indicate this.
  88.  
  89.         "Unadd" tells the Spell Checker that you have decided against
  90. adding a word that you had previously decided to add. It then works
  91. the same as "Skip." If you go back to the word, the requester will indicate
  92. that you have chosen not to add it.
  93.  
  94.         "Add All" tells the Spell Checker to add every word in its list to
  95. the appropriate '.new' file. It does so immediately and exits. This gadget
  96. is useful when you are adding to the dictionary a list of words you already
  97. know to be correctly spelled. If, for instance, you want to combine two
  98. dictionaries, you can spell check one against the other, and then use this
  99. gadget to dump all the words that were in it but not in the other into the
  100. other.
  101.  
  102.         "Done" adds to the dictionary's '.new' file all the words for which
  103. you clicked on the "Add" gadget. It then closes the requester and exits
  104. from the Spell Checker.
  105.  
  106.         "Guess" displays the word that appears in the dictionary where the
  107. current word would be if it were in the dictionary. It displays this word
  108. underneath the current word.
  109.  
  110.         "Forward" displays the next word in the dictionary.
  111.  
  112.         "Backward" displays the previous word in the dictionary.
  113.  
  114.         "Replace" tells the Spell Checker that you want to replace the
  115. current occurence of the word. It will replace it with whatever you have
  116. entered into the string gadget.
  117.  
  118.         "Replace All" tells the Spell Checker to replace the current
  119. occurence of the word and every occurence after it with whatever you have
  120. entered into the string gadget. It then moves you to the next word in the
  121. list.
  122.  
  123.         The CLOSEWINDOW button exits from the Spell Checker WITHOUT adding
  124. any words to the dictionary's '.new' file.
  125.  
  126.         ADDING NEW WORDS TO THE DICTIONARY
  127.  
  128.         The Spell Checker creates and appends to the '.new' file of
  129. whatever dictionary it is using. This file has the same name as the
  130. dictionary with a '.new' extension at the end. It contains words that are
  131. to be added to the dictionary. When you want to add these words to the
  132. dictionary, open a CLI window and type
  133.  
  134.         > SpellCheck >T:D Dictionary Dictionary.new ALL
  135.         > Move T:D Dictionary
  136.  
  137.         or type
  138.  
  139.         > SpellCheck >Dictionary.n Dictionary Dictionary.new ALL
  140.         > Delete Dictionary
  141.         > Rename Dictionary.n Dictionary
  142.  
  143.         Wherever "Dictionary" appears in the above lines, you should
  144. substitute the name of your dictionary with its full path.
  145.  
  146.         You can use a similar procedure for adding the contents of another
  147. dictionary to your dictionary, and for adding your own lists of words to
  148. your dictionary. Merely substitute "Dictionary.new" with the name of the
  149. file you want to add. Before you add the contents of a file to your
  150. dictionary, you should make sure that its words are spelled correctly, that
  151. no words appear in it twice, and that all the words in it are alphabetized.
  152.  
  153.         An effective way to do this is to spell check the document you want
  154. to add. ListWords.dme will eliminate redundancies and alphabetize your
  155. list. Then, if you already know that the words in your file are correctly
  156. spelled, you can click on "Add All" to dump them all into the '.new' file.
  157.  
  158.         You do not have to worry about whether any file you add contains
  159. words that are already in your dictionary. SpellCheck will not add to the
  160. dictionary any words that are not already in it. This makes it rather easy
  161. to add two dictionaries together.
  162.  
  163.         And, of course, you can directly edit the dictionary with DME.
  164.  
  165.         USING OTHER DICTIONARIES
  166.  
  167.         You do not have to use the dictionary that comes with the Spell
  168. Checker. You may use any dictionary that contains a single word on each
  169. line, and which has all its words sorted in ASCII order. You may wish to
  170. delete from any other dictionary you use any words that ListWords will not
  171. recognize, such as hyphenated words and words that end with apostrophe-S.
  172. To select your dictionary, use "Select Dictionary" from the "Misc." menu.
  173. It pops up a requester for you to select a dictionary to use with the Spell
  174. Checker.
  175.  
  176.         LOOKING UP A WORD
  177.  
  178.         To look up a word, select "Look Up Word" from the "Misc." menu. A
  179. requester will appear for you to type in the word you want to look up. If
  180. the word is in the dictionary, it will tell you that no words were
  181. misspelled. Otherwise, it will present the spellcheck requester, which I
  182. have already described in this documentation.
  183.  
  184.         FUTURE PROJECTS
  185.  
  186.         I intend on writing a style checker for DME. This will point out
  187. such things as homonyms, commonly confused words, hackneyed words, weak
  188. words, and other misused words. SpellCheck can already be used as a
  189. style checker. But I still have to write the dictionary it will use, as
  190. well as the ARexx interface for DME.
  191.  
  192.         Over the summer, I will write the registered version of SpellCheck,
  193. along with a modified requester. The registered version will skip through a
  194. compacted dictionary, which I already have. It will also include a program
  195. for compacting and decompacting dictionaries. As soon as I figure out how
  196. to write C code for the string operations I need, I will be able to write
  197. these programs. I currently have them coded in ARexx, which is slower. Once
  198. the semester is over, I'll study C more closely and learn what I need to
  199. know.
  200.  
  201.         MY ADDRESSES
  202.  
  203.         Send all contributions to my mailing address:
  204.  
  205.         Fergus Duniho
  206.         1170 Genesee St. B3 A7
  207.         Rochester, NY 14611
  208.  
  209.         Send any comments, requests, or bug-reports to my mailing address,
  210. or preferably to one of my email addresses:
  211.  
  212.         My Internet addresses are
  213.  
  214.         fdnh@uhura.cc.rochester.edu
  215.  
  216.         fdnh@troi.cc.rochester.edu
  217.  
  218.         My GEnie address is F.DUNIHO
  219.