Mercurial > p > roundup > code
comparison doc/customizing.txt @ 899:4f082e1242f7
more info
[[Parts of this commit other than changes to doc/customizing.txt may
originally have been a separate commit. Relevant metadata was stepped
on during conversion of CVS to Subversion.]]
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Thu, 25 Jul 2002 02:25:54 +0000 |
| parents | 5ffac75a7f2e |
| children | 38a74d1351c5 |
comparison
equal
deleted
inserted
replaced
| 898:5ffac75a7f2e | 899:4f082e1242f7 |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.10 $ | 5 :Version: $Revision: 1.11 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 | 9 |
| 10 What You Can Do | 10 What You Can Do |
| 558 the access through its main() method. This means that you can do pretty much | 558 the access through its main() method. This means that you can do pretty much |
| 559 anything you want as a web interface to your instance. | 559 anything you want as a web interface to your instance. |
| 560 Most customisation of the web view can be done by modifying the templates in | 560 Most customisation of the web view can be done by modifying the templates in |
| 561 the instance html directory. These are divided into index, item and newitem | 561 the instance html directory. These are divided into index, item and newitem |
| 562 views. The newitem view is optional - the item view will be used if the newitem | 562 views. The newitem view is optional - the item view will be used if the newitem |
| 563 view doesn't exist. | 563 view doesn't exist. The header and footer that wrap the various views give the |
| 564 pages an overall look. | |
| 564 | 565 |
| 565 Repurcussions of changing the instance schema | 566 Repurcussions of changing the instance schema |
| 566 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | 567 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| 567 | 568 |
| 568 If you choose to change_the_instance_schema you will need to ensure the web | 569 If you choose to change the `instance schema`_ you will need to ensure the web |
| 569 interface knows about it: | 570 interface knows about it: |
| 570 | 571 |
| 571 1. Index, item and filter pages for the relevant classes may need to have | 572 1. Index, item and filter pages for the relevant classes may need to have |
| 572 properties added or removed, | 573 properties added or removed, |
| 573 2. The default page header relies on the existence of, and some values of | 574 2. The default page header relies on the existence of, and some values of |
| 574 the priority, status, assignedto and activity classes. If you change any | 575 the priority, status, assignedto and activity classes. If you change any |
| 575 of these (specifically if you remove any of the classes or their default | 576 of these (specifically if you remove any of the classes or their default |
| 576 values) you will need to implement your own pagehead() method in your | 577 values) you will need to implement your own pagehead() method in your |
| 577 instance's interfaces.py module. | 578 instance's interfaces.py module. |
| 579 | |
| 580 Overall Look - the Header and Footer | |
| 581 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| 582 | |
| 583 The header and footer are generated by Python code. The default code is in | |
| 584 roundup.cgi_client.Class. This class is mixed-in to your instance through the | |
| 585 instance's interfaces module. This means you can override the header and | |
| 586 footer with your own code. This allows you to use a sidebar navigation scheme, | |
| 587 for example. | |
| 588 | |
| 578 | 589 |
| 579 Displaying Properties | 590 Displaying Properties |
| 580 ~~~~~~~~~~~~~~~~~~~~~ | 591 ~~~~~~~~~~~~~~~~~~~~~ |
| 581 | 592 |
| 582 Properties appear in the user interface in three contexts: in indices, in | 593 Properties appear in the user interface in three contexts: in indices, in |