README
1README file for pspell (spellchecker) module for PHP
2----------------------------------------------------
3
4The latest release of pspell is always available from
5
6 http://aspell.net/
7
8This module was developed and tested with aspell-.31.1 and pspell-.11.0.2,
9although slightly earlier (and hopefully later) versions of those libraries
10should work as well.
11
12General notes
13-------------
14
15Please, note that somewhere around version .27.x (I believe) aspell stopped
16working with the aspell module for php. This is due to the fact that the
17author changed things around a bit, and suggested that people link to pspell
18in the future rather than to aspell. That's exactly what this module is for.
19It has the same basic functionality as aspell (and more features are being
20added). I did not want to modify existing aspell module, because it would
21break things for those who are using older aspell, or result in very ugly code.
22Rather, I wrote a new module - pspell.
23
24
25Building pspell on a Unix system
26--------------------------------
27
28In order to use pspell, you need to have *both* aspell and pspell libraries
29installed, and they have to be compatible with each other. Get the latest
30release of both at the URL given above.
31
32I expect the libraries to be in /usr/local (that's the default when you
33cofigure pspell and aspell with their 'configure' scripts woth no parameters).
34If that location is different, please specify it in --with-pspell=PATH, where
35PATH is the path you specified for pspell libraries.
36
37Notes on personalized dictionaries
38----------------------------------
39
40It is now possible to have personalized dictionaries with pspell. This is
41achieved by opening a dictionary with pspell_new_personal() rather than
42pspell_new() and specifying the custom dictionary as the first parameter.
43The parameter probably should begin with '/' because otherwise it will
44be relative to $HOME, which is probably set to "/root". This is probably not
45what you want because you need write access for nobody to be able to write
46to a dictionary. Once the dictionary is open, you can use
47pspell_add_to_personal() to add words to the wordlist and finally
48pspell_save_wordlist() to save it.
49
50Note that at this moment pspell_save_wordlist() will return TRUE, even if
51there was an error. This will be changed once pspell library is fixed.
52
