Mercurial > p > roundup > code

annotate doc/glossary.txt @ 8506:b6c6891754e9

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
bug: fix mis-commit of perf tests and crash fix for setTranslation The commit included more than it should have. It included some memory dump code that is not part of production. Also removed WIP for fixing crash bug when translation unable to create .mo file - issue2551405
author John Rouillard <rouilj@ieee.org>
date Thu, 25 Dec 2025 12:14:53 -0500
parents 0663a7bcef6c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6270
diff changeset
1 .. meta::
6774
e7b4ad2c57ac landmarks, skiplink, remove bad attrs, autocomplete search
John Rouillard <rouilj@ieee.org>
parents: 6586
diff changeset
2 :description:
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6270
diff changeset
3 Definitions of terms used in the Roundup Issue Tracker
7287
648d5916c248 update description metadata
John Rouillard <rouilj@ieee.org>
parents: 6905
diff changeset
4 documentation. Referenced by other documents.
6586
24e2eeb2ed9a Add meta description to some doc pages.
John Rouillard <rouilj@ieee.org>
parents: 6270
diff changeset
5
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
6 ================
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
7 Roundup Glossary
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
8 ================
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
9
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
10 .. glossary::
7370
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
11 :sorted:
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
12
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
13 class
7370
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
14 a definition of the properties and behavior of a set of items
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
15
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
16 classname
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
17 the name of a class. It must start with a letter, end with a letter
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
18 or "_", and only have alphanumerics and "_" in the middle.
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
19
7370
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
20 db
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
21 database used to store the data in the tracker. Roundup supports
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
22 4 databases: dbm (Berkeley DB/BDB), SQLite, PostgreSQL, MySQL/MariaDB.
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
23
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
24 definitional class
7370
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
25 a class that exists to define a discrete set of values. For example
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
26 status or priority.
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
27
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
28 designator
7370
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
29 a combined :term:`classname` + :term:`itemid` reference to any item
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
30 in the hyperdb. E.g. ``issue26``. Note that form values can include
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
31 something that looks like a designator composed of a classname,
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
32 a dash '-', and a number. E.g. ``file-1``. These are used to create
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
33 new instances of a class via the web interface.
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
34
8364
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
35 detectors
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
36 There are two types of detectors that execute Python code in
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
37 response to changes to the database.
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
38
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
39 auditors
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
40 are run before a permanent change is made to the database.
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
41 They validate that the change is allowed. For example is
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
42 the current user allowed to change the status field.
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
43
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
44 reactors
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
45 are run after a change has been committed to the
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
46 database. They are used to perform actions like sending
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
47 notification messages, updating other tickets etc.
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
48
8363
b4dfc68b7067 doc: add glossary entry for "html directory"
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
49 html directory
b4dfc68b7067 doc: add glossary entry for "html directory"
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
50 there is a directory called **html** in tracker homes. This
b4dfc68b7067 doc: add glossary entry for "html directory"
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
51 contains html files (called templates) that are processed by the
b4dfc68b7067 doc: add glossary entry for "html directory"
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
52 templating processor (TAL or jinja2) for delivery to a web
b4dfc68b7067 doc: add glossary entry for "html directory"
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
53 client. However there is also a ``templates`` setting in the
b4dfc68b7067 doc: add glossary entry for "html directory"
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
54 tracker's ``config.ini`` file. The default value for this is
b4dfc68b7067 doc: add glossary entry for "html directory"
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
55 ``html``. However any directories listed as templates should be
b4dfc68b7067 doc: add glossary entry for "html directory"
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
56 considered an ``html directory``
b4dfc68b7067 doc: add glossary entry for "html directory"
John Rouillard <rouilj@ieee.org>
parents: 7504
diff changeset
57
7370
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
58 hyperdb
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
59 a software layer between the user and the underlying :term:`db`.
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
60 It is responsible for mutating the underlying db when the schema
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
61 changes. It also executes the detectors when items in the db change.
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
62
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
63 item
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
64 a collection of data that forms one entry in the hyperdb.
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
65
7370
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
66 itemid
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
67 an integer reference to a particular item of one
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
68 class. Internally it is stored as a string and not an integer
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
69 number. This results in a string not numeric sort by id in some
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
70 circumstances.
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
71
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
72 property
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
73 one element of data that makes up an item. In Roundup, the set
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
74 of item properties may be changed as needed - even after the
7370
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
75 tracker has been initialized and used in production.
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
76
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
77 schema
7370
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
78 the definition of all the classes and properties that make up a
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
79 tracker. Contained in the file ``schema.py``. The permissions
f37c1df6de34 Glossary updates and more term refs.
John Rouillard <rouilj@ieee.org>
parents: 7369
diff changeset
80 for the schema items are usually defined in the same file.
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
81
8364
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
82 template
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
83
8384
e0e3212c1e80 doc: better document the template property in the request object.
John Rouillard <rouilj@ieee.org>
parents: 8364
diff changeset
84 this term has three meanings depending on context.
8364
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
85
8388
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
86 1. files that are processed by a templating engine to
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
87 produce output suitable for machine or human consumption. For
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
88 example a template could produce a html page that includes the
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
89 name of the user.
8364
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
90
8388
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
91 2. a property of the request object in the templating
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
92 system. Templates that are used with a specific class (e.g.
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
93 ``issue.item.html``) will have this entry set to the middle
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
94 element (``item`` in this example). For templates like
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
95 ``home.html`` the element will be set to the empty string.
8384
e0e3212c1e80 doc: better document the template property in the request object.
John Rouillard <rouilj@ieee.org>
parents: 8364
diff changeset
96
8388
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
97 3. a **Tracker template**. This is a set of files
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
98 used to install a new tracker. Tracker templates define a
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
99 tracker with a particular look and feel, :term:`schema`,
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
100 permissions model, and :term:`detectors`. Roundup ships with
8eee280eddc3 doc: document request.template object in template glossary (3rd meaning)
John Rouillard <rouilj@ieee.org>
parents: 8384
diff changeset
101 five templates and people on the net `have produced other
8412
0663a7bcef6c feat: finish reauth docs, enhance code.
John Rouillard <rouilj@ieee.org>
parents: 8388
diff changeset
102 templates`_. You can find the installed location of the
0663a7bcef6c feat: finish reauth docs, enhance code.
John Rouillard <rouilj@ieee.org>
parents: 8388
diff changeset
103 standard Roundup templates using the :ref:`roundup-admin
0663a7bcef6c feat: finish reauth docs, enhance code.
John Rouillard <rouilj@ieee.org>
parents: 8388
diff changeset
104 templates <roundup-admin templates>` command.
8364
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
105
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
106
7369
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
107 tracker
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
108 the schema and hyperdb that forms one issue tracker
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
109
15bb0d177632 use glossary directive and link some terms to the glossary.
John Rouillard <rouilj@ieee.org>
parents: 7349
diff changeset
110 tracker home
7504
1a912887d704 Clarify meaning of 'tracker directory' in upgrading doc.
John Rouillard <rouilj@ieee.org>
parents: 7370
diff changeset
111 the physical location on disk of a tracker. It has the
1a912887d704 Clarify meaning of 'tracker directory' in upgrading doc.
John Rouillard <rouilj@ieee.org>
parents: 7370
diff changeset
112 ``config.ini``, ``schema.py`` files for the tracker.
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
113
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
114
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
115 -----------------
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
116
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
117 Back to `Table of Contents`_
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
118
8364
dc136e237fa6 doc: add detector and template defs.
John Rouillard <rouilj@ieee.org>
parents: 8363
diff changeset
119 .. _`have produced other templates`: https://wiki.roundup-tracker.org/TrackerTemplates
6905
9ca128103a3a fix broken links to doc table of contents
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
120 .. _`Table of Contents`: ../docs.html
783
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
121
Roundup Issue Tracker: http://roundup-tracker.org/