doc fixes

git-svn-id: http://svn.roundup-tracker.org/svnroot/roundup/trunk@1632 57a73879-2fb5-44c3-a270-3262357dd7e2

diff --git a/doc/Makefile b/doc/Makefile
index eb1701ce06a2f852a64ea4f1ff5ef4de171a9b67..5322ca08a02c054a608c1c2067946295a0388aa2 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -1,5 +1,5 @@
 PYTHON = /usr/bin/python2
-STXTOHTML = stx2html
+STXTOHTML = rst2html
 
 SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \
     glossary.txt implementation.txt index.txt design.txt \

diff --git a/doc/customizing.txt b/doc/customizing.txt
index 761e48c990319be12109964bc07a19864f041365..3298e0104941d4efc85f43bed41595440a1329e5 100644 (file)
--- a/doc/customizing.txt
+++ b/doc/customizing.txt
@@ -2,7 +2,7 @@
 Customising Roundup
 ===================
 
-:Version: $Revision: 1.79 $
+:Version: $Revision: 1.80 $
 
 .. This document borrows from the ZopeBook section on ZPT. The original is at:
    http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -120,7 +120,8 @@ The configuration variables available are:
  Additional text to include in the "name" part of the ``From:`` address used
  in nosy messages. If the sending user is "Foo Bar", the ``From:`` line is
  usually::
-     "Foo Bar" <issue_tracker@tracker.example>
+
+    "Foo Bar" <issue_tracker@tracker.example>
 
  the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so::
 
@@ -2918,7 +2919,7 @@ is resolved. To achieve this:
                     priority=Link("priority"), status=Link("status"))
 
 2. Add the new "blockers" property to the issue.item edit page, using
-   something like:
+   something like::
 
     <th nowrap>Waiting On</th>
     <td>

diff --git a/doc/installation.txt b/doc/installation.txt
index 3d8833bf8462dd84092262bb933cbb09986eda55..0276111d775fc3fe9834af189ebd15ef1058a78e 100644 (file)
--- a/doc/installation.txt
+++ b/doc/installation.txt
@@ -2,7 +2,7 @@
 Installing Roundup
 ==================
 
-:Version: $Revision: 1.41 $
+:Version: $Revision: 1.42 $
 
 .. contents::
 
@@ -215,7 +215,7 @@ There's several to choose from, each with benefits and limitations:
 **mysql**
   Backend for popular RDBMS MySQL. This backend uses MySQL's Berkeley DB
   (transaction safe) table format, so with small amount of data it may be a
-  bit slower than *dbm backends (due to mysql layer's overhead). However with
+  bit slower than \*dbm backends (due to mysql layer's overhead). However with
   lots of data mysql may perform better (due to query optimisation). No actual
   serious benchmarks were made though. For more info on installation of this
   backend see doc/mysql.txt. 

diff --git a/doc/roundup-mailgw.1 b/doc/roundup-mailgw.1
index b0cf288b6715f3fb41c5f7e0e371aacbd5505d1b..593cd47def25bf77cdc664f9b641b9a299d1cc61 100644 (file)
--- a/doc/roundup-mailgw.1
+++ b/doc/roundup-mailgw.1
@@ -47,6 +47,10 @@ The username and password may be omitted:
 .br
 are both valid. The username and/or password will be prompted for if
 not supplied on the command-line.
+
+\fBAPOP\fP
+Same as POP, but using Authenticated POP:
+ \fIapop username:password@server\fP
 .SH AUTHOR
 This manpage was written by Bastian Kleineidam
 <calvin@debian.org> for the Debian distribution of roundup.

diff --git a/doc/upgrading.txt b/doc/upgrading.txt
index 9ba63c766921b44b20ea0bcc9b7916f9c1019365..a3344700a7a860b2852853b949d4c9503a9eb2db 100644 (file)
--- a/doc/upgrading.txt
+++ b/doc/upgrading.txt
@@ -81,12 +81,12 @@ name:confirm -> :confirm:name
                     timezone=String())
   
   And second - html interface. Add following lines to
-  $TRACKER_HOME/html/user.item template:
+  $TRACKER_HOME/html/user.item template::
   
-        <tr>
-         <th>Timezone</th>
-         <td tal:content="structure context/timezone/field">timezone</td>
-        </tr>
+     <tr>
+      <th>Timezone</th>
+      <td tal:content="structure context/timezone/field">timezone</td>
+     </tr>
 
   After that all users should be able to provide their timezone information.
   Timezone should be a positive or negative integer - offset from GMT.

diff --git a/doc/user_guide.txt b/doc/user_guide.txt
index 49ca3a3fa9d639575157a999c4bc17d4358edc6f..0117c550134cfe77c6126c232cb62f1db9c85554 100644 (file)
--- a/doc/user_guide.txt
+++ b/doc/user_guide.txt
@@ -2,7 +2,7 @@
 User Guide
 ==========
 
-:Version: $Revision: 1.14 $
+:Version: $Revision: 1.15 $
 
 .. contents::
 
@@ -108,14 +108,17 @@ XXX: some information about how searching works
 Some fields in the search page (e.g. "Activity" or "Creation date") accept
 ranges of dates. You can specify range of dates in one of two formats:
 
-       1. Native english syntax: 
-               [[From] <value>][ To <value>]
-          Keywords "From" and "To" are case insensitive. Keyword "From" is optional.
+1. Native english syntax::
 
-       2. "Geek" syntax:
-               [<value>][; <value>]
+    [[From] <value>][ To <value>]
 
-Either first or second <value> can be omitted in both syntaxes.
+   Keywords "From" and "To" are case insensitive. Keyword "From" is optional.
+
+2. "Geek" syntax::
+
+    [<value>][; <value>]
+
+Either first or second ``<value>`` can be omitted in both syntaxes.
 
 For example:
 
@@ -377,15 +380,22 @@ POP:
  In the third case, the gateway reads all messages from the POP server
  specified and submits each in turn to the roundup.mailgw module. The
  server is specified as::
+
     pop username:password@server
 
  The username and password may be omitted::
+
     pop username@server
     pop server
 
  are both valid. The username and/or password will be prompted for if
  not supplied on the command-line.
 
+APOP:
+ Same as POP, but using Authenticated POP::
+
+    apop username:password@server
+
 
 Command Line Tool
 =================