From 350edaf87b122b1c19c24aeee20bce9dd44bc3ff Mon Sep 17 00:00:00 2001 From: richard Date: Fri, 4 Oct 2002 01:32:59 +0000 Subject: [PATCH] merge from maint-0-5 git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@1313 57a73879-2fb5-44c3-a270-3262357dd7e2 --- doc/customizing.txt | 71 ++++++++++++++++++++++++++++++++++++-------- doc/installation.txt | 15 +++++++--- 2 files changed, 69 insertions(+), 17 deletions(-) diff --git a/doc/customizing.txt b/doc/customizing.txt index 96e52ca..4caa99a 100644 --- a/doc/customizing.txt +++ b/doc/customizing.txt @@ -2,7 +2,7 @@ Customising Roundup =================== -:Version: $Revision: 1.51 $ +:Version: $Revision: 1.52 $ .. This document borrows from the ZopeBook section on ZPT. The original is at: http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx @@ -52,18 +52,43 @@ html/ Web interface templates, images and style sheets Tracker Configuration ===================== -The config.py located in your tracker home contains the basic -configuration for the web and e-mail components of roundup's interfaces. This -file is a Python module. The configuration variables available are: +The config.py located in your tracker home contains the basic configuration +for the web and e-mail components of roundup's interfaces. As the name +suggests, this file is a Python module. This means that any valid python +expression may be used in the file. Mostly though, you'll be setting the +configuration variables to string values. Python string values must be quoted +with either single or double quotes:: + + 'this is a string' + "this is also a string - use it when you have a 'single quote' in the value" + this is not a string - it's not quoted + +Python strings may use formatting that's almost identical to C string +formatting. The ``%`` operator is used to perform the formatting, like so:: + + 'roundup-admin@%s'%MAIL_DOMAIN + +this will create a string ``'roundup-admin@tracker.domain.example'`` if +MAIL_DOMAIN is set to ``'tracker.domain.example'``. + +You'll also note some values are set to:: + + os.path.join(TRACKER_HOME, 'db') + +or similar. This creates a new string which holds the path to the "db" +directory in the TRACKER_HOME directory. This is just a convenience so if the +TRACKER_HOME changes you don't have to edit multiple valoues. + +The configuration variables available are: **TRACKER_HOME** - ``os.path.split(__file__)[0]`` The tracker home directory. The above default code will automatically - determine the tracker home for you. + determine the tracker home for you, so you can just leave it alone. **MAILHOST** - ``'localhost'`` The SMTP mail host that roundup will use to send e-mail. -**MAIL_DOMAIN** - ``'your.tracker.email.domain.example'`` +**MAIL_DOMAIN** - ``'tracker.domain.example'`` The domain name used for email addresses. **DATABASE** - ``os.path.join(TRACKER_HOME, 'db')`` @@ -1428,18 +1453,38 @@ by activity, arranged in descending order. The filter section shows filters for the "status" and "topic" properties, and the table includes columns for the "title", "status", and "fixer" properties. -Filtering of indexes -~~~~~~~~~~~~~~~~~~~~ - -TODO - Searching Views --------------- This is one of the class context views. The template used is typically -"*classname*.search". +"*classname*.search". The form on this page should have "search" as its +``:action`` variable. The "search" action: + +- sets up additional filtering, as well as performing indexed text searching +- sets the ``:filter`` variable correctly +- saves the query off if ``:query_name`` is set. + +The searching page should lay out any fields that you wish to allow the user +to search one. If your schema contains a large number of properties, you +should be wary of making all of those properties available for searching, as +this can cause confusion. If the additional properties are Strings, consider +having their value indexed, and then they will be searchable using the full +text indexed search. This is both faster, and more useful for the end user. + +The two special form values on search pages which are handled by the "search" +action are: + +:search_text + Text to perform a search of the text index with. Results from that search + will be used to limit the results of other filters (using an intersection + operation) +:query_name + If supplied, the search parameters (including :search_text) will be saved + off as a the query item and registered against the user's queries property. + Note that the *classic* template schema has this ability, but the *minimal* + template schema does not. + -TODO Item Views ---------- diff --git a/doc/installation.txt b/doc/installation.txt index 204a3e2..10f15b1 100644 --- a/doc/installation.txt +++ b/doc/installation.txt @@ -2,7 +2,7 @@ Installing Roundup ================== -:Version: $Revision: 1.30 $ +:Version: $Revision: 1.31 $ .. contents:: @@ -118,9 +118,14 @@ Basic Installation Steps You will now be directed to edit the tracker configuration and initial schema. At a minimum, you must set ``MAILHOST``, - ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. If you just want - to get set up to test things quickly, you can even just set the - TRACKER_WEB variable to:: + ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. Note that the + configuration file uses Python syntax, so almost every value must be + ``'quoted'`` using single or double quotes. If you get stuck, and get + configuration file errors, then see the `tracker configuration`_ section + of the `customisation documentation`_. + + If you just want to get set up to test things quickly, you can even + just set the TRACKER_WEB variable to:: TRACKER_WEB = 'http://localhost:8080/support/' @@ -417,6 +422,8 @@ Next: `Getting Started`_ .. _`table of contents`: index.html .. _`getting started`: getting_started.html .. _`roundup specification`: spec.html +.. _`tracker configuration`: customizing.html#tracker-configuration +.. _`customisation documentation`: customizing.html .. _`customising roundup`: customizing.html .. _`upgrading document`: upgrading.html .. _`maintenance documentation`: maintenance.html -- 2.30.2