Changeset 4437 for extensions/event_cats/include

Timestamp:

Dec 7, 2009, 4:01:10 AM (14 years ago)

Author:

LucMorizur

Message:

[Event Cats] Implement help banner

File:

• extensions/event_cats/include/ec_conf.inc.php (modified) (3 diffs)

extensions/event_cats/include/ec_conf.inc.php

@@ -50 +50 @@
 // the DB at the same time.
 
+//----------------------------------------------------------------------------
+// The following lines allow to change the number of configuration items, the
+// default values they can have, and also their possible other values, very
+// quickly.
+
+// Gives configuration items names and default values. Only strings.
 $ec_conf_default = array( // PLUGIN CONFIGURATION ($ec_conf) :
                           // ---------------------------------
@@ -84 +90 @@
   'comment_display'       // the way the comment is displayed in "entries"
     => '0',               // tab : 0, as tooltip ; 1, on a line under code
+                          // 
+  'in_help_display'       // whether the help banner is displayed.
+    => '1',               // 0: not displayed ; 1 : displayed (surprising !)
 );
 
+// Gives possible values. In case values cannot be predicted, just provide an
+// empty array : array() .
 $ec_conf_possible_values = array(
   'activated'          => array('0', '1'),
@@ -95 +106 @@
   'unknown_code'       => array('0', '1', '2'),
   'unknown_code_ap_id' => array(),
-  'comment_display'    => array('0', '1')
+  'comment_display'    => array('0', '1'),
+  'in_help_display'    => array('0', '1'),
 );
+
+// Once these lines have been updated, you don't need to change anything
+// else. Everything is managed by the code ; the only effect being that
+// existing configuration values in the DB are reset to their default
+// values -- normally not a harmful effect.
+//----------------------------------------------------------------------------
 
 $ec_conf_index = array_flip(array_keys($ec_conf_default));