Mercurial > p > roundup > code
comparison doc/customizing.txt @ 3754:9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Sun, 12 Nov 2006 00:09:42 +0000 |
| parents | c3bba2c81a6f |
| children | ef5da136cdc5 |
comparison
equal
deleted
inserted
replaced
| 3753:a6eff0dd2c9c | 3754:9f4dd27ae843 |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.211 $ | 5 :Version: $Revision: 1.212 $ |
| 6 | 6 |
| 7 .. This document borrows from the ZopeBook section on ZPT. The original is at: | 7 .. This document borrows from the ZopeBook section on ZPT. The original is at: |
| 8 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx | 8 http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx |
| 9 | 9 |
| 10 .. contents:: | 10 .. contents:: |
| 395 keyword = Class(db, "keyword", name=String()) | 395 keyword = Class(db, "keyword", name=String()) |
| 396 keyword.setkey("name") | 396 keyword.setkey("name") |
| 397 | 397 |
| 398 user = Class(db, "user", username=String(), organisation=String(), | 398 user = Class(db, "user", username=String(), organisation=String(), |
| 399 password=String(), address=String(), realname=String(), | 399 password=String(), address=String(), realname=String(), |
| 400 phone=String()) | 400 phone=String(), alternate_addresses=String(), |
| 401 queries=Multilink('query'), roles=String(), timezone=String()) | |
| 401 user.setkey("username") | 402 user.setkey("username") |
| 402 | 403 |
| 403 msg = FileClass(db, "msg", author=Link("user"), summary=String(), | 404 msg = FileClass(db, "msg", author=Link("user"), summary=String(), |
| 404 date=Date(), recipients=Multilink("user"), | 405 date=Date(), recipients=Multilink("user"), |
| 405 files=Multilink("file")) | 406 files=Multilink("file"), messageid=String(), inreplyto=String()) |
| 406 | 407 |
| 407 file = FileClass(db, "file", name=String(), type=String()) | 408 file = FileClass(db, "file", name=String()) |
| 408 | 409 |
| 409 issue = IssueClass(db, "issue", topic=Multilink("keyword"), | 410 issue = IssueClass(db, "issue", topic=Multilink("keyword"), |
| 410 status=Link("status"), assignedto=Link("user"), | 411 status=Link("status"), assignedto=Link("user"), |
| 411 priority=Link("priority")) | 412 priority=Link("priority")) |
| 412 issue.setkey('title') | 413 issue.setkey('title') |
| 533 FileClasses save their "content" attribute off in a separate file from | 534 FileClasses save their "content" attribute off in a separate file from |
| 534 the rest of the database. This reduces the number of large entries in | 535 the rest of the database. This reduces the number of large entries in |
| 535 the database, which generally makes databases more efficient, and also | 536 the database, which generally makes databases more efficient, and also |
| 536 allows us to use command-line tools to operate on the files. They are | 537 allows us to use command-line tools to operate on the files. They are |
| 537 stored in the files sub-directory of the ``'db'`` directory in your | 538 stored in the files sub-directory of the ``'db'`` directory in your |
| 538 tracker. | 539 tracker. FileClasses also have a "type" attribute to store the MIME |
| 540 type of the file. | |
| 539 | 541 |
| 540 | 542 |
| 541 IssueClass | 543 IssueClass |
| 542 ~~~~~~~~~~ | 544 ~~~~~~~~~~ |
| 543 | 545 |
| 638 | 640 |
| 639 | 641 |
| 640 Examples of adding to your schema | 642 Examples of adding to your schema |
| 641 --------------------------------- | 643 --------------------------------- |
| 642 | 644 |
| 643 TODO | 645 The Roundup wiki has examples of how schemas can be customised to add |
| 646 new functionality. | |
| 644 | 647 |
| 645 | 648 |
| 646 Detectors - adding behaviour to your tracker | 649 Detectors - adding behaviour to your tracker |
| 647 ============================================ | 650 ============================================ |
| 648 .. _detectors: | 651 .. _detectors: |
| 797 | 800 |
| 798 Database Content | 801 Database Content |
| 799 ================ | 802 ================ |
| 800 | 803 |
| 801 .. note:: | 804 .. note:: |
| 802 if you modify the content of definitional classes, you'll most | 805 If you modify the content of definitional classes, you'll most |
| 803 likely need to edit the tracker `detectors`_ to reflect your changes. | 806 likely need to edit the tracker `detectors`_ to reflect your changes. |
| 804 | 807 |
| 805 Customisation of the special "definitional" classes (eg. status, | 808 Customisation of the special "definitional" classes (eg. status, |
| 806 priority, resolution, ...) may be done either before or after the | 809 priority, resolution, ...) may be done either before or after the |
| 807 tracker is initialised. The actual method of doing so is completely | 810 tracker is initialised. The actual method of doing so is completely |