/plugins/SpellCheck/tags/SpellCheckR003/src/cswilly/jeditPlugins/spell/help.html

# · HTML · 187 lines · 153 code · 34 blank · 0 comment · 0 complexity · adedd037d752123547f03eb34a675328 MD5 · raw file 

    

  1. <html>
    2. 

  2. <head>
    3. 

  3.   <title>Spell check jEdit plugin</title>
    4. 

  4. </head>
    5. 

  5. <body>
    6. 

  6. 

  7. 

  8. <h1>Spell Check jEdit Plugin</h1>
    9. 

  9. 

  10. This is an jEdit plugin to perform spell checking of text in a jEdit buffer.
    11. 

  11. It is based on <a href="http://aspell.sourceforge.net/">Aspell</a>
    12. 

  12. (which you will need to download and install before using this plugin) which is
    13. 

  13. available for Windows and various Unix platforms.
    14. 

  14. 

  15. 

  16. <h2>Features</h2>
    17. 

  17. 

  18. <ul>
    19. 

  19.   <li>An jEdit action to spell check selected text</li>
    20. 

  20.   <li>Configurable location of <a href="http://aspell.sourceforge.net/">Aspell</a>
    21. 

  21.     executable</li>
    22. 

  22.   <li>Spell check dialog to allow the user to validate each suspect word. The
    23. 

  23.     dialog has buttons for: Cancel, Change, Change All, Ignore, and Ignore All.
    24. 

  24.     It shows the suspect word, lists suggested replacements, and has a field
    25. 

  25.     where the user can type in the replacement word.</li>
    26. 

  26. </ul>
    27. 

  27. 

  28. 

  29. <h2>System Requirements</h2>
    30. 

  30. 

  31. <ul>
    32. 

  32.   <li>Tested with jEdit 3.0.2 and jEdit 3.1pre5.</li>
    33. 

  33.   <li>The plugin requires Java JDK 1.3--for no real reason (bummer).</li>
    34. 

  34.   <li>Tested on Windows 2000, Linux (with 2.2.14 kernel)</li>
    35. 

  35.   <li>Aspell .32.6 alpha or better (I am using Aspell .33.5 alpha)</li>
    36. 

  36. </ul>
    37. 

  37. 

  38. 

  39. <h2>Installation and Configuration</h2>
    40. 

  40. 

  41. <ul>
    42. 

  42.   <li>Download and install <a href="http://prdownloads.sourceforge.net/aspell/aspell-.33.5-win32-i386.zip">aspell-.33.5-win32-i386.zip</a>
    43. 

  43.     for Windows. If you are running some flavour of Unix, you can get the source
    44. 

  44.     as well as some binarys from <a href="http://aspell.sourceforge.net/">Aspell</a>. </li>
    45. 

  45.   <li>Copy the the <code>SpellPlugin.jar</code> file to your jEdit <code>jars</code>
    46. 

  46.     directory. </li>
    47. 

  47.   <li>Restart jEdit. You should see a <code>Spell Check</code> option on the <code>Help</code>
    48. 

  48.     menu. </li>
    49. 

  49.   <li>In the <code>Utilities/Global Options.../Plugin Options/Spell Check</code>
    50. 

  50.     option dialog set the <code>Aspell executable filename</code> to where
    51. 

  51.     installed it. </li>
    52. 

  52. </ul>
    53. 

  53. 

  54. 

  55. <h2>Usage</h2>
    56. 

  56. 

  57. <ul>
    58. 

  58.   <li>Select the text you would like to spell check</li>
    59. 

  59.   <li>Choose the menu item <code>Plugins/Spell check selection...</code></li>
    60. 

  60.   <li>The Aspell subprocess will start showing a DOS console (anybody knows how
    61. 

  61.     to hide this on Windows?)</li>
    62. 

  62.   <li>You will be prompted with a MS-Office-like spell check dialog box for each
    63. 

  63.     word that needs to be validated.</li>
    64. 

  64.   <li>Below is more info on the dialog box.</li>
    65. 

  65. </ul>
    66. 

  66. 

  67. 

  68. <h3>Spell Check Dialog Box</h3>
    69. 

  69. 

  70. <p>For each misspelled word the user has buttons to choose to:</p>
    71. 

  71. <dl>
    72. 

  72.   <dt>Add (not in this version)</dt>
    73. 

  73.   <dd>Adds the word not in the <cite> Not in Dictionary</cite> field to the dictionary.</dd>
    74. 

  74.   <dt>Cancel</dt>
    75. 

  75.   <dd>Closes the dialog box without making any changes you have made.</dd>
    76. 

  76.   <dt>Change</dt>
    77. 

  77.   <dd>Replaces the word not in the <cite> Not in Dictionary</cite> text field with the word in the
    78. 

  78.     <cite> Change to</cite>  text field. If the <cite> Change to</cite> text field is empty,
    79. 

  79.     the button name changes to <cite>Delete</cite>. To remove the selected word from the item, click
    80. 

  80.     <cite>Delete</cite>.</dd>
    81. 

  81.   <dt>Change All</dt>
    82. 

  82.   <dd>Replaces all instances of the word not in the <cite> Not in Dictionary</cite>
    83. 

  83.     text field with the word in the
    84. 

  84.     <cite> Change to</cite>  text field. If the <cite> Change to</cite> text field is empty,
    85. 

  85.     the button name changes to <cite>Delete</cite>. To remove all instances of the selected word from the item, click
    86. 

  86.     <cite>Delete</cite>.</dd>
    87. 

  87.   <dt>Ignore</dt>
    88. 

  88.   <dd>Leaves the word not in the <cite> Not in Dictionary</cite> text field unchanged.</dd>
    89. 

  89.   <dt>Ignore All</dt>
    90. 

  90.   <dd>Leaves all instances of the word not in the <cite> Not in Dictionary</cite>
    91. 

  91.     text field unchanged.</dd>
    92. 

  92. </dl>
    93. 

  93. <p>The dialog has the following components:</p>
    94. 

  94. <dl>
    95. 

  95.   <dt>Not in Dictionary:</dt>
    96. 

  96.   <dd>Displays a possible error, such as a misspelled word, a duplicate word, or a incorrect capitalization.</dd>
    97. 

  97.   <dt>Change to:</dt>
    98. 

  98.   <dd>Displays a suggested word to replace the word that appears in the <cite> Not in Dictionary</cite>
    99. 

  99.     text field. To accept the suggested replacement, click <cite>Change</cite>. To delete the word in the
    100. 

  100.     <cite> Not in Dictionary</cite> text field, delete the text in the <cite> Change to</cite>
    101. 

  101.     text field, and then click <cite>Delete</cite>.</dd>
    102. 

  102.   <dt>Suggestions:</dt>
    103. 

  103.   <dd>Lists suggested replacement words.</dd>
    104. 

  104. </dl>
    105. 

  105. 

  106. 

  107. <h2>Building</h2>
    108. 

  108. <p>
    109. 

  109. I do the build using
    110. 

  110. <a href="http://jakarta.apache.org/ant/index.html">Ant</a>. Look in the
    111. 

  111. <code>build.cmd</code> file for the version of Ant used. To see the build targets,
    112. 

  112. type <code>build -projecthelp</code>. The most important target is
    113. 

  113. <code>make.jar.spellPlugin</code> which creates the
    114. 

  114. <code>SpellPlugin.jar</code>. There are other targets, but the <code>build.xml</code>
    115. 

  115. is still a bit full of crap.
    116. 

  116. </p>
    117. 

  117. <p>Mike Dillon contributed
    118. 

  118. a <code>makefile.jmk</code> makefile, which should work, but I have not used,
    119. 

  119. but should make some people happy.
    120. 

  120. </p>
    121. 

  121. 

  122. 

  123. <h2>Current Bugs</h2>
    124. 

  124. <ul>
    125. 

  125.   <li>When a selection is spell checked, if its last line is only a newline,
    126. 

  126.     then it is removed.</li>
    127. 

  127. 

  128.   <li>
    129. 

  129.   The Aspell subprocess creates a visible console window on Windows
    130. 

  130.   95/98/NT/2000.
    131. 

  131.   The console window is a long-standing Java
    132. 

  132.   <a href="http://developer.java.sun.com/developer/bugParade/bugs/4244515.html">bug</a>..
    133. 

  133.   Sun encountered problems under Windows 95 and 98 when the JVM ran system calls in a
    134. 

  134.   hidden window, which are still there under Windows NT/2000.
    135. 

  135.   <br></br>
    136. 

  136.   If you kill the visible console window, when you next spell check you will get
    137. 

  137.   an error. If you spell check again, it should work as the subprocess is
    138. 

  138.   recreated.
    139. 

  139.   </li>
    140. 

  140. 

  141.   <li>
    142. 

  142.   The current buffer is changed even if there were no errors corrected in the
    143. 

  143.   buffer.
    144. 

  144.   </li>
    145. 

  145. 

  146. </ul>
    147. 

  147. 

  148. 

  149. <h2>Current Todo List</h2>
    150. 

  150. <ul>
    151. 

  151.   <li>Add words to an user dictionary</li>
    152. 

  152.   <li>Allow the user to reset Ignore All and Change All options (currently these
    153. 

  153.     are result only if jEdit is restarted)</li>
    154. 

  154.   <li>Undo a change</li>
    155. 

  155.   <li>Allow the user access to Aspell options</li>
    156. 

  156.   <li>Complete tool tips on the Validation dialog</li>
    157. 

  157.   <li>Use the EditBus to report spelling errors (so they can be underlined like
    158. 

  158.     Word does)</li>
    159. 

  159.   <li>Highlight the context of the word being corrected</li>
    160. 

  160. </ul>
    161. 

  161. 

  162. 

  163. <h2>Change Log</h2>
    164. 

  164. 

  165. <h3>Release 003 (Sep 09, 2001)</h3>
    166. 

  166.   <ul>
    167. 

  167.     <li>Same functionality as R002, but now in SourceForge's CVS.</li>
    168. 

  168.     <li>Cleaned and improved the build.xml and build.cmd files.</li>
    169. 

  169.   </ul>
    170. 

  170. 

  171. <h3>Release 002 (Apr 22, 2001)</h3>
    172. 

  172. <ul>
    173. 

  173.   <li>Added build files (<code>build.xml</code> and <code>makefile.jmk</code>)
    174. 

  174.     to distribution</li>
    175. 

  175.   <li>Updated <code>help.html</code> with test feedback and system requirements</li>
    176. 

  176.   <li>The <code>ValidationDialog</code> now remembers its last placement. This
    177. 

  177.     mean that once you move it out-of-the-way, it stays out-of-the-way.</li>
    178. 

  178. </ul>
    179. 

  179. 

  180. <h3>Release 001 (Apr 16, 2001)</h3>
    181. 

  181.   <ul>
    182. 

  182.     <li>First release.</li>
    183. 

  183.   </ul>
    184. 

  184. 

  185. 

  186. </body>
    187. 

  187. </html>
    188.