changeset 3768:ef5da136cdc5

document extending config
author Richard Jones <richard@users.sourceforge.net>
date Sat, 25 Nov 2006 00:52:18 +0000
parents 9d93653f8dcb
children d41ee0fdae71
files doc/customizing.txt
diffstat 1 files changed, 21 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/doc/customizing.txt	Thu Nov 23 13:27:14 2006 +0000
+++ b/doc/customizing.txt	Sat Nov 25 00:52:18 2006 +0000
@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.212 $
+:Version: $Revision: 1.213 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -347,6 +347,26 @@
 name, so "domain" in the section "mail" becomes MAIL_DOMAIN. The
 configuration variables available are:
 
+Extending the configuration file
+--------------------------------
+
+You can't add new variables to the config.ini file in the tracker home but
+you can add two new config.ini files:
+
+- a config.ini in the ``extensions`` directory will be loaded and attached
+  to the config variable as "ext".
+- a config.ini in the ``detectors`` directory will be loaded and attached
+  to the config variable as "detectors".
+
+For example, the following in ``detectors/config.ini``::
+
+    [main]
+    qa_recipients = email@example.com
+
+is accessible as::
+
+    db.config.detectors['QA_RECIPIENTS']
+
 
 Tracker Schema
 ==============

Roundup Issue Tracker: http://roundup-tracker.org/