Mercurial > p > roundup > code

comparison doc/user_guide.txt @ 1575:f5d53a939b67

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
more doc
author Richard Jones <richard@users.sourceforge.net>
date Thu, 03 Apr 2003 01:55:01 +0000
parents 93e0a565cee5
children 1ac46e7e4150
comparison
equal deleted inserted replaced
1574:67af854f4c33 1575:f5d53a939b67
1 ========== 1 ==========
2 User Guide 2 User Guide
3 ========== 3 ==========
4 4
5 :Version: $Revision: 1.17 $ 5 :Version: $Revision: 1.18 $
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
35 35
36 The last is usually only used by administrators. Most users will use the web 36 The last is usually only used by administrators. Most users will use the web
37 and email interfaces. All three are explained below. 37 and email interfaces. All three are explained below.
38 38
39 39
40 Web Interface 40 Searching in your Tracker
41 ============= 41 -------------------------
42 42
43 Note: this document contains screenshots of the default look and feel. Your 43 All interfaces to your tracker use the same format for sepcifying search
44 site may have a slightly (or very) different look, but the functionality will 44 parameters.
45 be very similar, and the concepts still hold. 45
46 46 String and Numeric properties
47 The web interface is broken up into the following parts: 47 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48 48
49 1. `lists of items`_, 49 These fields just take a simple text value, like ``topic=It's broken``.
50 2. `display, edit or entry of an item`_, and 50
51 3. `searching page`_. 51 Boolean properties
52 52 ~~~~~~~~~~~~~~~~~~
53 53
54 Lists of Items 54 These fields take a value which indicates "yes"/"no", "true"/"false",
55 -------------- 55 "1"/"0" or "on"/"off".
56 56
57 The first thing you'll see when you log into Roundup will be a list of open 57 Constrained (link and multilink) properties
58 (ie. not resolved) issues. This list has been generated by a bunch of controls 58 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
59 `under the covers`_ but for now, you can see something like: 59
60 60 Fields like "Assigned To" and "Topics" hold references to items in other
61 .. img: images/index_logged_out.png 61 classes ("user" and "keyword" in those two cases.)
62 62
63 The screen is divided up into three sections: 63 We use a comma-separated list of values to indicated which values of "user"
64 64 or "keyword" are interesting. The values may be either numeric ids or the
65 .. img: images/page_layout.png 65 names of items. The special value "-1" may be used to match items where the
66 66 property is not set. For example, the following searches on the issues:
67 you may either register or log in. Registration takes you to: 67
68 68 ``assignedto=richard,george``
69 .. img: images/registration.png 69 match issues which are assigned to richard or george.
70 70 ``assignedto=-1``
71 Once you're logged in, the screen changes slightly to: 71 match issues that are not assigned to a user.
72 72 ``assignedto=2,3,40``
73 .. img: images/index_logged_in.png 73 match issues that are assigned to users 2, 3 or 40.
74 74 ``topic=user interface``
75 Note that the sidebar menu has changed slightly, so you can now get to your 75 match issues with the keyword "user interface" in their topic list
76 "My Details" page: 76 ``topic=web interface,email interface``
77 77 match issues with the keyword "web interface" or "email interface" in
78 .. img: images/my_details.png 78 their topic list
79 79 ``topic=-1``
80 Note the new information on this page - the history. 80 match issues with no topics set
81 81
82 82
83 Display, edit or entry of an item 83 Date properties
84 --------------------------------- 84 ~~~~~~~~~~~~~~~
85 85
86 Create a new issue with "create new" under the issue subheading. This will 86 Some fields in the search page (e.g. "Activity" or "Creation date") hold
87 take you to: 87 dates. A plain date entered as a search field will match that date exactly
88 88 in the database. We may also accept ranges of dates. You can specify range
89 .. img: images/new_issue.png 89 of dates in one of two formats:
90 90
91 The `nosy list`_ is explained below. 91 1. English syntax::
92 Enter some information and click "submit new entry" and you'll be rewarded
93 with:
94
95 .. img: images/new_issue_created.png
96
97 or, if you don't enter all the required information (or some other error
98 occurs) you'll get something like:
99
100 .. img: images/new_issue_error.png
101
102
103 Searching Page
104 --------------
105
106 XXX: some information about how searching works
107
108 Some fields in the search page (e.g. "Activity" or "Creation date") accept
109 ranges of dates. You can specify range of dates in one of two formats:
110
111 1. Native english syntax::
112 92
113 [[From] <value>][ To <value>] 93 [[From] <value>][ To <value>]
114 94
115 Keywords "From" and "To" are case insensitive. Keyword "From" is optional. 95 Keywords "From" and "To" are case insensitive. Keyword "From" is optional.
116 96
118 98
119 [<value>][; <value>] 99 [<value>][; <value>]
120 100
121 Either first or second ``<value>`` can be omitted in both syntaxes. 101 Either first or second ``<value>`` can be omitted in both syntaxes.
122 102
123 For example: 103 For example, if you enter string "from 9:00" to "Creation date" field,
124 104 roundup will find all issues, that were created today since 9 AM.
125 if you enter string "from 9:00" to "Creation date" field, roundup 105
126 will find all issues, that were created today since 9 AM. 106 Searching of "-2m; -1m" on activity field gives you issues which were
127
128 Searching of "-2m; -1m" on activity field gives you issues, which were
129 active between period of time since 2 months up-till month ago. 107 active between period of time since 2 months up-till month ago.
130 108
131 Other possible examples (consider local time is Sat Mar 8 22:07:48 EET 2003): 109 Other possible examples (consider local time is Sat Mar 8 22:07:48 2003)::
132 110
133 >>> Range("from 2-12 to 4-2") 111 >>> Range("from 2-12 to 4-2")
134 <Range from 2003-02-12.00:00:00 to 2003-04-02.00:00:00> 112 <Range from 2003-02-12.00:00:00 to 2003-04-02.00:00:00>
135 113
136 >>> Range("18:00 TO +2m") 114 >>> Range("18:00 TO +2m")
147 125
148 >>> Range("; 20:00 +1d") 126 >>> Range("; 20:00 +1d")
149 <Range from None to 2003-03-09.20:00:00> 127 <Range from None to 2003-03-09.20:00:00>
150 128
151 129
130 Interval properties
131 ~~~~~~~~~~~~~~~~~~~
132
133 XXX explain...
134
135
136 Web Interface
137 =============
138
139 Note: this document contains screenshots of the default look and feel. Your
140 site may have a slightly (or very) different look, but the functionality will
141 be very similar, and the concepts still hold.
142
143 The web interface is broken up into the following parts:
144
145 1. `lists of items`_,
146 2. `display, edit or entry of an item`_, and
147 3. `searching page`_.
148
149
150 Lists of Items
151 --------------
152
153 The first thing you'll see when you log into Roundup will be a list of open
154 (ie. not resolved) issues. This list has been generated by a bunch of controls
155 `under the covers`_ but for now, you can see something like:
156
157 .. img: images/index_logged_out.png
158
159 The screen is divided up into three sections:
160
161 .. img: images/page_layout.png
162
163 you may either register or log in. Registration takes you to:
164
165 .. img: images/registration.png
166
167 Once you're logged in, the screen changes slightly to:
168
169 .. img: images/index_logged_in.png
170
171 Note that the sidebar menu has changed slightly, so you can now get to your
172 "My Details" page:
173
174 .. img: images/my_details.png
175
176 Note the new information on this page - the history.
177
178
179 Display, edit or entry of an item
180 ---------------------------------
181
182 Create a new issue with "create new" under the issue subheading. This will
183 take you to:
184
185 .. img: images/new_issue.png
186
187 The `nosy list`_ is explained below.
188 Enter some information and click "submit new entry" and you'll be rewarded
189 with:
190
191 .. img: images/new_issue_created.png
192
193 or, if you don't enter all the required information (or some other error
194 occurs) you'll get something like:
195
196 .. img: images/new_issue_error.png
197
198
199 Searching Page
200 --------------
201
202 see `searching in your tracker`_ for an explanation of how the searching
203 works.
204
152 Under the covers 205 Under the covers
153 ---------------- 206 ~~~~~~~~~~~~~~~~
154 207
155 Index views may be modified by the following arguments: 208 The searching page converts your selections into the following arguments:
156 209
157 ========== ============================================================= 210 ========== =============================================================
158 Argument Description 211 Argument Description
159 ========== ============================================================= 212 ========== =============================================================
160 :sort sort by prop name, optionally preceeded with '-' 213 :sort sort by prop name, optionally preceeded with '-'
166 :columns selects the columns that should be displayed. 219 :columns selects the columns that should be displayed.
167 Default is all. 220 Default is all.
168 propname selects the values the item properties given by propname 221 propname selects the values the item properties given by propname
169 must have (very basic search/filter). 222 must have (very basic search/filter).
170 ========== ============================================================= 223 ========== =============================================================
224
225 You may manually write URLS that contain these arguments, like so (whitespace
226 has been added for clarity)::
227
228 /issue?status=unread,in-progress,resolved&
229 topic=security,ui&
230 :group=priority&
231 :sort=-activity&
232 :filters=status,topic&
233 :columns=title,status,fixer
234
171 235
172 Access Controls 236 Access Controls
173 --------------- 237 ---------------
174 238
175 User access is controlled through Permissions. These are are grouped into 239 User access is controlled through Permissions. These are are grouped into
Roundup Issue Tracker: http://roundup-tracker.org/