Return to README CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / php / ext / pspell

Annotation of embedaddon/php/ext/pspell/README, revision 1.1

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