Mercurial > p > roundup > code
changeset 1560:3f2e516b8de3
doc fixes
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Wed, 26 Mar 2003 06:17:16 +0000 |
| parents | 6bfb9c9de03c |
| children | cf5a5357a7ea |
| files | doc/Makefile doc/customizing.txt doc/installation.txt doc/roundup-mailgw.1 doc/upgrading.txt doc/user_guide.txt |
| diffstat | 6 files changed, 33 insertions(+), 18 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/Makefile Wed Mar 26 06:03:58 2003 +0000 +++ b/doc/Makefile Wed Mar 26 06:17:16 2003 +0000 @@ -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 \
--- a/doc/customizing.txt Wed Mar 26 06:03:58 2003 +0000 +++ b/doc/customizing.txt Wed Mar 26 06:17:16 2003 +0000 @@ -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 @@ 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 @@ 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>
--- a/doc/installation.txt Wed Mar 26 06:03:58 2003 +0000 +++ b/doc/installation.txt Wed Mar 26 06:17:16 2003 +0000 @@ -2,7 +2,7 @@ Installing Roundup ================== -:Version: $Revision: 1.41 $ +:Version: $Revision: 1.42 $ .. contents:: @@ -215,7 +215,7 @@ **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.
--- a/doc/roundup-mailgw.1 Wed Mar 26 06:03:58 2003 +0000 +++ b/doc/roundup-mailgw.1 Wed Mar 26 06:17:16 2003 +0000 @@ -47,6 +47,10 @@ .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.
--- a/doc/upgrading.txt Wed Mar 26 06:03:58 2003 +0000 +++ b/doc/upgrading.txt Wed Mar 26 06:17:16 2003 +0000 @@ -81,12 +81,12 @@ 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.
--- a/doc/user_guide.txt Wed Mar 26 06:03:58 2003 +0000 +++ b/doc/user_guide.txt Wed Mar 26 06:17:16 2003 +0000 @@ -2,7 +2,7 @@ User Guide ========== -:Version: $Revision: 1.14 $ +:Version: $Revision: 1.15 $ .. contents:: @@ -108,14 +108,17 @@ 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:: + + [[From] <value>][ To <value>] + + Keywords "From" and "To" are case insensitive. Keyword "From" is optional. - 2. "Geek" syntax: - [<value>][; <value>] +2. "Geek" syntax:: -Either first or second <value> can be omitted in both syntaxes. + [<value>][; <value>] + +Either first or second ``<value>`` can be omitted in both syntaxes. For example: @@ -377,15 +380,22 @@ 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 =================