annotate doc/glossary.txt @ 7349:17ce2f368e88

add definition for definitional class
author John Rouillard <rouilj@ieee.org>
date Tue, 16 May 2023 00:47:27 -0400
parents 648d5916c248
children 15bb0d177632
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
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
10
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
11 class
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
12 a definition of the properties and behaviour of a set of items
6238
6834bb5473da Summary: Constrain format of classname and document
John Rouillard <rouilj@ieee.org>
parents: 4746
diff changeset
13 classname
6834bb5473da Summary: Constrain format of classname and document
John Rouillard <rouilj@ieee.org>
parents: 4746
diff changeset
14 the name of a class. It must start with a letter, end with a letter
6834bb5473da Summary: Constrain format of classname and document
John Rouillard <rouilj@ieee.org>
parents: 4746
diff changeset
15 or "_", and only have alphanumerics and "_" in the middle.
1571
8b5ff6ca0674 more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
16 db (or hyperdb)
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
17 a collection of items
7349
17ce2f368e88 add definition for definitional class
John Rouillard <rouilj@ieee.org>
parents: 7287
diff changeset
18 definitional class
17ce2f368e88 add definition for definitional class
John Rouillard <rouilj@ieee.org>
parents: 7287
diff changeset
19 a class that exists to define a descrete set of values. For example
17ce2f368e88 add definition for definitional class
John Rouillard <rouilj@ieee.org>
parents: 7287
diff changeset
20 status or priority.
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
21 designator
6270
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
22 a combined class + itemid reference to any item in the
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
23 hyperdb. E.g. issue26. Note that form values can include
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
24 something that looks like a designator composed of a classname, a
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
25 dash '-', and a number. E.g. file-1. These
98e2835b787a Document designator like classname-number.
John Rouillard <rouilj@ieee.org>
parents: 6238
diff changeset
26 are used to create new instances of a class via the web interface.
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
27 itemid
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
28 a numeric reference to a particular item of one class
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
29 item
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
30 a collection of data that forms one entry in the hyperdb.
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
31 property
4567
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4557
diff changeset
32 one element of data that makes up an item. In Roundup, the set
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4557
diff changeset
33 of item properties may be changed as needed - even after the
32b24abfe98e Documentation polishing.
Eric S. Raymond <esr@thyrsus.com>
parents: 4557
diff changeset
34 tracker has been initialised and used in production.
796
5324a28060ab *** empty log message ***
Richard Jones <richard@users.sourceforge.net>
parents: 783
diff changeset
35 schema
1089
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
36 the definition of all the classes that make up an tracker
43ab730ee194 instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents: 796
diff changeset
37 tracker
1571
8b5ff6ca0674 more doc fixes
Richard Jones <richard@users.sourceforge.net>
parents: 1089
diff changeset
38 the schema and hyperdb that forms one issue tracker
1576
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
39 tracker home
80519db85eac More tweaks to the licensing to make the Debian folks happy :)
Richard Jones <richard@users.sourceforge.net>
parents: 1571
diff changeset
40 the physical location on disk of a 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
41
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
42
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
43 -----------------
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
44
2f1c59a5bb88 Yes, I know it's not perfect, but I want something in there now ;)
Richard Jones <richard@users.sourceforge.net>
parents:
diff changeset
45 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
46
6905
9ca128103a3a fix broken links to doc table of contents
John Rouillard <rouilj@ieee.org>
parents: 6774
diff changeset
47 .. _`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
48

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