Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 1615:7b680b906417
more user docco
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Thu, 24 Apr 2003 07:36:37 +0000 |
| parents | cc96bf971b33 |
| children | b9c1226cb600 |
comparison
equal
deleted
inserted
replaced
| 1614:137b26174a0c | 1615:7b680b906417 |
|---|---|
| 1 ========== | 1 ========== |
| 2 User Guide | 2 User Guide |
| 3 ========== | 3 ========== |
| 4 | 4 |
| 5 :Version: $Revision: 1.21 $ | 5 :Version: $Revision: 1.22 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 Note: this document will refer to *issues* as the primary store of information | 9 Note: this document will refer to *issues* as the primary store of information |
| 10 in the tracker. This is the default of the classic template, bubt may vary in | 10 in the tracker. This is the default of the classic template, bubt may vary in |
| 22 item class. To identify a particular issue or user, we combine the class with | 22 item class. To identify a particular issue or user, we combine the class with |
| 23 the number to create a unique label, so that user 1 (who, incidentally, is | 23 the number to create a unique label, so that user 1 (who, incidentally, is |
| 24 *always* the "admin" user) is referred to as "user1". Issue number 315 is | 24 *always* the "admin" user) is referred to as "user1". Issue number 315 is |
| 25 referred to as "issue315". We call that label the item's *designator*. | 25 referred to as "issue315". We call that label the item's *designator*. |
| 26 | 26 |
| 27 | |
| 27 Accessing the Tracker | 28 Accessing the Tracker |
| 28 --------------------- | 29 --------------------- |
| 29 | 30 |
| 30 You may access your tracker through one of three ways: | 31 You may access your tracker through one of three ways: |
| 31 | 32 |
| 33 2. through the `e-mail gateway`_, or | 34 2. through the `e-mail gateway`_, or |
| 34 3. using the `command line tool`_. | 35 3. using the `command line tool`_. |
| 35 | 36 |
| 36 The last is usually only used by administrators. Most users will use the web | 37 The last is usually only used by administrators. Most users will use the web |
| 37 and email interfaces. All three are explained below. | 38 and email interfaces. All three are explained below. |
| 39 | |
| 40 | |
| 41 Issue life cycles in Roundup | |
| 42 ---------------------------- | |
| 43 | |
| 44 New issues may be submitted via the web or email. | |
| 45 | |
| 46 By default, the issue will have the status "unread". If another message is | |
| 47 received for the issue, its status will change to "chatting". | |
| 48 | |
| 49 The "home" page for a tracker will generally display all issues which are | |
| 50 not "resolved. | |
| 51 | |
| 52 If an issue is closed, and a new message is received then it'll be reopened | |
| 53 to the state of "chatting". | |
| 38 | 54 |
| 39 | 55 |
| 40 Entering values in your Tracker | 56 Entering values in your Tracker |
| 41 ------------------------------- | 57 ------------------------------- |
| 42 | 58 |
| 276 ============== | 292 ============== |
| 277 | 293 |
| 278 E-mail sent to Roundup is examined for several pieces of information: | 294 E-mail sent to Roundup is examined for several pieces of information: |
| 279 | 295 |
| 280 1. `subject-line information`_ identifying the purpose of the e-mail | 296 1. `subject-line information`_ identifying the purpose of the e-mail |
| 281 2. `e-mail message content`_ which is to be extracted | 297 2. `sender identification`_ using the sender of the message |
| 282 3. e-mail attachments which should be associated with the message | 298 3. `e-mail message content`_ which is to be extracted |
| 299 4. e-mail attachments which should be associated with the message | |
| 283 | 300 |
| 284 Subject-line information | 301 Subject-line information |
| 285 ------------------------ | 302 ------------------------ |
| 286 | 303 |
| 287 The subject line of the incoming message is examined to find one of: | 304 The subject line of the incoming message is examined to find one of: |
| 348 | 365 |
| 349 **reopening of resolved issues** | 366 **reopening of resolved issues** |
| 350 When a message is is received for a resolved issue, the issue status is | 367 When a message is is received for a resolved issue, the issue status is |
| 351 automatically reset to "chatting" to indicate new information has been | 368 automatically reset to "chatting" to indicate new information has been |
| 352 received. | 369 received. |
| 370 | |
| 371 | |
| 372 Sender identification | |
| 373 --------------------- | |
| 374 | |
| 375 If the sender of an email is unknown to Roundup (looking up both user | |
| 376 primary email addresses and their alternate addresses) then a new user will | |
| 377 be created. The new user will have their username set to the "user" part of | |
| 378 "user@domain" in their email address. Their password will be completely | |
| 379 randomised, and they'll have to visit the web interface to have it | |
| 380 changed. Note that some sites don't allow web access by users who register | |
| 381 via email like this. | |
| 353 | 382 |
| 354 | 383 |
| 355 E-Mail Message Content | 384 E-Mail Message Content |
| 356 ---------------------- | 385 ---------------------- |
| 357 | 386 |