Mercurial > p > roundup > code
comparison doc/customizing.txt @ 2227:15c20983fd13
more info about the "home" context
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Tue, 20 Apr 2004 00:43:29 +0000 |
| parents | 0b76c4961802 |
| children | 5092d44194dd e19284d8d2a4 |
comparison
equal
deleted
inserted
replaced
| 2226:03bb30c5e2c3 | 2227:15c20983fd13 |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.134 $ | 5 :Version: $Revision: 1.135 $ |
| 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:: |
| 950 where the "tracker identifier" is "tracker" in the above cases. That means | 950 where the "tracker identifier" is "tracker" in the above cases. That means |
| 951 we're looking at "issue", "issue1", "@file/style.css", "file1" and | 951 we're looking at "issue", "issue1", "@file/style.css", "file1" and |
| 952 "file1/kitten.png" in the cases above. The path is generally only one | 952 "file1/kitten.png" in the cases above. The path is generally only one |
| 953 entry long - longer paths are handled differently. | 953 entry long - longer paths are handled differently. |
| 954 | 954 |
| 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. | |
| 956 b. if the path starts with "@file" (as in example 3, | 957 b. if the path starts with "@file" (as in example 3, |
| 957 "/tracker/@file/style.css"), then the additional path entry, | 958 "/tracker/@file/style.css"), then the additional path entry, |
| 958 "style.css" specifies the filename of a static file we're to serve up | 959 "style.css" specifies the filename of a static file we're to serve up |
| 959 from the tracker "html" directory. Raises a SendStaticFile exception. | 960 from the tracker "html" directory. Raises a SendStaticFile exception. |
| 960 c. if there is something in the path (as in example 1, "issue"), it | 961 c. if there is something in the path (as in example 1, "issue"), it |
| 974 The template used is specified by the ``@template`` CGI variable, which | 975 The template used is specified by the ``@template`` CGI variable, which |
| 975 defaults to: | 976 defaults to: |
| 976 | 977 |
| 977 - only classname suplied: "index" | 978 - only classname suplied: "index" |
| 978 - full item designator supplied: "item" | 979 - full item designator supplied: "item" |
| 980 | |
| 981 | |
| 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 | |
| 979 | 999 |
| 980 | 1000 |
| 981 Serving static content | 1001 Serving static content |
| 982 ---------------------- | 1002 ---------------------- |
| 983 | 1003 |