Skip to content

Commit 0879fd4

Browse files
author
Richard Jones
committed
documentation updates
1 parent 7bb3ee0 commit 0879fd4

File tree

6 files changed

+1479
-82
lines changed

6 files changed

+1479
-82
lines changed

doc/customizing.txt

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Customising Roundup
33
===================
44

5-
:Version: $Revision: 1.11 $
5+
:Version: $Revision: 1.12 $
66

77
.. contents::
88

@@ -514,13 +514,35 @@ Create a node in the database. This is generally used to create nodes in the
514514

515515

516516
Detectors - adding behaviour to your tracker
517-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
517+
--------------------------------------------
518518
.. _`detectors`:
519519

520+
The detectors in your instance fire before (*auditors*) and after (*reactors*)
521+
changes to the contents of your database. They are Python modules that sit in
522+
your instance's ``detectors`` directory. You will have some installed by
523+
default - have a look. You can write new detectors or modify the existing
524+
ones. The existing detectors installed for you are:
525+
526+
**nosyreaction.py**
527+
This provides the automatic nosy list maintenance and email sending. The nosy
528+
reactor (``nosyreaction``) fires when new messages are added to issues.
529+
The nosy auditor (``updatenosy``) fires when issues are changed and figures
530+
what changes need to be made to the nosy list (like adding new authors etc)
531+
**statusauditor.py**
532+
This provides the ``chatty`` auditor which changes the issue status from
533+
``unread`` or ``closed`` to ``chatting`` if new messages appear. It also
534+
provides the ``presetunread`` auditor which pre-sets the status to
535+
``unread`` on new nodes if the status isn't explicitly defined.
536+
537+
See the detectors section in the `design document`__ for details of the
538+
interface for detectors.
539+
540+
__ spec.html
541+
520542
Sample additional detectors that have been found useful will appear in the
521543
``detectors`` directory of the Roundup distribution:
522544

523-
newissuecopy.py
545+
**newissuecopy.py**
524546
This detector sends an email to a team address whenever a new issue is
525547
created. The address is hard-coded into the detector, so edit it before you
526548
use it (look for the text '[email protected]') or you'll get email errors!

doc/default.css

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/*
22
:Author: David Goodger
33
4-
:date: $Date: 2002-07-25 07:14:05 $
5-
:version: $Revision: 1.6 $
4+
:date: $Date: 2002-07-29 00:54:28 $
5+
:version: $Revision: 1.7 $
66
:copyright: This stylesheet has been placed in the public domain.
77
88
Default cascading style sheet for the HTML output of Docutils.
@@ -118,6 +118,10 @@ dd p:first-child {
118118
margin-top: 0px;
119119
}
120120

121+
dd ul:first-child {
122+
margin-top: 0px;
123+
}
124+
121125
li p:first-child {
122126
margin-top: 0px;
123127
}

0 commit comments

Comments
 (0)