Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 1228:c9f37630cf76
doc
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Thu, 26 Sep 2002 06:41:46 +0000 |
| parents | cd58a8603424 |
| children | a28dfdb6c9a5 |
comparison
equal
deleted
inserted
replaced
| 1227:92d8e1aad2e9 | 1228:c9f37630cf76 |
|---|---|
| 1 ========== | 1 ========== |
| 2 User Guide | 2 User Guide |
| 3 ========== | 3 ========== |
| 4 | 4 |
| 5 :Version: $Revision: 1.8 $ | 5 :Version: $Revision: 1.9 $ |
| 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 |
| 77 | 77 |
| 78 .. img: images/my_details.png | 78 .. img: images/my_details.png |
| 79 | 79 |
| 80 Note the new information on this page - the history. | 80 Note the new information on this page - the history. |
| 81 | 81 |
| 82 | |
| 83 Display, edit or entry of an item | |
| 84 --------------------------------- | |
| 85 | |
| 82 Create a new issue with "create new" under the issue subheading. This will | 86 Create a new issue with "create new" under the issue subheading. This will |
| 83 take you to: | 87 take you to: |
| 84 | 88 |
| 85 .. img: images/new_issue.png | 89 .. img: images/new_issue.png |
| 86 | 90 |
| 91 The `nosy list`_ is explained below. | |
| 87 Enter some information and click "submit new entry" and you'll be rewarded | 92 Enter some information and click "submit new entry" and you'll be rewarded |
| 88 with: | 93 with: |
| 89 | 94 |
| 90 .. img: images/new_issue_created.png | 95 .. img: images/new_issue_created.png |
| 91 | 96 |
| 92 or, if you don't enter all the required information (or some other error | 97 or, if you don't enter all the required information (or some other error |
| 93 occurs) you'll get something like: | 98 occurs) you'll get something like: |
| 94 | 99 |
| 95 .. img: images/new_issue_error.png | 100 .. img: images/new_issue_error.png |
| 96 | 101 |
| 97 Searching | 102 |
| 98 --------- | 103 Searching Page |
| 99 | 104 -------------- |
| 100 TODO: some information about how searching works | 105 |
| 106 XXX: some information about how searching works | |
| 101 | 107 |
| 102 | 108 |
| 103 Under the covers | 109 Under the covers |
| 104 ---------------- | 110 ---------------- |
| 105 | 111 |
| 121 ========== ============================================================= | 127 ========== ============================================================= |
| 122 | 128 |
| 123 Access Controls | 129 Access Controls |
| 124 --------------- | 130 --------------- |
| 125 | 131 |
| 126 | 132 XXX |
| 127 Managing Issues | |
| 128 --------------- | |
| 129 | |
| 130 TODO: some mention of how the various widgets work | |
| 131 | 133 |
| 132 | 134 |
| 133 E-Mail Gateway | 135 E-Mail Gateway |
| 134 ============== | 136 ============== |
| 135 | 137 |
| 256 | 258 |
| 257 | 259 |
| 258 Nosy List | 260 Nosy List |
| 259 ~~~~~~~~~ | 261 ~~~~~~~~~ |
| 260 | 262 |
| 261 The nosy list watches for additions to the "messages" property of items. | 263 Roundup watches for additions to the "messages" property of items. |
| 264 | |
| 262 When a new message is added, it is sent to all the users | 265 When a new message is added, it is sent to all the users |
| 263 on the "nosy" list for the item that are not already on the "recipients" list | 266 on the "nosy" list for the item that are not already on the "recipients" list |
| 264 of the message. Those users are then appended to the "recipients" property on | 267 of the message. Those users are then appended to the "recipients" property on |
| 265 the message, so multiple copies of a message are never sent to the same user. | 268 the message, so multiple copies of a message are never sent to the same user. |
| 266 The journal recorded by the hyperdatabase on the "recipients" property then | 269 The journal recorded by the hyperdatabase on the "recipients" property then |
