From c31914c0578df81d63ddc2a899f95d105fb9e96b Mon Sep 17 00:00:00 2001
From: Don Allingham <don@gramps-project.org>
Date: Fri, 24 Aug 2007 16:35:42 +0000
Subject: [PATCH] 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                       |  4 ++++
 src/Config/_GrampsConfigKeys.py | 30 ++++++++++++++++++++++++++----
 src/Config/_GrampsGconfKeys.py  |  3 ++-
 3 files changed, 32 insertions(+), 5 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 44983f969..e8710e6a0 100644
--- a/ChangeLog
+++ b/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
diff --git a/src/Config/_GrampsConfigKeys.py b/src/Config/_GrampsConfigKeys.py
index 18ff68aca..e4ab5f3bd 100644
--- a/src/Config/_GrampsConfigKeys.py
+++ b/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:
-#    python gen_schema_keys.py ../../data/gramps.schemas.in
-# in the src/Config directory.
+"""
+Adding a new configuration key:
+
+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)
diff --git a/src/Config/_GrampsGconfKeys.py b/src/Config/_GrampsGconfKeys.py
index ad7c088ce..cc4f89d75 100644
--- a/src/Config/_GrampsGconfKeys.py
+++ b/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.
 """
 
 #-------------------------------------------------------------------------