Skip to content

Commit e9a6488

Browse files
committed
doc: add detector and template defs.
The detector def also includes auditor and reactor defs. Template as in html template also provides context/def for tracker template.
1 parent fc043c2 commit e9a6488

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

doc/glossary.txt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,20 @@ Roundup Glossary
3232
a dash '-', and a number. E.g. ``file-1``. These are used to create
3333
new instances of a class via the web interface.
3434

35+
detectors
36+
There are two types of detectors that execute Python code in
37+
response to changes to the database.
38+
39+
auditors
40+
are run before a permanent change is made to the database.
41+
They validate that the change is allowed. For example is
42+
the current user allowed to change the status field.
43+
44+
reactors
45+
are run after a change has been committed to the
46+
database. They are used to perform actions like sending
47+
notification messages, updating other tickets etc.
48+
3549
html directory
3650
there is a directory called **html** in tracker homes. This
3751
contains html files (called templates) that are processed by the
@@ -65,6 +79,22 @@ Roundup Glossary
6579
tracker. Contained in the file ``schema.py``. The permissions
6680
for the schema items are usually defined in the same file.
6781

82+
template
83+
84+
this term has two meanings depending on context.
85+
86+
It refers to files that are processed by a templating engine to
87+
produce output suitable for machine or human consumption. For
88+
example a template could produce a html page that includes the
89+
name of the user.
90+
91+
It also can mean a **Tracker template**. This is a set of files
92+
used to install a new tracker. Tracker templates define a
93+
tracker with a particular look and feel, :term:`schema`,
94+
permissions model, and :term:`detectors`. Roundu ships with five
95+
templates and people on the net `have produced other templates`_
96+
97+
6898
tracker
6999
the schema and hyperdb that forms one issue tracker
70100

@@ -77,5 +107,6 @@ Roundup Glossary
77107

78108
Back to `Table of Contents`_
79109

110+
.. _`have produced other templates`: https://wiki.roundup-tracker.org/TrackerTemplates
80111
.. _`Table of Contents`: ../docs.html
81112

0 commit comments

Comments
 (0)