diff doc/glossary.txt @ 8364:dc136e237fa6

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.
author John Rouillard <rouilj@ieee.org>
date Thu, 10 Jul 2025 23:03:27 -0400
parents b4dfc68b7067
children e0e3212c1e80
line wrap: on
line diff
--- a/doc/glossary.txt	Thu Jul 10 22:27:49 2025 -0400
+++ b/doc/glossary.txt	Thu Jul 10 23:03:27 2025 -0400
@@ -32,6 +32,20 @@
       a dash '-', and a number. E.g. ``file-1``. These are used to create
       new instances of a class via the web interface.
 
+   detectors
+      There are two types of detectors that execute Python code in
+      response to changes to the database.
+
+      auditors
+	are run before a permanent change is made to the database.
+	They validate that the change is allowed. For example is
+	the current user allowed to change the status field.
+
+      reactors
+	are run after a change has been committed to the
+	database. They are used to perform actions like sending
+	notification messages, updating other tickets etc.
+
    html directory
       there is a directory called **html** in tracker homes. This
       contains html files (called templates) that are processed by the
@@ -65,6 +79,22 @@
       tracker. Contained in the file ``schema.py``. The permissions
       for the schema items are usually defined in the same file.
 
+   template
+
+      this term has two meanings depending on context.
+
+      It refers to files that are processed by a templating engine to
+      produce output suitable for machine or human consumption. For
+      example a template could produce a html page that includes the
+      name of the user.
+
+      It also can mean a **Tracker template**. This is a set of files
+      used to install a new tracker. Tracker templates define a
+      tracker with a particular look and feel, :term:`schema`,
+      permissions model, and :term:`detectors`. Roundu ships with five
+      templates and people on the net `have produced other templates`_
+
+
    tracker
       the schema and hyperdb that forms one issue tracker
 
@@ -77,5 +107,6 @@
 
 Back to `Table of Contents`_
 
+.. _`have produced other templates`: https://wiki.roundup-tracker.org/TrackerTemplates
 .. _`Table of Contents`: ../docs.html
 

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