Mercurial > p > roundup > code
comparison doc/reference.txt @ 7369:15bb0d177632
use glossary directive and link some terms to the glossary.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Wed, 17 May 2023 00:03:01 -0400 |
| parents | 8aa1a5639aef |
| children | f37c1df6de34 |
comparison
equal
deleted
inserted
replaced
| 7368:8aa1a5639aef | 7369:15bb0d177632 |
|---|---|
| 1115 | 1115 |
| 1116 create(information) | 1116 create(information) |
| 1117 ::::::::::::::::::: | 1117 ::::::::::::::::::: |
| 1118 | 1118 |
| 1119 Create an item in the database. This is generally used to create items | 1119 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". |
| 1121 | 1121 |
| 1122 IssueClass | 1122 IssueClass |
| 1123 ~~~~~~~~~~ | 1123 ~~~~~~~~~~ |
| 1124 | 1124 |
| 1125 IssueClasses automatically include the "messages", "files", "nosy", and | 1125 IssueClasses automatically include the "messages", "files", "nosy", and |
| 1513 | 1513 |
| 1514 Database Content | 1514 Database Content |
| 1515 ================ | 1515 ================ |
| 1516 | 1516 |
| 1517 .. note:: | 1517 .. 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 |
| 1519 need to edit the tracker `detectors`_ if they reference a value | 1519 need to edit the tracker `detectors`_ if they reference a value |
| 1520 of a definitional class. (E.g. if a detector checks to see if an | 1520 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 | 1521 issue has a status of "open", and you change the "open" definition |
| 1522 "working".) | 1522 to be "working", you need to change the check.) |
| 1523 | 1523 |
| 1524 Customisation of the special "definitional" classes (eg. status, | 1524 Customisation of the special definitional classes (eg. status, |
| 1525 priority, resolution, ...) may be done either before or after the | 1525 priority, resolution, ...) may be done either before or after the |
| 1526 tracker is initialised. The actual method of doing so is completely | 1526 tracker is initialised. The actual method of doing so is completely |
| 1527 different in each case though, so be careful to use the right one. | 1527 different in each case though, so be careful to use the right one. |
| 1528 | 1528 |
| 1529 **Changing content before tracker initialisation** | 1529 **Changing content before tracker initialisation** |
| 2018 8. ``/issue1`` | 2018 8. ``/issue1`` |
| 2019 | 2019 |
| 2020 .. _strip_zeros: | 2020 .. _strip_zeros: |
| 2021 | 2021 |
| 2022 Note that a leading string of 0's will be stripped from the id part of | 2022 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 | 2023 the object :term:`designator` in the URL. E.G. ``/issue001`` is the |
| 2024 ``/issue1``. Similarly for ``/file01`` etc. However you should | 2024 same as ``/issue1``. Similarly for ``/file01`` etc. However you |
| 2025 generate URL's without the extra zeros. | 2025 should generate URL's without the extra zeros. |
| 2026 | 2026 |
| 2027 Determining web context | 2027 Determining web context |
| 2028 ----------------------- | 2028 ----------------------- |
| 2029 | 2029 |
| 2030 To determine the "context" of a request (what request is for), we look at | 2030 To determine the "context" of a request (what request is for), we look at |