|
2 | 2 | Customising Roundup |
3 | 3 | =================== |
4 | 4 |
|
5 | | -:Version: $Revision: 1.11 $ |
| 5 | +:Version: $Revision: 1.12 $ |
6 | 6 |
|
7 | 7 | .. contents:: |
8 | 8 |
|
@@ -514,13 +514,35 @@ Create a node in the database. This is generally used to create nodes in the |
514 | 514 |
|
515 | 515 |
|
516 | 516 | Detectors - adding behaviour to your tracker |
517 | | -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 517 | +-------------------------------------------- |
518 | 518 | .. _`detectors`: |
519 | 519 |
|
| 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 | + |
520 | 542 | Sample additional detectors that have been found useful will appear in the |
521 | 543 | ``detectors`` directory of the Roundup distribution: |
522 | 544 |
|
523 | | -newissuecopy.py |
| 545 | +**newissuecopy.py** |
524 | 546 | This detector sends an email to a team address whenever a new issue is |
525 | 547 | created. The address is hard-coded into the detector, so edit it before you |
526 | 548 | use it (look for the text ' [email protected]') or you'll get email errors! |
|
0 commit comments