Skip to content

Commit 81c1ec9

Browse files
author
Richard Jones
committed
more explanation
1 parent 8e5851c commit 81c1ec9

File tree

1 file changed

+24
-15
lines changed

1 file changed

+24
-15
lines changed

doc/user_guide.txt

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

5-
:Version: $Revision: 1.31 $
5+
:Version: $Revision: 1.32 $
66

77
.. contents::
88

@@ -44,19 +44,19 @@ You may access your tracker through one of three ways:
4444
3. using the `command line tool`_.
4545

4646
The last is usually only used by administrators. Most users will use the
47-
web and email interfaces. All three are explained below.
47+
web and e-mail interfaces. All three are explained below.
4848

4949

5050
Issue life cycles in Roundup
5151
----------------------------
5252

53-
New issues may be submitted via the web or email.
53+
New issues may be submitted via the web or e-mail.
5454

5555
By default, the issue will have the status "unread". If another message
5656
is received for the issue, its status will change to "chatting".
5757

5858
The "home" page for a tracker will generally display all issues which
59-
are not "resolved.
59+
are not "resolved".
6060

6161
If an issue is closed, and a new message is received then it'll be
6262
reopened to the state of "chatting".
@@ -67,7 +67,7 @@ Entering values in your Tracker
6767

6868
All interfaces to your tracker use the same format for entering values.
6969
This means the web interface for entering a new issue, the web interface
70-
for searching issues, the email interface and even the command-line
70+
for searching issues, the e-mail interface and even the command-line
7171
administration tool.
7272

7373

@@ -107,8 +107,8 @@ not set. For example, the following searches on the issues:
107107
match issues that are assigned to users 2, 3 or 40.
108108
``topic=user interface``
109109
match issues with the keyword "user interface" in their topic list
110-
``topic=web interface,email interface``
111-
match issues with the keyword "web interface" or "email interface" in
110+
``topic=web interface,e-mail interface``
111+
match issues with the keyword "web interface" or "e-mail interface" in
112112
their topic list
113113
``topic=-1``
114114
match issues with no topics set
@@ -354,14 +354,23 @@ Any number of new Permissions and Roles may be created as described in
354354
the customisation documentation. Examples of new access controls are:
355355

356356
- only managers may sign off issues as complete
357-
- don't give users who register through email web access
357+
- don't give users who register through e-mail web access
358358
- let some users edit the details of all users
359359

360360

361361
E-Mail Gateway
362362
==============
363363

364-
E-mail sent to Roundup is examined for several pieces of information:
364+
Roundup trackers may be used to facilitate e-mail conversations around
365+
issues. The "nosy" list attached to each issue indicates the users who
366+
should receive e-mail when messages are added to the issue.
367+
368+
When e-mail comes into a tracker that identifies an issue in the subject
369+
line, the content of the e-mail is attached to the issue.
370+
371+
You may even create new issues from e-mail messages.
372+
373+
E-mail sent to a tracker is examined for several pieces of information:
365374

366375
1. `subject-line information`_ identifying the purpose of the e-mail
367376
2. `sender identification`_ using the sender of the message
@@ -448,13 +457,13 @@ Automatic Properties
448457
Sender identification
449458
---------------------
450459

451-
If the sender of an email is unknown to Roundup (looking up both user
452-
primary email addresses and their alternate addresses) then a new user
460+
If the sender of an e-mail is unknown to Roundup (looking up both user
461+
primary e-mail addresses and their alternate addresses) then a new user
453462
will be created. The new user will have their username set to the "user"
454-
part of "user@domain" in their email address. Their password will be
463+
part of "user@domain" in their e-mail address. Their password will be
455464
completely randomised, and they'll have to visit the web interface to
456465
have it changed. Some sites don't allow web access by users who register
457-
via email like this.
466+
via e-mail like this.
458467

459468

460469
E-Mail Message Content
@@ -553,9 +562,9 @@ not specified is msg, but the other classes: issue, file, user can also
553562
be used. The -S or --set options uses the same
554563
property=value[;property=value] notation accepted by the command line
555564
roundup command or the commands that can be given on the Subject line of
556-
an email message.
565+
an e-mail message.
557566

558-
It can let you set the type of the message on a per email address basis.
567+
It can let you set the type of the message on a per e-mail address basis.
559568

560569
PIPE:
561570
In the first case, the mail gateway reads a single message from the

0 commit comments

Comments
 (0)