Documentation cleanup, added info for potential (and current) developers

[roundup.git] / doc / customizing.txt

diff --git a/doc/customizing.txt b/doc/customizing.txt
index cf9f18a7aedfd7aea12535c321c3409b677d25f1..270f5f711f009cbbcbd40253b74ce137b74c3520 100644 (file)
--- a/doc/customizing.txt
+++ b/doc/customizing.txt
@@ -1,6 +1,11 @@
 Customising Roundup
 ===================
 
+:Version: $Revision: 1.4 $
+
+.. contents::
+
+
 Instances have the following structure:
 
 +-------------------+--------------------------------------------------------+
@@ -242,6 +247,19 @@ create(information)
 Create a node in the database. This is generally used to create nodes in the
 "definitional" classes like "priority" and "status".
 
+
+Detectors - adding behaviour to your tracker
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Sample additional detectors that have been found useful will appear in the
+``detectors`` directory of the Roundup distribution:
+
+newissuecopy.py
+  This detector sends an email to a team address whenever a new issue is
+  created. The address is hard-coded into the detector, so edit it before you
+  use it (look for the text 'team@team.host') or you'll get email errors!
+
+
 Web Interface
 -------------
 
@@ -572,4 +590,9 @@ eliminate sections of the spool section if the property has no entries::
       </tr>
      </property>
 
+-----------------
+
+Back to `Table of Contents`_
+
+.. _`Table of Contents`: index.html