diff doc/customizing.txt @ 2921:ad4fb8a14a97

more doc updates, not so many TODOs any more
author Richard Jones <richard@users.sourceforge.net>
date Thu, 18 Nov 2004 05:05:25 +0000
parents 7d97c75e7cba
children 1ae91c2fa5fe
line wrap: on
line diff
--- a/doc/customizing.txt	Wed Nov 17 22:16:29 2004 +0000
+++ b/doc/customizing.txt	Thu Nov 18 05:05:25 2004 +0000
@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.157 $
+:Version: $Revision: 1.158 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -39,13 +39,15 @@
 =================== ========================================================
 Tracker File        Description
 =================== ========================================================
-config.py           Holds the basic `tracker configuration`_                 
-dbinit.py           Holds the `tracker schema`_                              
-interfaces.py       Defines the Web and E-Mail interfaces for the tracker    
-select_db.py        Selects the database back-end for the tracker            
+config.ini          Holds the basic `tracker configuration`_                 
+schema.py           Holds the `tracker schema`_                              
+initial_data.py     Holds any data to be entered into the database when the
+                    tracker is initialised.
 db/                 Holds the tracker's database                             
 db/files/           Holds the tracker's upload files and messages            
+db/backend_name     Names the database back-end for the tracker            
 detectors/          Auditors and reactors for this tracker                   
+extensions/         Additional web actions and templating utilities.
 html/               Web interface templates, images and style sheets         
 =================== ======================================================== 
 
@@ -1222,8 +1224,8 @@
 -----------------
 
 The default templates are html4 compliant. If you wish to change them to be
-xhtml compliant, you'll need to change the ``HTML_VERSION`` configuration
-variable in ``config.py`` to ``'xhtml'`` instead of ``'html4'``.
+xhtml compliant, you'll need to change the ``html_version`` configuration
+variable in ``config.ini`` to ``'xhtml'`` instead of ``'html4'``.
 
 Most customisation of the web view can be done by modifying the
 templates in the tracker ``'html'`` directory. There are several types
@@ -1534,7 +1536,7 @@
      The current CGI form information as a mapping of form argument name
      to value
 **config**
-  This variable holds all the values defined in the tracker config.py
+  This variable holds all the values defined in the tracker config.ini
   file (eg. TRACKER_NAME, etc.)
 **db**
   The current database, used to access arbitrary database items.
@@ -3834,11 +3836,13 @@
     db.security.addPermissionToRole('Provisional User', p)
 
 
-Then in the ``config.py`` we change the Role assigned to newly-registered
+Then in the ``config.ini`` we change the Role assigned to newly-registered
 users, replacing the existing ``'User'`` values::
 
-    NEW_WEB_USER_ROLES = 'Provisional User'
-    NEW_EMAIL_USER_ROLES = 'Provisional User'
+    [main]
+    ...
+    new_web_user_roles = 'Provisional User'
+    new_email_user_roles = 'Provisional User'
 
 Finally we add a new *auditor* to the ``detectors`` directory called
 ``provisional_user_auditor.py``::

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