Skip to content

Commit f8b5635

Browse files
author
Richard Jones
committed
more info about the "home" context
1 parent 94c509b commit f8b5635

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

doc/customizing.txt

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Customising Roundup
33
===================
44

5-
:Version: $Revision: 1.134 $
5+
:Version: $Revision: 1.135 $
66

77
.. This document borrows from the ZopeBook section on ZPT. The original is at:
88
http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -952,7 +952,8 @@ we're looking at "issue", "issue1", "@file/style.css", "file1" and
952952
"file1/kitten.png" in the cases above. The path is generally only one
953953
entry long - longer paths are handled differently.
954954

955-
a. if there is no path, then we are in the "home" context.
955+
a. if there is no path, then we are in the "home" context. See `the "home"
956+
context`_ below for more information about how it may be used.
956957
b. if the path starts with "@file" (as in example 3,
957958
"/tracker/@file/style.css"), then the additional path entry,
958959
"style.css" specifies the filename of a static file we're to serve up
@@ -978,6 +979,25 @@ defaults to:
978979
- full item designator supplied: "item"
979980

980981

982+
The "home" Context
983+
------------------
984+
985+
The "home" context is special because it allows you to add templated
986+
pages to your tracker that don't rely on a class or item (ie. an issues
987+
list or specific issue).
988+
989+
Let's say you wish to add frames to control the layout of your tracker's
990+
interface. You'd probably have:
991+
992+
- A top-level frameset page. This page probably wouldn't be templated, so
993+
it could be served as a static file (see `serving static content`_)
994+
- A sidebar frame that is templated. Let's call this page
995+
"home.navigation.html" in your tracker's "html" directory. To load that
996+
page up, you use the URL:
997+
998+
<tracker url>/home?@template=navigation
999+
1000+
9811001
Serving static content
9821002
----------------------
9831003

0 commit comments

Comments
 (0)