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