Happy 2014
[squirrelmail.git] / plugins / squirrelspell / doc / README
1 SquirrelSpell
2 --------------
3
4 SquirrelSpell is a JavaScript-powered spellchecker written to work with
5 SquirrelMail webmail interface.
6
7 LICENSE: 
8 --------- 
9 This is free software released under GNU GPL license and comes with no
10 warranty of any kind. You may modify, borrow, or redistribute code as long
11 as it doesn't violate the GNU GPL license. You can read more about this
12 license at http://www.gnu.org/
13
14 FEATURES:
15 ----------
16 SquirrelSpell works with UN*X's ISPELL or ASPELL libraries and
17 SquirrelMail version 1.4 and higher. No PHP recompilation required,
18 unless you wish to enable MCRYPT support.
19
20 * SpellChecker:
21 ISPELL or ASPELL. It all depends on them. Read configuration parameters in
22 sqspell_config.php. Starting with version v0.3 supports multiple international
23 dictionaries.
24
25 * User Dictionary:
26 SquirrelSpell adds words to the user dictionary. You may edit your
27 dictionary under options->personal options->Edit my dictionary.
28
29 * Encryption:
30 Starting with version v0.3 SquirrelSpell is capable of working with
31 encrypted user dictionaries. See doc/CRYPTO for information on how to
32 enable this feature.
33
34 * i18n and l10n:
35 SquirrelSpell supports any international dictionaries provided by ispell
36 or aspell. However, since there isn't a translation interface available
37 for SquirrelMail plugins, all messages produced by SquirrelSpell will be
38 in English.
39
40 AUTHOR:
41 --------
42 This plugin was originally authored by Konstantin Riabitsev
43 (http://www.mricon.com/) and is now maintained by the SquirrelMail Project
44 Team.
45
46 SUPPORT:
47 ---------
48 Send support questions and bug reports to the plugins mailing list:
49 squirrelmail-plugins@lists.sourceforge.net. When reporting a bug
50 don't forget to mention your browser version, SquirrelMail and
51 SquirrelSpell versions, as well as any other useful info.
52
53 ENJOY. :)
54 ---------