document the STATIC_FILES config var

Author: Richard Jones

CHANGES.txt

@@ -30,6 +30,7 @@ Fixed:
 - fixed RDBMS filter() for no matches from full-text search (sf bug 990778)
 - fixed DateHTMLProperty for invalid date entry (sf bug 986538)
 - fixed external password source example (sf bug 986601)
+- document the STATIC_FILES config var
 
 
 2004-06-24 0.7.5

doc/customizing.txt

@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.143 $
+:Version: $Revision: 1.144 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -118,6 +118,11 @@ The configuration variables available are:
  This is the directory that the HTML templates reside in. By default they are
  in the tracker home.
 
+**STATIC_FILES** - e.g. ``os.path.join(TRACKER_HOME, 'files')``
+ This *optional* variable defines the directory that static files are served
+ from (files with the URL ``/@@file/<filename>``). If this is not defined,
+ then static files are served from the TEMPLATES directory.
+
 **TRACKER_NAME** - ``'Roundup issue tracker'``
  A descriptive name for your roundup tracker. This is sent out in e-mails and
  appears in the heading of CGI pages.
@@ -243,6 +248,11 @@ tracker is attempted.::
     # This is the directory that the HTML templates reside in
     TEMPLATES = os.path.join(TRACKER_HOME, 'html')
 
+    # Optional: the directory that static files are served from (files with
+    # the URL /@@file/<filename>). If this is not defined, then static files
+    # are served from the TEMPLATES directory.
+    # STATIC_FILES = os.path.join(TRACKER_HOME, 'files')
+
     # A descriptive name for your roundup tracker
     TRACKER_NAME = 'Roundup issue tracker'
 

templates/classic/config.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: config.py,v 1.9 2004-06-08 05:29:18 richard Exp $
+# $Id: config.py,v 1.10 2004-07-20 00:15:23 richard Exp $
 
 import os
 
@@ -48,6 +48,11 @@
 # This is the directory that the HTML templates reside in
 TEMPLATES = os.path.join(TRACKER_HOME, 'html')
 
+# Optional: the directory that static files are served from (files with the
+# URL /@@file/<filename>). If this is not defined, then static files are
+# served from the TEMPLATES directory.
+# STATIC_FILES = os.path.join(TRACKER_HOME, 'files')
+
 # A descriptive name for your roundup instance
 TRACKER_NAME = 'Roundup issue tracker'
 

templates/minimal/config.py

@@ -15,7 +15,7 @@
 # BASIS, AND THERE IS NO OBLIGATION WHATSOEVER TO PROVIDE MAINTENANCE,
 # SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 # 
-# $Id: config.py,v 1.7 2004-06-08 05:29:18 richard Exp $
+# $Id: config.py,v 1.8 2004-07-20 00:15:23 richard Exp $
 
 import os
 
@@ -48,6 +48,11 @@
 # This is the directory that the HTML templates reside in
 TEMPLATES = os.path.join(TRACKER_HOME, 'html')
 
+# Optional: the directory that static files are served from (files with the
+# URL /@@file/<filename>). If this is not defined, then static files are
+# served from the TEMPLATES directory.
+# STATIC_FILES = os.path.join(TRACKER_HOME, 'files')
+
 # A descriptive name for your roundup instance
 TRACKER_NAME = 'Roundup issue tracker'