comparison doc/glossary.txt @ 7464:82bbb95e5690 issue2550923_computed_property

merge from tip into issue2550923_computed_property
author John Rouillard <rouilj@ieee.org>
date Thu, 08 Jun 2023 00:10:32 -0400
parents f37c1df6de34
children 1a912887d704
comparison
equal deleted inserted replaced
7045:ca90f7270cd4 7464:82bbb95e5690
1 .. meta:: 1 .. meta::
2 :description: 2 :description:
3 Definitions of terms used in the Roundup Issue Tracker 3 Definitions of terms used in the Roundup Issue Tracker
4 documentation. 4 documentation. Referenced by other documents.
5 5
6 ================ 6 ================
7 Roundup Glossary 7 Roundup Glossary
8 ================ 8 ================
9 9
10 .. glossary::
11 :sorted:
10 12
11 class 13 class
12 a definition of the properties and behaviour of a set of items 14 a definition of the properties and behavior of a set of items
13 classname 15
14 the name of a class. It must start with a letter, end with a letter 16 classname
15 or "_", and only have alphanumerics and "_" in the middle. 17 the name of a class. It must start with a letter, end with a letter
16 db (or hyperdb) 18 or "_", and only have alphanumerics and "_" in the middle.
17 a collection of items 19
18 designator 20 db
19 a combined class + itemid reference to any item in the 21 database used to store the data in the tracker. Roundup supports
20 hyperdb. E.g. issue26. Note that form values can include 22 4 databases: dbm (Berkeley DB/BDB), SQLite, PostgreSQL, MySQL/MariaDB.
21 something that looks like a designator composed of a classname, a 23
22 dash '-', and a number. E.g. file-1. These 24 definitional class
23 are used to create new instances of a class via the web interface. 25 a class that exists to define a discrete set of values. For example
24 itemid 26 status or priority.
25 a numeric reference to a particular item of one class 27
26 item 28 designator
27 a collection of data that forms one entry in the hyperdb. 29 a combined :term:`classname` + :term:`itemid` reference to any item
28 property 30 in the hyperdb. E.g. ``issue26``. Note that form values can include
29 one element of data that makes up an item. In Roundup, the set 31 something that looks like a designator composed of a classname,
30 of item properties may be changed as needed - even after the 32 a dash '-', and a number. E.g. ``file-1``. These are used to create
31 tracker has been initialised and used in production. 33 new instances of a class via the web interface.
32 schema 34
33 the definition of all the classes that make up an tracker 35 hyperdb
34 tracker 36 a software layer between the user and the underlying :term:`db`.
35 the schema and hyperdb that forms one issue tracker 37 It is responsible for mutating the underlying db when the schema
36 tracker home 38 changes. It also executes the detectors when items in the db change.
37 the physical location on disk of a tracker 39
40 item
41 a collection of data that forms one entry in the hyperdb.
42
43 itemid
44 an integer reference to a particular item of one
45 class. Internally it is stored as a string and not an integer
46 number. This results in a string not numeric sort by id in some
47 circumstances.
48
49 property
50 one element of data that makes up an item. In Roundup, the set
51 of item properties may be changed as needed - even after the
52 tracker has been initialized and used in production.
53
54 schema
55 the definition of all the classes and properties that make up a
56 tracker. Contained in the file ``schema.py``. The permissions
57 for the schema items are usually defined in the same file.
58
59 tracker
60 the schema and hyperdb that forms one issue tracker
61
62 tracker home
63 the physical location on disk of a tracker
38 64
39 65
40 ----------------- 66 -----------------
41 67
42 Back to `Table of Contents`_ 68 Back to `Table of Contents`_

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