README 2.3 KB

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