start of squirrelspell internationalization
[squirrelmail.git] / plugins / squirrelspell / INSTALL
1 SquirrelSpell-v0.3.1
2 ---------------------
3
4 Untar SquirrelSpell into your squirrelmail/plugins directory. Move
5 sqspell_config.dist to sqspell_config.php if this is a fresh install. If
6 upgrading, just untar over your old installation.
7
8 Modify the sqspell_config.php file making sure you have ispell or aspell
9 available on your system and located in PHP's path. The squirrelspell
10 doesn't check for that and if it is not available, you're just going to
11 get a "No errors found"  message every time. :) Quite pleasing, but not
12 very useful.
13
14 Read files in "doc" directory -- they explain some features.
15
16 Enable the plugin either by hand or by running the configure script from
17 your squirrelmail install directory.
18
19 Enjoy and report bugs. ;)
20
21 This is a commented sqspell_config.php
22
23 <?php
24
25    /**
26     **  sqspell_config.php -- SquirrelSpell Configuration file.
27     **
28     **  Copyright (c) 1999-2000 The SquirrelMail development team
29     **  Licensed under the GNU GPL. For full terms see the file COPYING.
30     **
31     **
32     **
33     **  $Id$
34     **/
35
36     /* Just for poor wretched souls with E_ALL. :) */
37     global $username, $data_dir;
38
39     /**
40        SPELL-CHECKING APPLICATIONS:
41        ----------------------------
42        This feature was added/changed in 0.3. Use this array to set up
43        which dictionaries are available to users. If you only have
44        English spellchecker on your system, then let this line be:
45
46        $SQSPELL_APP = array("English" => "ispell -a");
47
48        or
49
50        $SQSPELL_APP = array("English" => "/usr/local/bin/aspell -a");
51
52        Sometimes you have to specify full path for PHP to find it.
53        Aspell is a better spell-checker than Ispell, so you're encouraged
54        to use it.
55
56        If you want to have more than one dictionary available to users,
57        configure the array to look something like this:
58
59        $SQSPELL_APP = array(
60                         "English" => "aspell -a",
61                             "Russian" => "ispell -d russian -a",
62                         ...
63                         "Swahili" => "ispell -d swahili -a"
64                        );
65
66        Watch the commas, making sure there isn't one after your last
67        dictionary declaration. Also, make sure all these dictionaries
68        are available on your system before you specify them here.
69
70        Whatever your setting is, don't omit the "-a" flag.
71
72     **/
73     $SQSPELL_APP = array('English' => 'ispell -a');
74
75     /**
76        DEFAULT DICTIONARY
77        -------------------
78        Even if you're only running one dictionary, still specify which one
79        is the default. Watch the case -- it has to be exactly as in array
80        you declared in $SQSPELL_APP.
81     **/
82     $SQSPELL_APP_DEFAULT='English';
83
84     /**
85        USER DICTIONARY:
86        -----------------
87        $SQSPELL_WORDS_FILE is a location and mask of a user dictionary file.
88        The default setting should be OK for most everyone. Read PRIVACY and
89        CRYPTO in the "doc" directory.
90     **/
91     $SQSPELL_WORDS_FILE = "$data_dir/$username.words";
92
93     /**
94        CASE SENSITIVITY:
95        ------------------
96        Use $SQSPELL_EREG="ereg" for case-sensitive matching of user
97        dictionary, or $SQSPELL_EREG="eregi" for case-insensitive
98        matching. It is advised to use case-sensitive matching.
99     **/
100     $SQSPELL_EREG="ereg";
101
102     /**
103        SOUP NAZI (AVOIDING BAD BROWSERS)
104        -------------------------------------
105        Since some browsers choke on JavaScript, here is an option to disable the
106        browsers with known problems. All you do is add some part of an USER_AGENT
107        string of an offending browser which you want to disable and users will not
108        know about this plugin. E.g. browsers with "Mozilla/4.61 (Macintosh, I, PPC)"
109        USER_AGENT string will get weeded out if you provide "Macintosh" in the
110        config string.
111
112        Mozilla/2 -- You're kidding, right?
113        Mozilla/3 -- known not to work
114        Opera -- known not to work
115        Macintosh -- Netscape 4.x on Macintosh chokes for some reason.
116                     Adding until resolved.
117     **/
118     $SQSPELL_SOUP_NAZI = 'Mozilla/3, Mozilla/2, Opera 4, Opera/4, Macintosh';
119 ?>