Mercurial > p > roundup > code
comparison doc/customizing.txt @ 898:5ffac75a7f2e
clarification
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Thu, 25 Jul 2002 02:10:20 +0000 |
| parents | faf164ab8ed9 |
| children | 4f082e1242f7 |
comparison
equal
deleted
inserted
replaced
| 894:cbefecea6c74 | 898:5ffac75a7f2e |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.9 $ | 5 :Version: $Revision: 1.10 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 | |
| 10 What You Can Do | |
| 11 --------------- | |
| 12 | |
| 13 Customisation of Roundup can take one of three forms: | |
| 14 | |
| 15 1. `instance configuration`_ file changes | |
| 16 2. `instance schema`_ changes | |
| 17 3. "definition" class `database content`_ changes | |
| 18 | |
| 19 The third case is special because it takes two distinctly different forms | |
| 20 depending upon whether the instance has been initialised or not. The other two | |
| 21 may be done at any time, before or after instance initialisation. Yes, this | |
| 22 includes adding or removing properties from classes. | |
| 23 | |
| 24 | |
| 25 Instances in a Nutshell | |
| 26 ----------------------- | |
| 9 | 27 |
| 10 Instances have the following structure: | 28 Instances have the following structure: |
| 11 | 29 |
| 12 +-------------------+--------------------------------------------------------+ | 30 +-------------------+--------------------------------------------------------+ |
| 13 |instance_config.py |Holds the basic instance_configuration | | 31 |instance_config.py |Holds the basic instance_configuration | |
| 334 | 352 |
| 335 Instance Schema | 353 Instance Schema |
| 336 --------------- | 354 --------------- |
| 337 | 355 |
| 338 Note: if you modify the schema, you'll most likely need to edit the | 356 Note: if you modify the schema, you'll most likely need to edit the |
| 339 `web interface`_ HTML template files to reflect your changes. | 357 `web interface`_ HTML template files and `detectors`_ to reflect |
| 358 your changes. | |
| 340 | 359 |
| 341 An instance schema defines what data is stored in the instance's database. The | 360 An instance schema defines what data is stored in the instance's database. The |
| 342 two schemas shipped with Roundup turn it into a typical software bug tracker | 361 two schemas shipped with Roundup turn it into a typical software bug tracker |
| 343 (the extended schema allowing for support issues as well as bugs). Schemas are | 362 (the extended schema allowing for support issues as well as bugs). Schemas are |
| 344 defined using Python code. The "classic" schema looks like this:: | 363 defined using Python code. The "classic" schema looks like this:: |
| 494 "definitional" classes like "priority" and "status". | 513 "definitional" classes like "priority" and "status". |
| 495 | 514 |
| 496 | 515 |
| 497 Detectors - adding behaviour to your tracker | 516 Detectors - adding behaviour to your tracker |
| 498 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 517 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 518 .. _`detectors`: | |
| 499 | 519 |
| 500 Sample additional detectors that have been found useful will appear in the | 520 Sample additional detectors that have been found useful will appear in the |
| 501 ``detectors`` directory of the Roundup distribution: | 521 ``detectors`` directory of the Roundup distribution: |
| 502 | 522 |
| 503 newissuecopy.py | 523 newissuecopy.py |
| 504 This detector sends an email to a team address whenever a new issue is | 524 This detector sends an email to a team address whenever a new issue is |
| 505 created. The address is hard-coded into the detector, so edit it before you | 525 created. The address is hard-coded into the detector, so edit it before you |
| 506 use it (look for the text 'team@team.host') or you'll get email errors! | 526 use it (look for the text 'team@team.host') or you'll get email errors! |
| 527 | |
| 528 | |
| 529 Database Content | |
| 530 ---------------- | |
| 531 | |
| 532 Note: if you modify the content of definitional classes, you'll most likely | |
| 533 need to edit the instance `detectors`_ to reflect your changes. | |
| 534 | |
| 535 Customisation of the special "definitional" classes (eg. status, priority, | |
| 536 resolution, ...) may be done either before or after the instance is | |
| 537 initialised. The actual method of doing so is completely different in each | |
| 538 case though, so be careful to use the right one. | |
| 539 | |
| 540 **Changing content before instance initialisation** | |
| 541 Edit the dbinit module in your instance to alter the nodes created in using | |
| 542 the create() methods. | |
| 543 | |
| 544 | |
| 545 **Changing content after instance initialisation** | |
| 546 Use the roundup-admin interface's create, set and retire methods to add, | |
| 547 alter or remove nodes from the classes in question. | |
| 548 | |
| 507 | 549 |
| 508 | 550 |
| 509 Web Interface | 551 Web Interface |
| 510 ------------- | 552 ------------- |
| 511 | 553 |