Mercurial > p > roundup > code

comparison doc/glossary.txt @ 7370:f37c1df6de34

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Glossary updates and more term refs. Expanded db glossary definition with list of supported physical db's. added definition for hyperdb. expanded definition of itemid to include that it is handled as a string in some circumstances.
author John Rouillard <rouilj@ieee.org>
date Wed, 17 May 2023 00:29:48 -0400
parents 15bb0d177632
children 1a912887d704
comparison
equal deleted inserted replaced
7369:15bb0d177632 7370:f37c1df6de34
6 ================ 6 ================
7 Roundup Glossary 7 Roundup Glossary
8 ================ 8 ================
9 9
10 .. glossary:: 10 .. glossary::
11 :sorted:
11 12
12 class 13 class
13 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
14 15
15 classname 16 classname
16 the name of a class. It must start with a letter, end with a letter 17 the name of a class. It must start with a letter, end with a letter
17 or "_", and only have alphanumerics and "_" in the middle. 18 or "_", and only have alphanumerics and "_" in the middle.
18 19
19 db (or hyperdb) 20 db
20 a collection of items 21 database used to store the data in the tracker. Roundup supports
22 4 databases: dbm (Berkeley DB/BDB), SQLite, PostgreSQL, MySQL/MariaDB.
21 23
22 definitional class 24 definitional class
23 a class that exists to define a descrete set of values. For example 25 a class that exists to define a discrete set of values. For example
24 status or priority. 26 status or priority.
25 27
26 designator 28 designator
27 a combined class + itemid reference to any item in the 29 a combined :term:`classname` + :term:`itemid` reference to any item
28 hyperdb. E.g. issue26. Note that form values can include 30 in the hyperdb. E.g. ``issue26``. Note that form values can include
29 something that looks like a designator composed of a classname, a 31 something that looks like a designator composed of a classname,
30 dash '-', and a number. E.g. file-1. These 32 a dash '-', and a number. E.g. ``file-1``. These are used to create
31 are used to create new instances of a class via the web interface. 33 new instances of a class via the web interface.
32 34
33 itemid 35 hyperdb
34 a numeric reference to a particular item of one class 36 a software layer between the user and the underlying :term:`db`.
37 It is responsible for mutating the underlying db when the schema
38 changes. It also executes the detectors when items in the db change.
35 39
36 item 40 item
37 a collection of data that forms one entry in the hyperdb. 41 a collection of data that forms one entry in the hyperdb.
38 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
39 property 49 property
40 one element of data that makes up an item. In Roundup, the set 50 one element of data that makes up an item. In Roundup, the set
41 of item properties may be changed as needed - even after the 51 of item properties may be changed as needed - even after the
42 tracker has been initialised and used in production. 52 tracker has been initialized and used in production.
43 53
44 schema 54 schema
45 the definition of all the classes that make up an tracker 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.
46 58
47 tracker 59 tracker
48 the schema and hyperdb that forms one issue tracker 60 the schema and hyperdb that forms one issue tracker
49 61
50 tracker home 62 tracker home
Roundup Issue Tracker: http://roundup-tracker.org/