jbSpell readme.txt - version 0.20, 3/6/2001 ------------------------------------------------------------------------------ DESCRIPTION: OpenTool for integrating spell checkers with JBuilder. It consists of the main module that works with JBuilder and of plugins for specific spell checkers. Currently it works with ispell (50 000 000 Emacs fans can't be wrong) and with "jspell" - a pure Java spell checker provided by Valentino Kyriakides. WARRANTY AND TERMS OF USE: This software is freeware. You can use both binary code and sources (non-commercially) in any way you like. This software is provided "as is" with no warranty of any kind. I take no responsibility for any damages that may result from using it. In such cases, blame yourself. FILES: The software is packed inside jbSpell.zip file. The following files should be inside the archive: -JAR file with main spell checker classes (jbSpell.jar) -JAR file with classes specific for ispell (jbSpell_ispell.jar) -JAR file with jspell (jbSpell_jspell.jar) -dictionary for jspell (words.txt) -ZIP file with source code (jbSpell.src.zip) -readme.txt (this file) INSTALLATION: -Unpack jbSpell.jar from jbSpell.zip archive and put it in \lib\ext directory. -If you want to use ispell as your dictionary: -Make sure that you have ispell installed and it works OK (on Linux you probably already have it installed - if not it is for sure on your Linux CD). On Windows you should get one of the Win32 ispell ports. -Unpack jbSpell_ispell.jar from jbSpell.zip and place it in \lib\ext directory. -If you prefer pure Java solution (jspell): -Unpack jbSpell_jspell.jar and words.txt from jbSpell.zip and place it in \lib\ext directory. -Start JBuilder. There should be new button on the toolbar. In editor options window ("Colors" tab) you can set colors for highlighting wrong and correctly spelled words. Also there is a new "Spell Checker" tab with settings specific for the spell checker. In keymap customization window you should have 2 new actions: -the first allows to check word under cursor -second: selected text or entire file. -Go to "Editor Options" window ("Spell Checker" tab) and select the dictionary plugin you want to use. Click "Configure..." to adjust settings for the plugin. -If you use ispell: In the ispell specific dialog you may need to select the path to the actual ispell executable and to the dictionary to use (Win32 ispell port I'm using is not able to find the main dictionary by itself - I have to set alternate dictionary). More on configuring ispell on Windows can be found later in this file. -If you use jspell you don't have to perform any additional steps. HISTORY OF CHANGES: 0.20 - Bugfix: the problem with ispell settings window popping up when ispell was not configured properly fixed. - Added new module (jbSpell_jspell) with pure Java dictionary (provided by Valentino Kyriakides). Still needs some work. 0.10 - initial version with ispell support. MISSING FEATURES & BUGS: MAIN MODULE: -Spell checker button on the toolbar should be enabled only in "Source" view or switch automatically to this view. -Words like "doesn't", "it's" etc. are treated as two separate words. ISPELL SPECIFIC: -For some words you can get quite strange suggestion (eg. "initial+ly" for "initially"). JSPELL SPECIFIC: -Works quite slow -Crashes when checking for some words (eg. "Czerwony") -No support for adding new words. CONFIGURING ISPELL (Jason Rumney Win32 port) ON WINDOWS: By default this ispell version will not maintain properly your personal dictionary. As a result words you add to dictionary will not be saved. You can modify ispell sources (tree.c) or configure it as follows: -Make sure HOME environment variable is present (it doesn't have to point to anything in particular). -In ispell configuration dialog ("Tools" -> "Editor Options" -> "Spell Checker" -> "Configure") check both checkboxes for alternate directories and set both file paths. Alternate directory should point to main dictionary (default distributed dictionary is english.hash); personal dictionary may point initially to empty text file (this file must exist!). CONTACT: If you have any questions or you encounter problems using this tool, contact me at: mailto:czerwony.kapturek@wp.pl I can't promise to answer all messages, but I'll do my best. For the newest version of the software, check: http://CzerwonyKapturek.tripod.com CREDITS: jspell pure Java spell checker is provided by Valentino Kyriakides.