X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=plugins%2Fsquirrelspell%2Fsqspell_config.php;h=9c7d964d3bd30696c7852e41613f75dc921f6789;hb=9c0ecb48c6667f0edc259437e5d75e1f000a4a86;hp=e4ec0f8843d9cb9666d82046621e23dbc42f968b;hpb=ea5f4b8eaf805c4cc4e9533e87d057300a7fe666;p=squirrelmail.git

diff --git a/plugins/squirrelspell/sqspell_config.php b/plugins/squirrelspell/sqspell_config.php
index e4ec0f88..9c7d964d 100644
--- a/plugins/squirrelspell/sqspell_config.php
+++ b/plugins/squirrelspell/sqspell_config.php
@@ -1,37 +1,107 @@
 <?php
+
 /**
  * sqspell_config.php -- SquirrelSpell Configuration file.
  *
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
- *
- *
- * $Id$
+ * @copyright 1999-2009 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
+ * @version $Id$
  * @package plugins
  * @subpackage squirrelspell
  */
 
-/** */
-require_once(SM_PATH . 'functions/prefs.php');
-
-/* Just for poor wretched souls with E_ALL. :) */
+/** vars needed for getHashedFile() */
 global $data_dir;
-
 sqgetGlobalVar('username', $username, SQ_SESSION);
 
 /**
+ * List of configured dictionaries
+ *
+ * This feature was added/changed in 0.3. Use this array to set up
+ * which dictionaries are available to users. If you only have
+ * English spellchecker on your system, then let this line be:
+ *<pre>
+ *   $SQSPELL_APP = array('English' => 'ispell -a');
+ *     or
+ *   $SQSPELL_APP = array('English' => '/usr/local/bin/aspell -a');
+ *</pre>
+ * Sometimes you have to specify full path for PHP to find it.
+ *
+ * You can use Aspell or Ispell spellcheckers, the command line is the
+ * same. Aspell might provide better spellchecking for Western languages.
+ *
+ * If you want to have more than one dictionary available to users,
+ * configure the array to look something like this:
+ *<pre>
+ *   $SQSPELL_APP = array('English' => 'aspell -a',
+ *                        'Russian' => 'ispell -d russian -a',
+ *                        ...
+ *                        'Swahili' => 'ispell -d swahili -a'
+ *                        );
+ *</pre>
+ * WARNINGS:
+ * <ul>
+ * <li>Watch the commas, making sure there isn't one after your last
+ *     dictionary declaration. Also, make sure all these dictionaries
+ *     are available on your system before you specify them here.</li>
+ * <li>Whatever your setting is, don't omit the "-a" flag.</li>
+ * <li>Remember to keep same array keys during upgrades. Don't rename them.
+ *   Users' dictionary settings use it.</li>
+ * <li>Interface might translate array key, if used key is present in
+ *   SquirrelMail translations.</li>
+ * </ul>
+ * <pre>
  * Example:
+ * $SQSPELL_APP = array('English' => 'ispell -a',
+ *                      'Spanish' => 'ispell -d spanish -a' );
+ * </pre>
  *
- * $SQSPELL_APP = array( 'English' => 'ispell -a',
- *                     'Spanish' => 'ispell -d spanish -a' );
+ * @global array $SQSPELL_APP
  */
 $SQSPELL_APP = array('English' => 'ispell -a',
-			'Spanish' => 'ispell -d spanish -a');
+                     'Spanish' => 'ispell -d spanish -a');
+
+/**
+ * Sample configuration for PHP pspell extension. Sets dictionary options.
+ * Each language definition can contain up to 3 comma delimited options.
+ * First option sets language, second sets spelling, third one sets jargon.
+ * See http://www.php.net/pspell-new
+ * 
+ * Pspell extension is supported since 0.6 (sm 1.5.2)
+ */
+//$SQSPELL_APP = array('English' => 'en',
+//                     'Spanish' => 'es');
+
+/**
+ * 0 - default, command line ispell or aspell utilities configured with SQSPELL_APP
+ * 1 - use php pspell extension. WARNING requires different SQSPELL_APP options.
+ */
+$SQSPELL_SPELLCHECKER = 0;
+
+/**
+ * Can be used to turn of detection of proc_open support in command line spellcheck
+ * module. Option is not used if $SQSPELL_SPELLCHECKER is set to 1.
+ */
+$SQSPELL_FORCE_POPEN = false;
+
+/**
+ * Default dictionary
+ * @global string $SQSPELL_APP_DEFAULT
+ */
 $SQSPELL_APP_DEFAULT = 'English';
-$SQSPELL_WORDS_FILE = 
-   getHashedFile($username, $data_dir, "$username.words");
 
-$SQSPELL_EREG = 'ereg';
+/**
+ * File that stores user's dictionary
+ *
+ * $SQSPELL_WORDS_FILE is a location and mask of a user dictionary file.
+ * The default setting should be OK for most everyone.
+ *
+ * This setting is used only when SquirrelSpell is upgraded from
+ * older setup. Since SquirrelMail 1.5.1 SquirrelSpell stores all settings in
+ * same place that stores other SquirrelMail user preferences.
+ * @global string $SQSPELL_WORDS_FILE
+ * @deprecated setting is still needed in order to handle upgrades
+ */
+$SQSPELL_WORDS_FILE =
+   getHashedFile($username, $data_dir, "$username.words");
 
-?>