Began rework of options page. Also added 3 plugins (filters, translate, and squirrels...
[squirrelmail.git] / plugins / squirrelspell / sqspell_config.dist
1 <?php
2 /** SquirrelSpell Configuration file. **/
3
4 // Just for poor wretched souls with E_ALL. :)
5 global $username, $data_dir;
6
7 /** 
8    SPELL-CHECKING APPLICATIONS:
9    ----------------------------
10    This feature was added/changed in 0.3. Use this array to set up
11    which dictionaries are available to users. If you only have 
12    English spellchecker on your system, then let this line be:
13
14    $SQSPELL_APP = array("English" => "ispell -a");
15
16    or
17
18    $SQSPELL_APP = array("English" => "/usr/local/bin/aspell -a");
19
20    Sometimes you have to specify full path for PHP to find it.
21    Aspell is a better spell-checker than Ispell, so you're encouraged
22    to use it.
23
24    If you want to have more than one dictionary available to users,
25    configure the array to look something like this:
26
27    $SQSPELL_APP = array(
28                         "English" => "aspell -a",
29                         "Russian" => "ispell -d russian -a",
30                         ...
31                         "Swahili" => "ispell -d swahili -a"
32                        );
33    
34    Watch the commas, making sure there isn't one after your last
35    dictionary declaration. Also, make sure all these dictionaries
36    are available on your system before you specify them here.
37    
38    Whatever your setting is, don't omit the "-a" flag.
39
40                                                                 **/
41 $SQSPELL_APP = array("English" => "ispell -a");
42
43 /**
44    DEFAULT DICTIONARY
45    -------------------
46    Even if you're only running one dictionary, still specify which one 
47    is the default. Watch the case -- it has to be exactly as in array
48    you declared in $SQSPELL_APP.        
49                                                                 **/
50 $SQSPELL_APP_DEFAULT="English";
51
52 /**
53    USER DICTIONARY:
54    -----------------
55    $SQSPELL_WORDS_FILE is a location and mask of a user dictionary file. 
56    The default setting should be OK for most everyone. Read PRIVACY and
57    CRYPTO in the "doc" directory.
58                                                                 **/
59 $SQSPELL_WORDS_FILE = "$data_dir/$username.words";
60
61 /**
62    CASE SENSITIVITY:
63    ------------------
64    Use $SQSPELL_EREG="ereg" for case-sensitive matching of user 
65    dictionary, or $SQSPELL_EREG="eregi" for case-insensitive 
66    matching. It is advised to use case-sensitive matching.
67                                                                 **/
68 $SQSPELL_EREG="ereg";
69
70 /**
71    SOUP NAZI (AVOIDING BAD BROWSERS)
72    -------------------------------------
73    Since some browsers choke on JavaScript, here is an option to disable the
74    browsers with known problems. All you do is add some part of an USER_AGENT 
75    string of an offending browser which you want to disable and users will not
76    know about this plugin. E.g. browsers with "Mozilla/4.61 (Macintosh, I, PPC)"
77    USER_AGENT string will get weeded out if you provide "Macintosh" in the 
78    config string.
79   
80    Mozilla/2 -- You're kidding, right?
81    Mozilla/3 -- known not to work
82    Opera -- known not to work
83    Macintosh -- Netscape 4.x on Macintosh chokes for some reason. 
84                 Adding until resolved.
85                                                                 **/
86 $SQSPELL_SOUP_NAZI = "Mozilla/3, Mozilla/2, Opera 4, Opera/4, Macintosh";
87
88 ?>