Skip to content

Commit 5b19eba

Browse files
author
Richard Jones
committed
doc fixes
1 parent 472670b commit 5b19eba

File tree

6 files changed

+33
-18
lines changed

6 files changed

+33
-18
lines changed

doc/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
PYTHON = /usr/bin/python2
2-
STXTOHTML = stx2html
2+
STXTOHTML = rst2html
33

44
SOURCE = announcement.txt customizing.txt developers.txt FAQ.txt features.txt \
55
glossary.txt implementation.txt index.txt design.txt \

doc/customizing.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Customising Roundup
33
===================
44

5-
:Version: $Revision: 1.79 $
5+
:Version: $Revision: 1.80 $
66

77
.. This document borrows from the ZopeBook section on ZPT. The original is at:
88
http://www.zope.org/Documentation/Books/ZopeBook/current/ZPT.stx
@@ -120,7 +120,8 @@ The configuration variables available are:
120120
Additional text to include in the "name" part of the ``From:`` address used
121121
in nosy messages. If the sending user is "Foo Bar", the ``From:`` line is
122122
usually::
123-
"Foo Bar" <[email protected]>
123+
124+
"Foo Bar" <[email protected]>
124125

125126
the EMAIL_FROM_TAG goes inside the "Foo Bar" quotes like so::
126127

@@ -2918,7 +2919,7 @@ is resolved. To achieve this:
29182919
priority=Link("priority"), status=Link("status"))
29192920

29202921
2. Add the new "blockers" property to the issue.item edit page, using
2921-
something like:
2922+
something like::
29222923

29232924
<th nowrap>Waiting On</th>
29242925
<td>

doc/installation.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Installing Roundup
33
==================
44

5-
:Version: $Revision: 1.41 $
5+
:Version: $Revision: 1.42 $
66

77
.. contents::
88

@@ -215,7 +215,7 @@ There's several to choose from, each with benefits and limitations:
215215
**mysql**
216216
Backend for popular RDBMS MySQL. This backend uses MySQL's Berkeley DB
217217
(transaction safe) table format, so with small amount of data it may be a
218-
bit slower than *dbm backends (due to mysql layer's overhead). However with
218+
bit slower than \*dbm backends (due to mysql layer's overhead). However with
219219
lots of data mysql may perform better (due to query optimisation). No actual
220220
serious benchmarks were made though. For more info on installation of this
221221
backend see doc/mysql.txt.

doc/roundup-mailgw.1

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,10 @@ The username and password may be omitted:
4747
.br
4848
are both valid. The username and/or password will be prompted for if
4949
not supplied on the command-line.
50+
51+
\fBAPOP\fP
52+
Same as POP, but using Authenticated POP:
53+
\fIapop username:password@server\fP
5054
.SH AUTHOR
5155
This manpage was written by Bastian Kleineidam
5256
<[email protected]> for the Debian distribution of roundup.

doc/upgrading.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,12 @@ name:confirm -> :confirm:name
8181
timezone=String())
8282

8383
And second - html interface. Add following lines to
84-
$TRACKER_HOME/html/user.item template:
84+
$TRACKER_HOME/html/user.item template::
8585

86-
<tr>
87-
<th>Timezone</th>
88-
<td tal:content="structure context/timezone/field">timezone</td>
89-
</tr>
86+
<tr>
87+
<th>Timezone</th>
88+
<td tal:content="structure context/timezone/field">timezone</td>
89+
</tr>
9090

9191
After that all users should be able to provide their timezone information.
9292
Timezone should be a positive or negative integer - offset from GMT.

doc/user_guide.txt

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
User Guide
33
==========
44

5-
:Version: $Revision: 1.14 $
5+
:Version: $Revision: 1.15 $
66

77
.. contents::
88

@@ -108,14 +108,17 @@ XXX: some information about how searching works
108108
Some fields in the search page (e.g. "Activity" or "Creation date") accept
109109
ranges of dates. You can specify range of dates in one of two formats:
110110

111-
1. Native english syntax:
112-
[[From] <value>][ To <value>]
113-
Keywords "From" and "To" are case insensitive. Keyword "From" is optional.
111+
1. Native english syntax::
114112

115-
2. "Geek" syntax:
116-
[<value>][; <value>]
113+
[[From] <value>][ To <value>]
117114

118-
Either first or second <value> can be omitted in both syntaxes.
115+
Keywords "From" and "To" are case insensitive. Keyword "From" is optional.
116+
117+
2. "Geek" syntax::
118+
119+
[<value>][; <value>]
120+
121+
Either first or second ``<value>`` can be omitted in both syntaxes.
119122

120123
For example:
121124

@@ -377,15 +380,22 @@ POP:
377380
In the third case, the gateway reads all messages from the POP server
378381
specified and submits each in turn to the roundup.mailgw module. The
379382
server is specified as::
383+
380384
pop username:password@server
381385

382386
The username and password may be omitted::
387+
383388
pop username@server
384389
pop server
385390

386391
are both valid. The username and/or password will be prompted for if
387392
not supplied on the command-line.
388393

394+
APOP:
395+
Same as POP, but using Authenticated POP::
396+
397+
apop username:password@server
398+
389399

390400
Command Line Tool
391401
=================

0 commit comments

Comments
 (0)