diff doc/customizing.txt @ 5231:8743b7226dc7

Fix issue with retreiving raw template files using the @@file mechanism. This changes the static_files option in config.ini from supporting a single directory to support multiple directories. If one of the directory elements is '-' (i.e. a lone hyphen) the search is stopped and the TEMPLATES directory is not searched. Since the TEMPLATES directory is not searched the raw templates aren't accessed. See: https://sourceforge.net/p/roundup/mailman/message/35773357/ Message subject: showing template sources to all for details. Also check in CHANGES.txt that mentions a couple of other small improvements in the roundup-admin command.
author John Rouillard <rouilj@ieee.org>
date Tue, 11 Apr 2017 22:20:13 -0400
parents 690ec4f438df
children 462b0f76fce8
line wrap: on
line diff
--- a/doc/customizing.txt	Tue Apr 11 21:51:28 2017 -0400
+++ b/doc/customizing.txt	Tue Apr 11 22:20:13 2017 -0400
@@ -87,6 +87,8 @@
 
 __ http://docs.python.org/lib/module-ConfigParser.html
 
+Example configuration settings are below.
+ 
 Section **main**
  database -- ``db``
   Database directory path. The path may be either absolute or relative
@@ -97,12 +99,13 @@
   or relative to the directory containing this config file.
 
  static_files -- default *blank*
-  Path to directory holding additional static files available via Web
-  UI.  This directory may contain sitewide images, CSS stylesheets etc.
-  and is searched for these files prior to the TEMPLATES directory
-  specified above.  If this option is not set, all static files are
-  taken from the TEMPLATES directory The path may be either absolute or
-  relative to the directory containig this config file.
+  A list of space separated directory paths (or a single directory).
+  These directories hold additional static files available via Web UI.
+  These directories may contain sitewide images, CSS stylesheets etc. If
+  a '-' is included, the list processing ends and the TEMPLATES
+  directory is not searched after the specified directories.  If this
+  option is not set, all static files are taken from the TEMPLATES
+  directory.
 
  admin_email -- ``roundup-admin``
   Email address that roundup will complain to if it runs into trouble. If
@@ -459,7 +462,8 @@
 
 
 You may generate a new default config file using the ``roundup-admin
-genconfig`` command.
+genconfig`` command. You can generate a new config file merging in
+existing settings using the ``roundup-admin updateconfig`` command.
 
 Configuration variables may be referred to in lower or upper case. In code,
 variables not in the "main" section are referred to using their section and

Roundup Issue Tracker: http://roundup-tracker.org/