Code

more info
authorrichard <richard@57a73879-2fb5-44c3-a270-3262357dd7e2>
Thu, 25 Jul 2002 02:25:54 +0000 (02:25 +0000)
committerrichard <richard@57a73879-2fb5-44c3-a270-3262357dd7e2>
Thu, 25 Jul 2002 02:25:54 +0000 (02:25 +0000)
git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@912 57a73879-2fb5-44c3-a270-3262357dd7e2

doc/customizing.txt

index 8ec3b3e4856901ba51dbc09388ed6fed66c706fd..b03009407916ac3f9cd99aaff4339c7bb2e5cf43 100644 (file)
@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.10 $
+:Version: $Revision: 1.11 $
 
 .. contents::
 
@@ -560,12 +560,13 @@ anything you want as a web interface to your instance.
 Most customisation of the web view can be done by modifying the templates in
 the instance html directory. These are divided into index, item and newitem
 views. The newitem view is optional - the item view will be used if the newitem
-view doesn't exist.
+view doesn't exist. The header and footer that wrap the various views give the
+pages an overall look.
 
 Repurcussions of changing the instance schema
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-If you choose to change_the_instance_schema you will need to ensure the web
+If you choose to change the `instance schema`_ you will need to ensure the web
 interface knows about it:
 
 1. Index, item and filter pages for the relevant classes may need to have
@@ -576,6 +577,16 @@ interface knows about it:
    values) you will need to implement your own pagehead() method in your
    instance's interfaces.py module.
 
+Overall Look - the Header and Footer
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The header and footer are generated by Python code. The default code is in
+roundup.cgi_client.Class. This class is mixed-in to your instance through the
+instance's interfaces module. This means you can override the header and
+footer with your own code. This allows you to use a sidebar navigation scheme,
+for example.
+
+
 Displaying Properties
 ~~~~~~~~~~~~~~~~~~~~~