- refactoring

- add or modified parameters comments


git-svn-id: http://piwigo.org/svn/trunk@567 68402e56-0260-453c-a942-63ccdbb3a9ee

1 files changed, 71 insertions, 32 deletions

diff --git a/include/config.inc.php b/include/config.inc.php
index 07ec9e8a6..2134e21a5 100644
--- a/include/config.inc.php
+++ b/include/config.inc.php
@@ -25,42 +25,72 @@
 // | USA.                                                                  |
 // +-----------------------------------------------------------------------+
 
-// How to change the order of display for images in a category ?
+/**
+ *                           configuration page
+ *
+ * Set configuration parameters that are not in the table config. In the
+ * application, configuration parameters are considered in the same way
+ * coming from config table or config.inc.php.
+ *
+ * Why having some parameters in config table and others in config.inc.php ?
+ * Modifying config.inc.php is a "hard" task for low skilled users, they
+ * need a GUI for this : admin/configuration. But only parameters that might
+ * be modified by low skilled users are in config table, other parameters
+ * are in config.inc.php
+ */
+
+// order_by : how to change the order of display for images in a category ?
 //
-// You have to modify $conf['order_by'].
 // There are several fields that can order the display :
+//
 //  - date_available : the date of the adding to the gallery
 //  - file : the name of the file
-// Once you've chosen which field(s) to use for ordering,
-// you must chose the ascending or descending order for each field.
-// examples :
+//  - id : element identifier
+//  - date_creation : date of element creation
+//
+// Once you've chosen which field(s) to use for ordering, you must chose the
+// ascending or descending order for each field.  examples :
+//
 // 1. $conf['order_by'] = " order by date_available desc, file asc";
 //    will order pictures by date_available descending & by filename ascending
+//
 // 2. $conf['order_by'] = " order by file asc";
-//    will only order pictures by file ascending
-//    without taking into account the date_available
+//    will only order pictures by file ascending without taking into account
+//    the date_available
 $conf['order_by'] = ' ORDER BY date_available DESC, file ASC, id ASC';
 
-$conf['nb_image_row']       = array(4,5,6,7,8);
-$conf['nb_row_page']        = array(2,3,4,5,6,7,10,20,1000);
-$conf['slideshow_period']   = 4;
-$conf['last_days']          = array(1,2,3,10,30,365);
-
-// $conf['file_ext'] lists all extensions (case insensitive) allowed for
-// your PhpWebGallery installation
-$conf['file_ext']           = array('jpg','JPG','png','PNG','gif','GIF'
-                                    ,'mpg','zip','avi','mp3','ogg');
-// $conf['picture_ext'] must bea subset of $conf['file_ext']
-$conf['picture_ext']        = array('jpg','JPG','png','PNG','gif','GIF');
-$conf['top_number']         = 10; // used for "best rated" and "most visited"
-$conf['anti-flood_time']    = 60; // seconds between 2 comments : 0 to disable
+// slideshow_period : waiting time in seconds before loading a new page
+// during automated slideshow
+$conf['slideshow_period'] = 4;
+
+// last_days : options for X last days to displays for comments
+$conf['last_days'] = array(1,2,3,10,30,365);
+
+// file_ext : file extensions (case insensitive) authorized
+$conf['file_ext'] = array('jpg','JPG','png','PNG','gif','GIF','mpg','zip',
+                          'avi','mp3','ogg');
+
+// picture_ext : file extensions for picture file, must be a subset of
+// file_ext
+$conf['picture_ext'] = array('jpg','JPG','png','PNG','gif','GIF');
+
+// top_number : number of element to display for "best rated" and "most
+// visited" categories
+$conf['top_number'] = 10;
+
+// anti-flood_time : number of seconds between 2 comments : 0 to disable
+$conf['anti-flood_time'] = 60;
+
+// max_LOV_categories : maximum number of categories to display in a list of
+// value. Over this limit, a textfield is displayed, asking for a category
+// identifier
 $conf['max_LOV_categories'] = 50;
 
-// $conf['show_iptc_mapping'] is used for showing IPTC metadata on
-// picture.php page. For each key of the array, you need to have the same
-// key in the $lang array. For example, if my first key is 'iptc_keywords'
-// (associated to '2#025') then you need to have $lang['iptc_keywords'] set
-// in language/$user['language']/common.lang.php. If you don't have the lang
+// show_iptc_mapping : is used for showing IPTC metadata on picture.php
+// page. For each key of the array, you need to have the same key in the
+// $lang array. For example, if my first key is 'iptc_keywords' (associated
+// to '2#025') then you need to have $lang['iptc_keywords'] set in
+// language/$user['language']/common.lang.php. If you don't have the lang
 // var set, the key will be simply displayed
 //
 // To know how to associated iptc_field with their meaning, use
@@ -72,35 +102,44 @@ $conf['show_iptc_mapping'] = array(
   'iptc_caption'         => '2#120'
   );
 
-// in EXIF fields, you can choose to display fields in sub-arrays, for
-// example ['COMPUTED']['ApertureFNumber']. for this, add
+// show_exif_fields : in EXIF fields, you can choose to display fields in
+// sub-arrays, for example ['COMPUTED']['ApertureFNumber']. for this, add
 // 'COMPUTED;ApertureFNumber' in $conf['show_exif_fields']
 //
 // The key displayed in picture.php will be $lang['exif_field_Make'] for
 // example and if it exists. For compound fields, only take into account the
 // last part : for key 'COMPUTED;ApertureFNumber', you need
 // $lang['exif_field_ApertureFNumber']
+//
+// for PHP version newer than 4.1.2 :
+// $conf['show_exif_fields'] = array('CameraMake','CameraModel','DateTime');
+// 
 $conf['show_exif_fields'] = array('Make',
                                   'Model',
                                   'DateTime',
                                   'COMPUTED;ApertureFNumber');
-// for PHP version newer than 4.1.2 :
-// $conf['show_exif_fields'] = array('CameraMake','CameraModel','DateTime');
 
+// calendar_datefield : date field of table "images" used for calendar
+// catgory
 $conf['calendar_datefield'] = 'date_available';
+
+// rate : enable feature for rating elements
 $conf['rate'] = true;
 
-// time of validity for "remember me" cookies, in seconds.
+// remember_me_length : time of validity for "remember me" cookies, in
+// seconds.
 $conf['remember_me_length'] = 31536000;
 
-// time of validity for normal session, in seconds.
+// session_length : time of validity for normal session, in seconds.
 $conf['session_length'] = 3600;
 
-// session id size. A session identifier is compound of alphanumeric
+// session_id_size : a session identifier is compound of alphanumeric
 // characters and is case sensitive. Each character is among 62
 // possibilities. The number of possible sessions is
 // 62^$conf['session_id_size'].
+//
 // 62^5  =             916,132,832
 // 62^10 = 839,299,365,868,340,224
+//
 $conf['session_id_size'] = 10;
 ?>