merge

Author: Richard Jones

doc/Makefile

@@ -1,17 +1,25 @@
-PYTHON = /usr/bin/python2
 STXTOHTML = rst2html
+STXTOHT = rst2ht.py
+WEBDIR = ../../htdocs/htdocs/doc-0.7
 
 SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \
     glossary.txt implementation.txt index.txt design.txt mysql.txt \
     installation.txt upgrading.txt user_guide.txt admin_guide.txt \
 	postgresql.txt tracker_templates.txt whatsnew-0.7.txt
 
 COMPILED := $(SOURCE:.txt=.html)
+WEBHT := $(SOURCE:.txt=.ht)
 
-all: ${COMPILED}
+all: ${COMPILED} ${WEBHT}
+
+website: ${WEBHT}
+	cp *.ht ${WEBDIR}
 
 %.html: %.txt
 	${STXTOHTML} --report=warning -d $< $@
 
+%.ht: %.txt
+	${STXTOHT} --report=warning -d $< $@
+
 clean:
 	rm -f ${COMPILED}

doc/customizing.txt

@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.137 $
+:Version: $Revision: 1.138 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -3503,12 +3503,19 @@ resolved. To achieve this:
    example, the existing "Show All" link in the "page" template (in the
    tracker's "html" directory) looks like this::
 
-     <a href="issue?:sort=-activity&:group=priority&:filter=status&:columns=id,activity,title,creator,assignedto,status&status=-1,1,2,3,4,5,6,7">Show All</a><br>
+     <a href="issue?:sort=-activity&:group=priority&:filter=status&
+        :columns=id,activity,title,creator,assignedto,status&
+        status=-1,1,2,3,4,5,6,7">Show All</a><br>
 
    modify it to add the "blockers" info to the URL (note, both the
    ":filter" *and* "blockers" values must be specified)::
 
-     <a href="issue?:sort=-activity&:group=priority&:filter=status,blockers&blockers=-1&:columns=id,activity,title,creator,assignedto,status&status=-1,1,2,3,4,5,6,7">Show All</a><br>
+     <a href="issue?:sort=-activity&:group=priority&:filter=status,blockers&
+        blockers=-1&:columns=id,activity,title,creator,assignedto,status&
+        status=-1,1,2,3,4,5,6,7">Show All</a><br>
+
+   :Note: the above examples are line-wrapped on the trailing & and should
+          be unwrapped.
 
 That's it. You should now be able to set blockers on your issues. Note
 that if you want to know whether an issue has any other issues dependent

doc/default.css

@@ -1,8 +1,8 @@
 /*
 :Author: David Goodger
 :Contact: [email protected]
-:date: $Date: 2004-04-18 23:12:06 $
-:version: $Revision: 1.12 $
+:date: $Date: 2004-06-09 00:25:32 $
+:version: $Revision: 1.13 $
 :copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
@@ -25,12 +25,23 @@ div.abstract p.topic-title {
   font-weight: bold ;
   text-align: center }
 
-div.attention, div.caution, div.danger, div.error, div.hint,
-div.important, div.note, div.tip, div.warning {
+div.attention, div.caution, div.danger, div.error,
+div.important, div.tip, div.warning {
   margin: 2em ;
   border: medium outset ;
   padding: 1em }
 
+div.hint, div.note {
+  font-size: 80%;
+  float: right;
+  width: 15em;
+  margin: 0.5em;
+  margin-left: 1em ;
+  border: solid #aaa;
+  background: #eee;
+  padding: 1em;
+}
+
 div.attention p.admonition-title, div.caution p.admonition-title,
 div.danger p.admonition-title, div.error p.admonition-title,
 div.warning p.admonition-title {

doc/developers.txt

@@ -2,11 +2,12 @@
 Developing Roundup
 ==================
 
-:Version: $Revision: 1.10 $
+:Version: $Revision: 1.11 $
 
-Note: the intended audience of this document is the developers of the core
-Roundup code. If you just wish to alter some behaviour of your Roundup
-installation, see `customising roundup`_.
+.. note::
+   The intended audience of this document is the developers of the core
+   Roundup code. If you just wish to alter some behaviour of your Roundup
+   installation, see `customising roundup`_.
 
 .. contents::
 

doc/installation.txt

@@ -2,9 +2,10 @@
 Installing Roundup
 ==================
 
-:Version: $Revision: 1.77 $
+:Version: 1.76
 
 .. contents::
+   :depth: 2
 
 
 Overview
@@ -49,8 +50,9 @@ Non-Python2.3 users may need to `install the "CSV" module`_.
 Install the "CSV" module
 ------------------------
 
-Note: CSV stands for Comma-Separated-Value. These files are used by all
-      manner of programs (eg. spreadsheets) to exchange data.
+.. hint::
+   CSV stands for Comma-Separated-Value. These files are used by all
+   manner of programs (eg. spreadsheets) to exchange data.
 
 The "CSV" module is required if you wish to import or export data in the
 tracker, or if you wish to use the online generic class editing facility.
@@ -88,7 +90,9 @@ folder names" check box is checked before you extract the files.
 Testing your Python
 -------------------
 
-Note: user of the Windows installer may not run these tests.
+.. note::
+   The Windows installer doesn't include the ``run_tests.py`` or ``demo.py``
+   scripts - you will need to download the source to use them.
 
 Once you've unpacked roundup's source, run ``python run_tests.py`` in the
 source directory and make sure there are no errors. If there are errors,
@@ -119,10 +123,11 @@ at so you may start playing. Three users will be set up:
 Installation
 ============
 
-:Note: Some systems, such as Debian and NetBSD, already have Roundup
-       installed. Try running the command "roundup-admin" with no arguments,
-       and if it runs you may skip the `Basic Installation Steps`_
-       below and go straight to `configuring your first tracker`_.
+.. note::
+    Some systems, such as Debian and NetBSD, already have Roundup
+    installed. Try running the command "roundup-admin" with no arguments,
+    and if it runs you may skip the `Basic Installation Steps`_
+    below and go straight to `configuring your first tracker`_.
 
 Set aside 15-30 minutes. Please make sure you're using a supported version of
 Python -- see `testing your python`_. There's several steps to follow in your
@@ -199,7 +204,7 @@ Configuring your first tracker
 
       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``. Note that the
+      ``TRACKER_WEB``, ``MAIL_DOMAIN`` and ``ADMIN_EMAIL``. 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
@@ -213,7 +218,7 @@ Configuring your first tracker
 
       The URL *must* end in a '/', or your web interface *will not work*.
       See `Customising Roundup`_ for details on configuration and schema
-      changes. Note that you may change any of the configuration after
+      changes. You may change any of the configuration after
       you've initialised the tracker - it's just better to have valid values
       for this stuff now.
 
@@ -325,7 +330,7 @@ A benefit of using the cgi-bin approach is that it's the easiest way to
 restrict access to your tracker to only use HTTPS. Access will be slower
 than through the `stand-alone web server`_ though.
 
-Note that if your Python isn't install as "python" then you'll need to edit
+If your Python isn't install as "python" then you'll need to edit
 the ``roundup.cgi`` script to fix the first line.
 
 If you're using IIS on a Windows platform, you'll need to run this command

doc/mysql.txt

@@ -2,7 +2,7 @@
 MySQL Backend
 =============
 
-:version: $Revision: 1.8 $
+:version: $Revision: 1.9 $
 
 This notes detail the MySQL backend for the Roundup issue tracker.
 
@@ -20,8 +20,10 @@ to install:
    ``roundup/backends/back_mysql.py`` file to enable DBD instead of InnoDB.
 2. Python MySQL interface - http://sourceforge.net/projects/mysql-python
 
-:Note: the InnoDB implementation has a bug that Roundup tickles. See
-       http://bugs.mysql.com/bug.php?id=1810
+.. note::
+   The InnoDB implementation has a bug__ that Roundup tickles. See
+
+__ http://bugs.mysql.com/bug.php?id=1810
 
 Running the MySQL tests
 =======================
@@ -43,7 +45,7 @@ this:
    you can modify MYSQL_* constants in the file test/test_db.py with 
    the correct values.
 
-Note that the MySQL database should not contain any tables. Tests will not 
+The MySQL database should not contain any tables. Tests will not 
 drop the database with existing data.
 
 

doc/upgrading.txt

@@ -1038,4 +1038,4 @@ copy.
 
 .. _`customisation documentation`: customizing.html
 .. _`security documentation`: security.html
-.. _`administration guide`: admin.html
+.. _`administration guide`: admin_guide.html

doc/user_guide.txt

@@ -2,13 +2,14 @@
 User Guide
 ==========
 
-:Version: $Revision: 1.27 $
+:Version: $Revision: 1.28 $
 
 .. contents::
 
-Note: this document will refer to *issues* as the primary store of
-information in the tracker. This is the default of the classic template,
-but may vary in any given installation.
+.. hint::
+   This document will refer to *issues* as the primary store of
+   information in the tracker. This is the default of the classic template,
+   but may vary in any given installation.
 
 
 Your Tracker in a Nutshell
@@ -187,9 +188,10 @@ at the same time they tried to.
 Web Interface
 =============
 
-Note: this document contains screenshots of the default look and feel.
-Your site may have a slightly (or very) different look, but the
-functionality will be very similar, and the concepts still hold.
+.. note::
+   This document contains screenshots of the default look and feel.
+   Your site may have a slightly (or very) different look, but the
+   functionality will be very similar, and the concepts still hold.
 
 The web interface is broken up into the following parts:
 
@@ -346,9 +348,9 @@ The subject line of the incoming message is examined to find one of:
 3. we default the item class and try some trickiness
 
 If the subject line contains a prefix in ``[square brackets]`` then
-we're looking at case 1 or 2 above. Note that any "re:" or "fwd:"
-prefixes are stripped off the subject line before we start looking for
-real information.
+we're looking at case 1 or 2 above. Any "re:" or "fwd:" prefixes are
+stripped off the subject line before we start looking for real
+information.
 
 If an item designator (class name and id number, for example
 ``issue123``) is found there, a new "msg" item is added to the
@@ -420,8 +422,8 @@ primary email addresses and their alternate addresses) then a new user
 will be created. The new user will have their username set to the "user"
 part of "user@domain" in their email address. Their password will be
 completely randomised, and they'll have to visit the web interface to
-have it changed. Note that some sites don't allow web access by users
-who register via email like this.
+have it changed. Some sites don't allow web access by users who register
+via email like this.
 
 
 E-Mail Message Content