2007-08-24 Don Allingham <don@gramps-project.org>

* src/Config/_GrampsConfigKeys.py: added coment on how do add a new
	key



svn: r8859

ChangeLog

@@ -1,3 +1,7 @@
+2007-08-24  Don Allingham  <don@gramps-project.org>
+	* src/Config/_GrampsConfigKeys.py: added coment on how do add a new
+	key
+
 2007-08-24  Brian Matherly <brian@gramps-project.org>
 	* src/GrampsDbUtils/_PrivateProxyDb.py: Implement get_default_person and
 	  get_default_handle

src/Config/_GrampsConfigKeys.py

@@ -20,10 +20,32 @@
 
 # $Id$
 
-# NOTE: This file is autogenerated by gen_schema_keys.py script
+"""
-# from the data/gramps.schemas.in file. To generate, run:
+Adding a new configuration key:
-#    python gen_schema_keys.py ../../data/gramps.schemas.in
+
-# in the src/Config directory.
+Add a value in the form of:
+
+  VARIABLE = ( category, key_name, type)
+
+Where:
+
+  cateogory is a single word string defining the grouping along 
+  with related keys
+
+  key_name is a single word string defining the actual configuration
+  name
+
+  type is an integer defining the type of the value of the 
+  configuration value. 
+
+    0 - boolean
+    1 - integer
+    2 - string
+
+Then add the variable to the default_value map at the end of the
+file, and provide a default value according to the value's type.
+"""
+
 
 DEFAULT_SOURCE       = ('preferences', 'default-source', 0)
 RELATION_SHADE       = ('preferences', 'relation-shade', 0)

src/Config/_GrampsGconfKeys.py

@@ -21,7 +21,8 @@
 # $Id$
 
 """
-Low-level handling of gconf keys. 
+gconf is no longer supported. This functino serves only to provide an upgrade
+path to the new system.
 """
 
 #-------------------------------------------------------------------------