home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / wp_dtp / scheck60.lha / spellcheck.doc < prev    next >
Text File  |  1992-07-10  |  9KB  |  221 lines
  1.                            C-Net SpellCheck v6.0
  2.                              ----------------
  3.                         For C-Net AMIGA ** v2.0+ **
  4.  
  5.                    Written by Ray Akey (AKA Heavy Metal)
  6.       Call the support board - The Metal Shoppe BBS (CLink 1:5178/0)
  7.  
  8.                      (519) 255-7378    1200-2400 baud
  9.                      (519) 256-0278   2400-38400 baud
  10.  
  11. What is it?
  12. -----------
  13.                  Simple!  A spell CHECKER for C-Net Amiga.
  14.  
  15.  
  16. ** Changes 6.0!:
  17. ----------------
  18. 1: A HUMONGOUS bug was fixed which caused the editor to be trashed due
  19.    to SAS C's strncpy() function.  This was fixed by writing my own version
  20.    of strncpy() which ALWAYS appends the NULL terminator.  Much thanks to
  21.    Grimalkin for bringing this to my attention!!
  22.  
  23.         [Programmer's Quote of the day: If others' functions don't]
  24.         [                               work, write them yourself ]
  25.  
  26. ** Changes 5.1:
  27. ---------------
  28. 1: SpellChecking routines even faster now.
  29. 2: The "More (Y/n)" prompt is now disabled during a dictionary import.
  30.  
  31.    **NOTE ON DICTIONARY SORTING:  I've come across a serious problem with
  32.  the WB "Sort" command that Spellcheck uses and the stack.  If you are sorting
  33.  a large dictionary, you may get a visit from our Guru friend. If so, increase
  34.  your stack.  The highest I've ever needed the stack for the WB SORT command
  35.  is 150,000 (OUTRAGEOUS!!).  SO:  As of the next version, sorting will be done
  36.  INTERNALLY and on a much more liberal stack - Within Ken's  recommended 40k
  37.  C-Net stack.
  38.  
  39. ** Changes 5.0:
  40. ---------------
  41. 1: New MCI colors now used.
  42. 2: MOST text is now external and can be edited as BBSTEXT can be.
  43. 3: Works with C-net AMIGA v1.98v and up.
  44.  
  45. ** Changes 4.1:
  46. ---------------
  47. 1: Bug fixed where text in 2 prompts were overwritten.
  48. 2: Now skips Quoted lines.  See Spellcheck.config for more on this.
  49.  
  50. ** Changes 4.0:
  51. ---------------
  52. 1.  A **MAJOR** bug has been fixed where the program caused a software failure
  53.     in the suggestion routines. Seems AmigaDOS only allows 16 files open at a
  54.     time and I missed a file close in the Suggestion forward (+) and suggestion
  55.     backward (-) routines causing that limit to be exceeded.
  56.  
  57. 2.  Now tells how many words were checked, how many were not found in the
  58.     dictionaries and also displays a percentage of unfound/total words in
  59.     the message.
  60.  
  61.  
  62. ** Changes 3.2:
  63. ---------------
  64. 1. Bug fixed in the suggestion routines where Spellcheck would jump back
  65.    to previous lines already checked.
  66.  
  67. 2. Now displays words to Log that are not found in the dictionary when a user
  68.    activates SpellCheck.
  69.  
  70. ** Changes 3.1: (re-compiled for 1.98D)
  71. ---------------
  72. 1.  Sysop definable MINIMUM length before spellchecking is performed on a word
  73.     ( Edit this in the "Spellcheck.config" that is in your pfiles directory.
  74.       More info on this function can be found in the SPELLCHECK.CONFIG included
  75.       in this .zip package )
  76.  
  77. 2.  If your TEMP path and HARD path are the same, sorting is preformed only on
  78.     the one file..  The program will no longer try to sort both paths or try
  79.     to copy them to the original path unless they are different.
  80.  
  81. ** Changes 3.0:
  82. ---------------
  83. 1. Replace option has been enhanced and now gives the user options to change
  84.    the word, get suggested replacements, and scroll forward/backward through
  85.    the replacement suggestions.
  86. 2. Maint accessed users can add words to the dictionary and words added are
  87.    written to a log for viewing by #1.
  88. 3. Log reflects users who have used SpellCheck.
  89. 4. Sysop can request a dictionary sort of a single or ALL dictionary files.
  90.  
  91. ** Changes 2.1:
  92. ---------------
  93. 1. NOW ALLOWS spellchecking OF Lines x-x (!!!!)
  94. 2. Now has a REPLACE option where the user is prompted for a replacement and
  95.    may hit RETURN to keep the unfound word.
  96. 3. Now has it's own log viewable only by account #1.
  97. 4. Users with MAINT are now allowed to Adopt words from their SpellCheck into 
  98.    the dictionary. Adopted words are the only thing presently written to the
  99.    log.
  100. 5. Some other minor things that make it better that elude me at the moment.
  101.  
  102. Changes 2.0:
  103. --------
  104. Now uses MULTIPLE dictionaries (26) to achieve a faster processing time.
  105.     (tested on a 278 line text file, processed in 2 minutes 22 seconds)
  106.  
  107. YOU CAN [I]MPORT your old dictionaries via the import function.
  108.  
  109. Instead of printing "xxx already in dictionary", words already in dictionary
  110. are displayed in red and newlines are specified by cyan periods "."
  111.  
  112. Dictionaries can now be referenced from ram: or regular hard storage via
  113. configuration file.  
  114.  
  115. Hyphenated words are now supported.
  116.  
  117. New look when words not found in dictionary are displayed as well as displaying
  118. the original line the misspelled word was found in.
  119.  
  120. If you want to use the dictionaries from ram, the config file is already set to do
  121. so...  BUT you must copy these manually into ram or have it done when your
  122. system boots.  For users not familiar with this (like who isn't right???) add
  123. the following line in your startup-sequence somewhere near the bottom before
  124. any ENDCLI >NIL's:
  125.  
  126.                       copy pfiles:Dictionary/#? ram:
  127.  
  128.  
  129.  
  130.  
  131. How it works:
  132. -------------
  133.  Using a set of special dictionaries, the program parses the whole C-Net Text
  134. editor and spell checks the words there using these dictionaries.
  135. You can add words to this dictionary very easily by a text editor or via the
  136. program itself and the functions that allow you to do so are accessible ONLY 
  137. by account number 1!  No-one else has access to the menu that the sysop sees
  138. upon entering "CNET SPELLCHECK".
  139.  
  140.  
  141. Installation:
  142. -------------
  143. Copy "SpellCheck" to your PFILES: directory, "SpellCheck.config" to your
  144. SYSTEXT: directory and "SpellCheckText" to your SYSTEXT directory.
  145.  
  146. Create a directory called "Dictionary" in your Pfiles: directory.
  147. Copy the included dictionary files to the "Pfiles:Dictionary" directory.
  148. Toss this doc file out the door if you like :)
  149.  
  150. Look for the section in your BBSMENU where it has the label "EDITOR WITH TEXT:"
  151. and after the last command in that part of the menu, add the following line..
  152.  
  153. U, Userspell            |\#2pfiles:SpellCheck\
  154.  
  155. ^ this was the only letter I could find empty on my system, feel free to use
  156. another UNUSED letter.
  157.  
  158. That's it... When you are in the editor ANYWHERE on your system, enter
  159. .U and you will enter the C-NET SPELLCHECK program.
  160.  
  161.  
  162. Menu Commands:
  163. --------------
  164. NOTE:  Only the sysop (ID #1) has the menu, ALL OTHER USERS will automatically be
  165.        put into SPELLCHECK mode.
  166.  
  167.  
  168. [E]ditor SpellCheck:  Your basic spellcheck, processes the whole C-Net editor
  169.                       and gives the user the option to replace the misspelled or 
  170.                       unfound word(s) also.
  171.  
  172. [L]og         :  Gives account #1 a log of the words imported by other users
  173.                  with the Sysop flag.
  174.  
  175. [A]dd Words      :  For adding words manually
  176.  
  177.                NOTE: multiple entries are allowed on one line as long as there
  178.                      is a space between each word.
  179.  
  180. [I]mport words: One of the MOST useful features besides the spellchecker
  181.                 itself.  Allows you to use a pre-spellchecked ASCII document 
  182.                 (ie. a ProWrite (ASCII ONLY) SPELLCHECKED text file). and import
  183.                 those words into the dictionary.  Multiple words per line are 
  184.                 allowed, presently there is a limit of 199 characters per line
  185.                 on the import buffer.
  186.                
  187.                 NOTE:  duplicate words (words already in the dictionary) will be
  188.                        filtered out and NOT added to the dictionary.
  189.  
  190. [D]elete words: Future expansion.
  191.  
  192. [W]ords here  : Displays a count of the words in the dictionary, first in alpha
  193.                 order and then a TOTAL of all.
  194.  
  195. [Q]uit        : Back to the editor..
  196.  
  197. [S]ort        : Sorts a single dictionary, you will be prompted with the
  198.                 letter (a,b,c,d,e,f,etc,..) of the dictionary to sort.
  199.  
  200. [G]lobal Sort : Sort all Dictionary files.
  201.  
  202. NOTE:  After a single sort or Global sort, all dictionaries will be copied
  203.        to the hard storage specified in SpellCheck.config (again, if they are
  204.        not the same path).
  205.  
  206.  
  207.  After [I]mporting OR [A]dding words, if your paths in the config file are 
  208. different, the new dictionary files will be copied to non-volatile storage 
  209. automatically after importing the word to the dictionary in RAM.  I employ this
  210. method since importing to RAM boosts the efficiency of this program by a 
  211. longshot..  
  212.  Those who use hard storage ( such as DH0: or df0: ) for both paths
  213. will not get the speed benefits that using RAM would give you.
  214.  
  215.  If you run into ANY problems, check your "SpellCheck.config" to be sure the
  216. proper paths are specified.  An explanation of the lines exists in that file.
  217.  
  218.  
  219.  If YOU have any possible suggestions, please E-Mail me or respond to this file
  220. on Future World.
  221.