Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 2407:ef226254ef46 maint-0.7
some more documentation work
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Wed, 09 Jun 2004 00:11:49 +0000 |
| parents | f76d1642014a |
| children | fd392d8cbfe1 |
comparison
equal
deleted
inserted
replaced
| 2406:3f66eb446aa4 | 2407:ef226254ef46 |
|---|---|
| 1 ========== | 1 ========== |
| 2 User Guide | 2 User Guide |
| 3 ========== | 3 ========== |
| 4 | 4 |
| 5 :Version: $Revision: 1.27 $ | 5 :Version: 1.27 |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 Note: this document will refer to *issues* as the primary store of | 9 .. hint:: |
| 10 information in the tracker. This is the default of the classic template, | 10 This document will refer to *issues* as the primary store of |
| 11 but may vary in any given installation. | 11 information in the tracker. This is the default of the classic template, |
| 12 but may vary in any given installation. | |
| 12 | 13 |
| 13 | 14 |
| 14 Your Tracker in a Nutshell | 15 Your Tracker in a Nutshell |
| 15 ========================== | 16 ========================== |
| 16 | 17 |
| 185 | 186 |
| 186 | 187 |
| 187 Web Interface | 188 Web Interface |
| 188 ============= | 189 ============= |
| 189 | 190 |
| 190 Note: this document contains screenshots of the default look and feel. | 191 .. note:: |
| 191 Your site may have a slightly (or very) different look, but the | 192 This document contains screenshots of the default look and feel. |
| 192 functionality will be very similar, and the concepts still hold. | 193 Your site may have a slightly (or very) different look, but the |
| 194 functionality will be very similar, and the concepts still hold. | |
| 193 | 195 |
| 194 The web interface is broken up into the following parts: | 196 The web interface is broken up into the following parts: |
| 195 | 197 |
| 196 1. `lists of items`_, | 198 1. `lists of items`_, |
| 197 2. `display, edit or entry of an item`_, and | 199 2. `display, edit or entry of an item`_, and |
| 344 1. the item that the message is responding to, | 346 1. the item that the message is responding to, |
| 345 2. the type of item the message should create, or | 347 2. the type of item the message should create, or |
| 346 3. we default the item class and try some trickiness | 348 3. we default the item class and try some trickiness |
| 347 | 349 |
| 348 If the subject line contains a prefix in ``[square brackets]`` then | 350 If the subject line contains a prefix in ``[square brackets]`` then |
| 349 we're looking at case 1 or 2 above. Note that any "re:" or "fwd:" | 351 we're looking at case 1 or 2 above. Any "re:" or "fwd:" prefixes are |
| 350 prefixes are stripped off the subject line before we start looking for | 352 stripped off the subject line before we start looking for real |
| 351 real information. | 353 information. |
| 352 | 354 |
| 353 If an item designator (class name and id number, for example | 355 If an item designator (class name and id number, for example |
| 354 ``issue123``) is found there, a new "msg" item is added to the | 356 ``issue123``) is found there, a new "msg" item is added to the |
| 355 "messages" property for that item, and any new "file" items are added to | 357 "messages" property for that item, and any new "file" items are added to |
| 356 the "files" property for the item. | 358 the "files" property for the item. |
| 418 If the sender of an email is unknown to Roundup (looking up both user | 420 If the sender of an email is unknown to Roundup (looking up both user |
| 419 primary email addresses and their alternate addresses) then a new user | 421 primary email addresses and their alternate addresses) then a new user |
| 420 will be created. The new user will have their username set to the "user" | 422 will be created. The new user will have their username set to the "user" |
| 421 part of "user@domain" in their email address. Their password will be | 423 part of "user@domain" in their email address. Their password will be |
| 422 completely randomised, and they'll have to visit the web interface to | 424 completely randomised, and they'll have to visit the web interface to |
| 423 have it changed. Note that some sites don't allow web access by users | 425 have it changed. Some sites don't allow web access by users who register |
| 424 who register via email like this. | 426 via email like this. |
| 425 | 427 |
| 426 | 428 |
| 427 E-Mail Message Content | 429 E-Mail Message Content |
| 428 ---------------------- | 430 ---------------------- |
| 429 | 431 |