Guarantee we have an array
[squirrelmail.git] / config / config_default.php
index b5c2e4191e8eacaabdad24de1855daad0efb23db..549a97afb71bef4c2b7c594972572889e65b509e 100644 (file)
@@ -15,7 +15,7 @@
  * passwords being leaked to e.g. other system users. Take extra care when
  * the webserver is shared with untrusted users.
  *
- * @copyright © 2000-2006 The SquirrelMail Project Team
+ * @copyright © 2000-2007 The SquirrelMail Project Team
  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  * @version $Id$
  * @package squirrelmail
@@ -23,9 +23,8 @@
  */
 
 /* Do not change this value. */
-global $version;
 global $config_version;
-$config_version = '1.4.0';
+$config_version = '1.5.0';
 
 /*** Organization preferences ***/
 /**
@@ -86,21 +85,23 @@ $frame_top = '_top';
 /**
  * Provider name
  *
- * Here you can set name of the link displayed on the right side of main page.
+ * Here you can set the text of the link displayed on the top-right
+ * of the message list.
+ *
+ * Defaults to empty (no link).
  *
- * Link will be displayed only if you have $hide_sm_attributions
- * option set to true.
  * @global string $provider_name
  */
-$provider_name = 'SquirrelMail';
+$provider_name = '';
 
 /**
  * Provider URI
  *
- * Here you can set URL of the link displayed on the right side of main page.
- * When empty, this refers to the SquirrelMail About page.
- * Link will be displayed only if you have $hide_sm_attributions
- * option set to true.
+ * Here you can set URL of the link displayed on the top-right of
+ * the message list.
+ *
+ * Defaults to empty (no link).
+ *
  * @global string $provider_uri
  */
 $provider_uri = '';
@@ -562,7 +563,7 @@ $default_use_priority = true;
  * SquirrelMail Attributions Control
  *
  * This option disables display of "created by SquirrelMail developers"
- * strings and provider link
+ * strings and links.
  * @global bool $hide_sm_attributions
  * @since 1.2.0
  */
@@ -664,31 +665,81 @@ $session_name = 'SQMSESSID';
 
 /**
  * User Themes
- *   You can define your own theme and put it in this directory.
+ *   You can define your own theme and put it in directory in SM_PATH/css/.
  *   You must call it as the example below. You can name the theme
- *   whatever you want. For an example of a theme, see the ones
- *   included in the config directory.
+ *   whatever you want.
  *
  * To add a new theme to the options that users can choose from, just
  * add a new number to the array at the bottom, and follow the pattern.
  *
  * $user_theme_default sets theme that will be used by default
- * used by default.
+ *
  * @global integer $user_theme_default
+ * @since 1.5.2
  */
 $user_theme_default = 0;
 
 /**
  * Listing of installed themes
  * @global array $user_themes
+ * @since 1.5.2
  */
 $user_themes[0]['PATH'] = 'none';
 $user_themes[0]['NAME'] = 'Default';
 
+$user_themes[1]['PATH'] = '../css/blue_gradient/';
+$user_themes[1]['NAME'] = 'Blue Options';
+
+/**
+ * Message Icons control
+ *
+ * Use icons for message and folder markers
+ * @global bool $use_icons
+ * @since 1.5.1
+ */
+$use_icons = true;
+
+/**
+ * Icon Themes
+ *    You can create your own icon themes and put them in a directory in
+ *    SM_PATH/images/themes/.  Your users will be able to choose whatever
+ *    icon themes are listed below.
+ * 
+ *    To add a new theme to the list of available icon themes, just add a new
+ *    number to the array below and follow the pattern
+ * 
+ *    $icon_theme_default sets the theme that will be used by default.
+ *    $icon_theme_fallback specifies which theme will be used if an icon is 
+ *    not found in the selected theme
+ * 
+ * @global integer $icon_theme_def
+ * @global integer $icon_theme_fallback
+ * @since 1.5.2
+ */
+$icon_theme_def = 1;
+$icon_theme_fallback = 3;
+
+/**
+ * Listing of installed icon themes
+ * @global array $icon_themes
+ * @since 1.5.2
+ */
+$icon_themes[0]['PATH'] = 'none';
+$icon_themes[0]['NAME'] = 'No Icons';
+
+$icon_themes[1]['PATH'] = 'template';
+$icon_themes[1]['NAME'] = 'Template Default Icons';
+
+$icon_themes[2]['PATH'] = '../images/themes/default/';
+$icon_themes[2]['NAME'] = 'Default Icon Set';
+
+$icon_themes[3]['PATH'] = '../images/themes/xp/';
+$icon_themes[3]['NAME'] = 'XP Style Icons';
+
 /**
  * Templates
- *   You can define your own template and put it in a new directory
- *   under SM_PATH/templates.  The ID must match the name of
+ *   You can define your own template set (skin) and put it in a new 
+ *   directory under SM_PATH/templates.  The ID must match the name of
  *   the template directory as the example below. You can name the 
  *   template whatever you want. For an example of a template, see 
  *   the ones included in the SM_PATH/templates directory.
@@ -696,12 +747,22 @@ $user_themes[0]['NAME'] = 'Default';
  * To add a new template to the options that users can choose from, just
  * add a new number to the array at the bottom, and follow the pattern.
  *
- * $templateset_default sets theme that will be used by default.
+ * $templateset_default sets the skin that will be used by default
+ *                      when a user doesn't have a skin selection
+ *                      in their preferences. (Must be the "ID" of
+ *                      the desired template set)
+ *
+ * $templateset_fallback tells SquirrelMail which template set (skin)
+ *                       to use when looking for a file that is not
+ *                       contained within whatever skin is currently
+ *                       being used.  (Must be the "ID" of the desired 
+ *                       template set)
  *
- * @global integer $templateset_default
+ * @global string $templateset_default
+ * @global string $templateset_fallback
  */
-$templateset_default = 0;
-$templateset_fallback = 0;
+$templateset_default = 'default';
+$templateset_fallback = 'default';
 
 $aTemplateSet[0]['ID'] = 'default';
 $aTemplateSet[0]['NAME'] = 'Default';
@@ -815,23 +876,35 @@ $motd = "";
 /**
  * To install plugins, just add elements to this array that have
  * the plugin directory name relative to the /plugins/ directory.
- * For instance, for the 'sqclock' plugin, you'd put a line like
+ * For instance, for the 'squirrelspell' plugin, you'd put a line like
  * the following.
- *    $plugins[] = 'sqclock';
- *    $plugins[] = 'attachment_common';
+ *    $plugins[] = 'squirrelspell';
+ *    $plugins[] = 'listcommands';
  */
 // Add list of enabled plugins here
 
 
+/**
+ * To disable all plugins regardless of any that are installed 
+ * above, turn on $disable_plugins.  To disable them ONLY for 
+ * one user, put that username into $disable_plugins_user.
+ * @global boolean $disable_plugins
+ * @global string $disable_plugins_user
+ * @since 1.5.2
+ */
+$disable_plugins = false;
+$disable_plugins_user = '';
+
+
 /*** Database ***/
 /**
- * Read doc/database.txt in order to get more information
+ * Read the administrator's manual in order to get more information
  * about these settings.
  */
 /**
  * Database-driven private addressbooks
  *   DSN (Data Source Name) for a database where the private
- *   addressbooks are stored.  See doc/db-backend.txt for more info.
+ *   addressbooks are stored.  See the administrator's manual for more info.
  *   If it is not set, the addressbooks are stored in files
  *   in the data dir.
  *   The DSN is in the format: mysql://user:pass@hostname/dbname
@@ -1021,15 +1094,6 @@ $config_location_base = '';
  */
 $use_iframe = false;
 
-/**
- * Message Icons control
- *
- * Use icons for message and folder markers
- * @global bool $use_icons
- * @since 1.5.1
- */
-$use_icons = false;
-
 /**
  * PHP recode functions control
  *
@@ -1086,3 +1150,15 @@ $no_list_for_subscribe = false;
  * @global integer $config_use_color
  */
 $config_use_color = 2;
+
+/**
+ * Ask User for Personal Information on login
+ *
+ * When a user logs in that doesn't have an email address configured,
+ * redirect him/her to the options page with a request to fill in their
+ * personal information.
+ *
+ * @global bool $ask_user_info
+ */
+$ask_user_info = true;
+