Use <plugin>_info() function if at all possible instead of <plugin>_version()

[squirrelmail.git] / plugins / squirrelspell / sqspell_config.php

diff --git a/plugins/squirrelspell/sqspell_config.php b/plugins/squirrelspell/sqspell_config.php
index 489703460994678e4e35e848d4960c4421d52d82..c5a6c1e92656f7d4da670a7ff4837a980184fd5f 100644 (file)
--- a/plugins/squirrelspell/sqspell_config.php
+++ b/plugins/squirrelspell/sqspell_config.php
@@ -1,21 +1,15 @@
 <?php
+
 /**
  * sqspell_config.php -- SquirrelSpell Configuration file.
  *
- * Copyright (c) 1999-2005 The SquirrelMail Project Team
- * Licensed under the GNU GPL. For full terms see the file COPYING.
- *
+ * @copyright &copy; 1999-2007 The SquirrelMail Project Team
+ * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package plugins
  * @subpackage squirrelspell
  */
 
-/** @ignore */
-if (! defined('SM_PATH')) define('SM_PATH','../../');
-
-/** getHashedFile() function for SQSPELL_WORDS_FILE and sqgetGlobalVar() from global.php */
-include_once(SM_PATH . 'functions/prefs.php');
-
 /** vars needed for getHashedFile() */
 global $data_dir;
 sqgetGlobalVar('username', $username, SQ_SESSION);
@@ -32,9 +26,9 @@ sqgetGlobalVar('username', $username, SQ_SESSION);
  *   $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. Aspell might provide
- * better spellchecking for Western languages.
+ *
+ * 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:
@@ -53,7 +47,7 @@ sqgetGlobalVar('username', $username, SQ_SESSION);
  * <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 
+ * <li>Interface might translate array key, if used key is present in
  *   SquirrelMail translations.</li>
  * </ul>
  * <pre>
@@ -67,6 +61,29 @@ sqgetGlobalVar('username', $username, SQ_SESSION);
 $SQSPELL_APP = array('English' => 'ispell -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
@@ -78,7 +95,7 @@ $SQSPELL_APP_DEFAULT = 'English';
  *
  * $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.
@@ -89,10 +106,8 @@ $SQSPELL_WORDS_FILE =
    getHashedFile($username, $data_dir, "$username.words");
 
 /**
- * Function used cheching words in user's dictionary
+ * Function used for checking words in user's dictionary
  * @global string $SQSPELL_EREG
  * @deprecated It is not used since 1.5.1 (sqspell 0.5)
  */
 $SQSPELL_EREG = 'ereg';
-
-?>
\ No newline at end of file