Mercurial > p > roundup > code
comparison doc/customizing.txt @ 2134:00dfd8b50773
doc clarification
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Fri, 26 Mar 2004 01:55:10 +0000 |
| parents | 3fd672293712 |
| children | f76d1642014a |
comparison
equal
deleted
inserted
replaced
| 2133:f01befe8a7fe | 2134:00dfd8b50773 |
|---|---|
| 1 =================== | 1 =================== |
| 2 Customising Roundup | 2 Customising Roundup |
| 3 =================== | 3 =================== |
| 4 | 4 |
| 5 :Version: $Revision: 1.123 $ | 5 :Version: $Revision: 1.124 $ |
| 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:: |
| 865 special request variable ``@template``. The URL path after the tracker | 865 special request variable ``@template``. The URL path after the tracker |
| 866 identifier is examined. Typical URL paths look like: | 866 identifier is examined. Typical URL paths look like: |
| 867 | 867 |
| 868 1. ``/tracker/issue`` | 868 1. ``/tracker/issue`` |
| 869 2. ``/tracker/issue1`` | 869 2. ``/tracker/issue1`` |
| 870 3. ``/tracker/_file/style.css`` | 870 3. ``/tracker/@file/style.css`` |
| 871 4. ``/cgi-bin/roundup.cgi/tracker/file1`` | 871 4. ``/cgi-bin/roundup.cgi/tracker/file1`` |
| 872 5. ``/cgi-bin/roundup.cgi/tracker/file1/kitten.png`` | 872 5. ``/cgi-bin/roundup.cgi/tracker/file1/kitten.png`` |
| 873 | 873 |
| 874 where the "tracker identifier" is "tracker" in the above cases. That means | 874 where the "tracker identifier" is "tracker" in the above cases. That means |
| 875 we're looking at "issue", "issue1", "_file/style.css", "file1" and | 875 we're looking at "issue", "issue1", "@file/style.css", "file1" and |
| 876 "file1/kitten.png" in the cases above. The path is generally only one | 876 "file1/kitten.png" in the cases above. The path is generally only one |
| 877 entry long - longer paths are handled differently. | 877 entry long - longer paths are handled differently. |
| 878 | 878 |
| 879 a. if there is no path, then we are in the "home" context. | 879 a. if there is no path, then we are in the "home" context. |
| 880 b. if the path starts with "_file" (as in example 3, | 880 b. if the path starts with "@file" (as in example 3, |
| 881 "/tracker/_file/style.css"), then the additional path entry, | 881 "/tracker/@file/style.css"), then the additional path entry, |
| 882 "style.css" specifies the filename of a static file we're to serve up | 882 "style.css" specifies the filename of a static file we're to serve up |
| 883 from the tracker "html" directory. Raises a SendStaticFile exception. | 883 from the tracker "html" directory. Raises a SendStaticFile exception. |
| 884 c. if there is something in the path (as in example 1, "issue"), it | 884 c. if there is something in the path (as in example 1, "issue"), it |
| 885 identifies the tracker class we're to display. | 885 identifies the tracker class we're to display. |
| 886 d. if the path is an item designator (as in examples 2 and 4, "issue1" | 886 d. if the path is an item designator (as in examples 2 and 4, "issue1" |
| 898 The template used is specified by the ``@template`` CGI variable, which | 898 The template used is specified by the ``@template`` CGI variable, which |
| 899 defaults to: | 899 defaults to: |
| 900 | 900 |
| 901 - only classname suplied: "index" | 901 - only classname suplied: "index" |
| 902 - full item designator supplied: "item" | 902 - full item designator supplied: "item" |
| 903 | |
| 904 | |
| 905 Serving static content | |
| 906 ---------------------- | |
| 907 | |
| 908 See the previous section `determining web context`_ where it describes | |
| 909 ``@file`` paths. | |
| 903 | 910 |
| 904 | 911 |
| 905 Performing actions in web requests | 912 Performing actions in web requests |
| 906 ---------------------------------- | 913 ---------------------------------- |
| 907 | 914 |
