Mercurial > p > roundup > code
comparison doc/reference.txt @ 7482:82a0adad2ae6
Fix bad index reference. Add new ones.
| author | John Rouillard <rouilj@ieee.org> |
|---|---|
| date | Sun, 11 Jun 2023 23:06:50 -0400 |
| parents | 2e3b5c10c502 |
| children | a072331c843b |
comparison
equal
deleted
inserted
replaced
| 7481:d397647d8d5a | 7482:82a0adad2ae6 |
|---|---|
| 662 | 662 |
| 663 A tracker schema defines what data is stored in the tracker's database. | 663 A tracker schema defines what data is stored in the tracker's database. |
| 664 Schemas are defined using Python code in the ``schema.py`` module of your | 664 Schemas are defined using Python code in the ``schema.py`` module of your |
| 665 tracker. | 665 tracker. |
| 666 | 666 |
| 667 .. index:: schema; allowed changes | |
| 668 | |
| 667 What you can/can't do to the schema | 669 What you can/can't do to the schema |
| 668 ----------------------------------- | 670 ----------------------------------- |
| 669 | 671 |
| 670 Your schema may be changed at any time before or after the tracker has been | 672 Your schema may be changed at any time before or after the tracker has been |
| 671 initialised (or used). You may: | 673 initialised (or used). You may: |
| 751 issue = IssueClass(db, "issue", keyword=Multilink("keyword"), | 753 issue = IssueClass(db, "issue", keyword=Multilink("keyword"), |
| 752 status=Link("status"), assignedto=Link("user"), | 754 status=Link("status"), assignedto=Link("user"), |
| 753 priority=Link("priority")) | 755 priority=Link("priority")) |
| 754 issue.setkey('title') | 756 issue.setkey('title') |
| 755 | 757 |
| 756 .. index:: schema; allowed changes | 758 .. index:: schema; classes and properties |
| 757 | 759 |
| 758 Classes and Properties - creating a new information store | 760 Classes and Properties - creating a new information store |
| 759 --------------------------------------------------------- | 761 --------------------------------------------------------- |
| 760 | 762 |
| 761 In the tracker above, we've defined 7 classes of information: | 763 In the tracker above, we've defined 7 classes of information: |
| 796 interface. The classic tracker was created before the REST interface | 798 interface. The classic tracker was created before the REST interface |
| 797 was added. It uses the single form (i.e. issue and user not issues and | 799 was added. It uses the single form (i.e. issue and user not issues and |
| 798 users) for its classes. Most REST documentation suggests using plural | 800 users) for its classes. Most REST documentation suggests using plural |
| 799 forms. However, to make your API consistent, use singular forms for | 801 forms. However, to make your API consistent, use singular forms for |
| 800 classes that you add. | 802 classes that you add. |
| 803 | |
| 804 .. index:: | |
| 805 schema; classes | |
| 806 schema; items | |
| 801 | 807 |
| 802 Class and Items | 808 Class and Items |
| 803 ~~~~~~~~~~~~~~~ | 809 ~~~~~~~~~~~~~~~ |
| 804 | 810 |
| 805 A Class defines a particular class (or type) of data that will be stored | 811 A Class defines a particular class (or type) of data that will be stored |