Mercurial > p > roundup > code
annotate doc/user_guide.txt @ 1204:b862bbf2067a
Replaced the content() callback ickiness with Page Template macro usage
changed the default CSS style to be less offensive to some ;)
better handling of Page Template compilation errors
removed dependency on ComputedAttribute
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Wed, 25 Sep 2002 02:10:25 +0000 |
| parents | cd58a8603424 |
| children | c9f37630cf76 |
| rev | line source |
|---|---|
|
688
b38f4f95bffd
More doc tweaks
Richard Jones <richard@users.sourceforge.net>
parents:
686
diff
changeset
|
1 ========== |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
2 User Guide |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
3 ========== |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
4 |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
5 :Version: $Revision: 1.8 $ |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
6 |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
7 .. contents:: |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
8 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
9 Note: this document will refer to *issues* as the primary store of information |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
10 in the tracker. This is the default of the classic template, bubt may vary in |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
11 any given installation. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
12 |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
13 Your Tracker in a Nutshell |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
14 ========================== |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
15 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
16 Your tracker holds information about issues in bundles we call *items*. An |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
17 item may be an *issue* (a bug or feature request) or a *user*. The issue-ness or |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
18 user-ness is called the item's *class*. So, for bug reports and features, the |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
19 class is "issue", and for users the class is "user". |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
20 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
21 Each item in the tracker has an id number that identifies it along with its |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
22 item class. To identify a particular issue or user, we combine the class with |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
23 the number to create a unique label, so that user 1 (who, incidentally, is |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
24 *always* the "admin" user) is referred to as "user1". Issue number 315 is |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
25 referred to as "issue315". We call that label the item's *designator*. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
26 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
27 Accessing the Tracker |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
28 --------------------- |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
29 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
30 You may access your tracker through one of three ways: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
31 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
32 1. through the `web interface`_, |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
33 2. through the `e-mail gateway`_, or |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
34 3. using the `command line tool`_. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
35 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
36 The last is usually only used by administrators. Most users will use the web |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
37 and email interfaces. All three are explained below. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
38 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
39 |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
40 Web Interface |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
41 ============= |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
42 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
43 Note: this document contains screenshots of the default look and feel. Your |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
44 site may have a slightly (or very) different look, but the functionality will |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
45 be very similar, and the concepts still hold. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
46 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
47 The web interface is broken up into the following parts: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
48 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
49 1. `lists of items`_, |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
50 2. `display, edit or entry of an item`_, and |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
51 3. `searching page`_. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
52 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
53 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
54 Lists of Items |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
55 -------------- |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
56 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
57 The first thing you'll see when you log into Roundup will be a list of open |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
58 (ie. not resolved) issues. This list has been generated by a bunch of controls |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
59 `under the covers`_ but for now, you can see something like: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
60 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
61 .. img: images/index_logged_out.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
62 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
63 The screen is divided up into three sections: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
64 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
65 .. img: images/page_layout.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
66 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
67 you may either register or log in. Registration takes you to: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
68 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
69 .. img: images/registration.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
70 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
71 Once you're logged in, the screen changes slightly to: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
72 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
73 .. img: images/index_logged_in.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
74 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
75 Note that the sidebar menu has changed slightly, so you can now get to your |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
76 "My Details" page: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
77 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
78 .. img: images/my_details.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
79 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
80 Note the new information on this page - the history. |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
81 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
82 Create a new issue with "create new" under the issue subheading. This will |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
83 take you to: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
84 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
85 .. img: images/new_issue.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
86 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
87 Enter some information and click "submit new entry" and you'll be rewarded |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
88 with: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
89 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
90 .. img: images/new_issue_created.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
91 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
92 or, if you don't enter all the required information (or some other error |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
93 occurs) you'll get something like: |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
94 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
95 .. img: images/new_issue_error.png |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
96 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
97 Searching |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
98 --------- |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
99 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
100 TODO: some information about how searching works |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
101 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
102 |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
103 Under the covers |
|
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
104 ---------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
105 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
106 Index views may be modified by the following arguments: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
107 |
| 1098 | 108 ========== ============================================================= |
| 109 Argument Description | |
| 110 ========== ============================================================= | |
| 111 :sort sort by prop name, optionally preceeded with '-' | |
| 112 to give descending or nothing for ascending sorting. | |
| 113 :group group by prop name, optionally preceeded with '-' or | |
| 114 to sort in descending or nothing for ascending order. | |
| 115 :filter selects which props should be displayed in the filter | |
| 116 section. Default is all. | |
| 117 :columns selects the columns that should be displayed. | |
| 118 Default is all. | |
| 119 propname selects the values the item properties given by propname | |
| 120 must have (very basic search/filter). | |
| 121 ========== ============================================================= | |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
122 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
123 Access Controls |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
124 --------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
125 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
126 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
127 Managing Issues |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
128 --------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
129 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
130 TODO: some mention of how the various widgets work |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
131 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
132 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
133 E-Mail Gateway |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
134 ============== |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
135 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
136 E-mail sent to Roundup is examined for several pieces of information: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
137 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
138 1. `subject-line information`_ identifying the purpose of the e-mail |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
139 2. `e-mail message content`_ which is to be extracted |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
140 3. e-mail attachments which should be associated with the message |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
141 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
142 Subject-line information |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
143 ------------------------ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
144 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
145 The subject line of the incoming message is examined to find one of: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
146 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
147 1. the item that the message is responding to, |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
148 2. the type of item the message should create, or |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
149 3. we default the item class and try some trickiness |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
150 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
151 If the subject line contains a prefix in ``[square brackets]`` then we're |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
152 looking at case 1 or 2 above. Note that any "re:" or "fwd:" prefixes are |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
153 stripped off the subject line before we start looking for real information. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
154 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
155 If an item designator (class name and id number, for example ``issue123``) |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
156 is found there, a new "msg" item is added to the "messages" property for |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
157 that item, and any new "file" items are added to the "files" property for |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
158 the item. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
159 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
160 If just an item class name is found there, we attempt to create a new item of |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
161 that class with its "messages" property initialized to contain the new "msg" |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
162 item and its "files" property initialized to contain any new "file" items. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
163 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
164 The third case above - where no ``[information]`` is provided, the tracker's |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
165 ``MAIL_DEFAULT_CLASS`` configuration variable defines what class of item |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
166 the message relates to. We try to match the subject line to an existing |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
167 item of the default class, and if there's a match, the message is related to |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
168 that matched item. If not, then a new item of the default class is created. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
169 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
170 Setting Properties |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
171 ~~~~~~~~~~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
172 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
173 The e-mail interface also provides a simple way to set properties on items. At |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
174 the end of the subject line, propname=value pairs can be specified in square |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
175 brackets, using the same conventions as for the roundup set shell command. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
176 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
177 For example, |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
178 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
179 - setting the priority of an issue:: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
180 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
181 Subject: Re: [issue1] the coffee machine is broken! [priority=urgent] |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
182 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
183 - adding yourself to a nosy list:: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
184 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
185 Subject: Re: [issue2] we're out of widgets [nosy=+richard] |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
186 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
187 - setting the nosy list to just you:: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
188 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
189 Subject: Re: [issue2] we're out of widgets [nosy=richard] |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
190 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
191 - removing yourself from a nosy list:: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
192 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
193 Subject: Re: [issue2] we're out of widgets [nosy=-richard] |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
194 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
195 In all cases, the message relates to issue 2. The ``Re:`` prefix is stripped |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
196 off. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
197 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
198 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
199 E-Mail Message Content |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
200 ---------------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
201 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
202 Roundup only associates plain text (MIME type ``text/plain``) as messages for |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
203 items. Any other parts of a message are associated as downloadable files. If |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
204 no plain text part is found, the message is rejected. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
205 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
206 To do this, incoming messages are examined for multiple parts: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
207 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
208 * In a multipart/mixed message or part, each subpart is extracted and |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
209 examined. The text/plain subparts are assembled to form the textual body |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
210 of the message, to be stored in the file associated with a "msg" class |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
211 item. Any parts of other types are each stored in separate files and |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
212 given "file" class items that are linked to the "msg" item. |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
213 * In a multipart/alternative message or part, we look for a text/plain |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
214 subpart and ignore the other parts. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
215 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
216 If the message is a response to a previous message, and contains quoted |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
217 sections, then these will be stripped out of the message if the |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
218 ``EMAIL_KEEP_QUOTED_TEXT`` configuration variable is set to ``'no'``. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
219 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
220 Message summary |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
221 ~~~~~~~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
222 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
223 The "summary" property on message items is taken from the first non-quoting |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
224 section in the message body. The message body is divided into sections by blank |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
225 lines. Sections where the second and all subsequent lines begin with a ">" or |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
226 "|" character are considered "quoting sections". The first line of the first |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
227 non-quoting section becomes the summary of the message. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
228 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
229 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
230 Address handling |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
231 ---------------- |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
232 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
233 All of the addresses in the ``To:`` and ``Cc:`` headers of the incoming |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
234 message are |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
235 looked up among the tracker users, and the corresponding users are placed |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
236 in the |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
237 "recipients" property on the new "msg" item. The address in the ``From:`` header |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
238 similarly determines the "author" property of the new "msg" item. The default |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
239 handling for addresses that don't have corresponding users is to create new |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
240 users with no passwords and a username equal to the address. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
241 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
242 The addresses mentioned in the ``To:``, ``From:`` and ``Cc:`` headers of |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
243 the message may be added to the `nosy list`_ depending on: |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
244 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
245 ``ADD_AUTHOR_TO_NOSY`` |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
246 Does the author of a message get placed on the nosy list automatically? |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
247 If 'new' is used, then the author will only be added when a message |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
248 creates a new issue. If 'yes', then the author will be added on followups |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
249 too. If 'no', they're never added to the nosy. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
250 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
251 ``ADD_RECIPIENTS_TO_NOSY`` |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
252 Do the recipients (To:, Cc:) of a message get placed on the nosy list? |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
253 If 'new' is used, then the recipients will only be added when a message |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
254 creates a new issue. If 'yes', then the recipients will be added on |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
255 followups too. If 'no', they're never added to the nosy. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
256 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
257 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
258 Nosy List |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
259 ~~~~~~~~~ |
|
881
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
260 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
261 The nosy list watches for additions to the "messages" property of items. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
262 When a new message is added, it is sent to all the users |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
263 on the "nosy" list for the item that are not already on the "recipients" list |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
264 of the message. Those users are then appended to the "recipients" property on |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
265 the message, so multiple copies of a message are never sent to the same user. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
266 The journal recorded by the hyperdatabase on the "recipients" property then |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
267 provides a log of when the message was sent to whom. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
268 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
269 If the author of the message is also in the nosy list for the item that the |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
270 message is attached to, then the config var ``MESSAGES_TO_AUTHOR`` is queried |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
271 to determine if they get a nosy list copy of the message too. |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
272 |
|
85cc6e6a94b8
better mailgw user docs
Richard Jones <richard@users.sourceforge.net>
parents:
753
diff
changeset
|
273 |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
274 Command Line Tool |
|
1199
cd58a8603424
half-backed cleaning up of user guide
Richard Jones <richard@users.sourceforge.net>
parents:
1098
diff
changeset
|
275 ================= |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
276 |
| 1098 | 277 The basic usage is:: |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
278 |
| 1098 | 279 Help: |
| 280 roundup-admin -h | |
| 281 roundup-admin help -- this help | |
| 282 roundup-admin help <command> -- command-specific help | |
| 283 roundup-admin help all -- all available help | |
| 284 | |
| 285 Options: | |
| 286 -i instance home -- specify the issue tracker "home directory" to administer | |
| 287 -u -- the user[:password] to use for commands | |
| 288 -c -- when outputting lists of data, just comma-separate them | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
289 |
| 1098 | 290 Commands: |
| 291 commit | |
| 292 create classname property=value ... | |
| 293 display designator | |
| 294 export [class[,class]] export_dir | |
| 295 find classname propname=value ... | |
| 296 get property designator[,designator]* | |
| 297 help topic | |
| 298 history designator | |
| 299 import import_dir | |
| 300 initialise [adminpw] | |
| 301 install [template [backend [admin password]]] | |
| 302 list classname [property] | |
| 303 pack period | date | |
| 304 reindex | |
| 305 retire designator[,designator]* | |
| 306 rollback | |
| 307 security [Role name] | |
| 308 set designator[,designator]* propname=value ... | |
| 309 specification classname | |
| 310 table classname [property[,property]*] | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
311 |
| 1098 | 312 Commands may be abbreviated as long as the abbreviation matches only one |
| 313 command, e.g. l == li == lis == list. | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
314 |
| 1098 | 315 All commands (except help) require a tracker specifier. This is just the |
| 316 path to the roundup tracker you're working with. A roundup tracker is where | |
| 317 roundup keeps the database and configuration file that defines an issue | |
| 318 tracker. It may be thought of as the issue tracker's "home directory". | |
| 319 It may be specified in the environment variable ``TRACKER_HOME`` or on | |
| 320 the command line as "``-i tracker``". | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
321 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
322 A designator is a classname and an itemid concatenated, eg. bug1, user10, ... |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
323 Property values are represented as strings in command arguments and in the printed |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
324 results: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
325 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
326 - Strings are, well, strings. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
327 - Password values will display as their encoded value. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
328 - Date values are printed in the full date format in the local time zone, |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
329 and accepted in the full format or any of the partial formats explained |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
330 below.:: |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
331 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
332 Input of... Means... |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
333 "2000-04-17.03:45" 2000-04-17.08:45:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
334 "2000-04-17" 2000-04-17.00:00:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
335 "01-25" yyyy-01-25.00:00:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
336 "08-13.22:13" yyyy-08-14.03:13:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
337 "11-07.09:32:43" yyyy-11-07.14:32:43 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
338 "14:25" yyyy-mm-dd.19:25:00 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
339 "8:47:11" yyyy-mm-dd.13:47:11 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
340 "." "right now" |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
341 |
|
1089
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
342 - Link values are printed as item designators. When given as an argument, |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
343 item designators and key strings are both accepted. |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
344 - Multilink values are printed as lists of item designators joined by |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
345 commas. When given as an argument, item designators and key strings are |
|
43ab730ee194
instance -> tracker, node -> item
Richard Jones <richard@users.sourceforge.net>
parents:
881
diff
changeset
|
346 both accepted; an empty string, a single item, or a list of items joined |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
347 by commas is accepted. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
348 |
| 1098 | 349 When multiple items are specified to the roundup get or roundup set |
| 350 commands, the specified properties are retrieved or set on all the listed | |
| 351 items. When multiple results are returned by the roundup get or roundup | |
| 352 find commands, they are printed one per line (default) or joined by commas | |
| 353 (with the "``-c``" option). | |
|
659
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
354 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
355 Where the command changes data, a login name/password is required. The login may |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
356 be specified as either "``name``" or "``name:password``". |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
357 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
358 - ``ROUNDUP_LOGIN`` environment variable |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
359 - the "``-u``" command-line option |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
360 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
361 If either the name or password is not supplied, they are obtained from the |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
362 command-line. |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
363 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
364 |
|
e429649ed124
More documentation cleanups.
Richard Jones <richard@users.sourceforge.net>
parents:
diff
changeset
|
365 |
|
686
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
366 ----------------- |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
367 |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
368 Back to `Table of Contents`_ |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
369 |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
370 .. _`Table of Contents`: index.html |
|
c52122f38c9b
Documentation cleanup, added info for potential (and current) developers
Richard Jones <richard@users.sourceforge.net>
parents:
659
diff
changeset
|
371 |