Skip to content

Commit 65e3f95

Browse files
committed
use glossary directive and link some terms to the glossary.
1 parent 44b96d7 commit 65e3f95

File tree

2 files changed

+49
-38
lines changed

2 files changed

+49
-38
lines changed

doc/glossary.txt

Lines changed: 41 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,37 +7,48 @@
77
Roundup Glossary
88
================
99

10+
.. glossary::
1011

11-
class
12-
a definition of the properties and behaviour of a set of items
13-
classname
14-
the name of a class. It must start with a letter, end with a letter
15-
or "_", and only have alphanumerics and "_" in the middle.
16-
db (or hyperdb)
17-
a collection of items
18-
definitional class
19-
a class that exists to define a descrete set of values. For example
20-
status or priority.
21-
designator
22-
a combined class + itemid reference to any item in the
23-
hyperdb. E.g. issue26. Note that form values can include
24-
something that looks like a designator composed of a classname, a
25-
dash '-', and a number. E.g. file-1. These
26-
are used to create new instances of a class via the web interface.
27-
itemid
28-
a numeric reference to a particular item of one class
29-
item
30-
a collection of data that forms one entry in the hyperdb.
31-
property
32-
one element of data that makes up an item. In Roundup, the set
33-
of item properties may be changed as needed - even after the
34-
tracker has been initialised and used in production.
35-
schema
36-
the definition of all the classes that make up an tracker
37-
tracker
38-
the schema and hyperdb that forms one issue tracker
39-
tracker home
40-
the physical location on disk of a tracker
12+
class
13+
a definition of the properties and behaviour of a set of items
14+
15+
classname
16+
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+
19+
db (or hyperdb)
20+
a collection of items
21+
22+
definitional class
23+
a class that exists to define a descrete set of values. For example
24+
status or priority.
25+
26+
designator
27+
a combined class + itemid reference to any item in the
28+
hyperdb. E.g. issue26. Note that form values can include
29+
something that looks like a designator composed of a classname, a
30+
dash '-', and a number. E.g. file-1. These
31+
are used to create new instances of a class via the web interface.
32+
33+
itemid
34+
a numeric reference to a particular item of one class
35+
36+
item
37+
a collection of data that forms one entry in the hyperdb.
38+
39+
property
40+
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
42+
tracker has been initialised and used in production.
43+
44+
schema
45+
the definition of all the classes that make up an tracker
46+
47+
tracker
48+
the schema and hyperdb that forms one issue tracker
49+
50+
tracker home
51+
the physical location on disk of a tracker
4152

4253

4354
-----------------

doc/reference.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1117,7 +1117,7 @@ create(information)
11171117
:::::::::::::::::::
11181118

11191119
Create an item in the database. This is generally used to create items
1120-
in the "definitional" classes like "priority" and "status".
1120+
in the :term:`definitional class` like "priority" and "status".
11211121

11221122
IssueClass
11231123
~~~~~~~~~~
@@ -1515,13 +1515,13 @@ Database Content
15151515
================
15161516

15171517
.. note::
1518-
If you modify the content of definitional classes, you will
1518+
If you modify the content of a :term:`definitional class`, you will
15191519
need to edit the tracker `detectors`_ if they reference a value
15201520
of a definitional class. (E.g. if a detector checks to see if an
1521-
issue is "open", and you change the "open" definition to be
1522-
"working".)
1521+
issue has a status of "open", and you change the "open" definition
1522+
to be "working", you need to change the check.)
15231523

1524-
Customisation of the special "definitional" classes (eg. status,
1524+
Customisation of the special definitional classes (eg. status,
15251525
priority, resolution, ...) may be done either before or after the
15261526
tracker is initialised. The actual method of doing so is completely
15271527
different in each case though, so be careful to use the right one.
@@ -2020,9 +2020,9 @@ for specific object of issue class with id 1 will look like:
20202020
.. _strip_zeros:
20212021

20222022
Note that a leading string of 0's will be stripped from the id part of
2023-
the object designator in the URL. E.G. ``/issue001`` is the same as
2024-
``/issue1``. Similarly for ``/file01`` etc. However you should
2025-
generate URL's without the extra zeros.
2023+
the object :term:`designator` in the URL. E.G. ``/issue001`` is the
2024+
same as ``/issue1``. Similarly for ``/file01`` etc. However you
2025+
should generate URL's without the extra zeros.
20262026

20272027
Determining web context
20282028
-----------------------

0 commit comments

Comments
 (0)