comparison doc/user_guide.txt @ 2751:fd392d8cbfe1 maint-0.7

merge from HEAD
author Richard Jones <richard@users.sourceforge.net>
date Tue, 12 Oct 2004 21:54:55 +0000
parents ef226254ef46
children e435d2b81547
comparison
equal deleted inserted replaced
2749:2f27ec0a8ebb 2751:fd392d8cbfe1
115 115
116 116
117 Date properties 117 Date properties
118 ~~~~~~~~~~~~~~~ 118 ~~~~~~~~~~~~~~~
119 119
120 Some fields in the search page (e.g. "Activity" or "Creation date") hold 120 Date-and-time stamps are specified with the date in
121 dates. A plain date entered as a search field will match that date 121 international standard format (``yyyy-mm-dd``) joined to the time
122 (``hh:mm:ss``) by a period ``.``. Dates in this form can be easily
123 compared and are fairly readable when printed. An example of a valid
124 stamp is ``2000-06-24.13:03:59``. We'll call this the "full date
125 format". When Timestamp objects are printed as strings, they appear in
126 the full date format.
127
128 For user input, some partial forms are also permitted: the whole time or
129 just the seconds may be omitted; and the whole date may be omitted or
130 just the year may be omitted. If the time is given, the time is
131 interpreted in the user's local time zone. The Date constructor takes
132 care of these conversions. In the following examples, suppose that
133 ``yyyy`` is the current year, ``mm`` is the current month, and ``dd`` is
134 the current day of the month.
135
136 - "2000-04-17" means <Date 2000-04-17.00:00:00>
137 - "01-25" means <Date yyyy-01-25.00:00:00>
138 - "2000-04-17.03:45" means <Date 2000-04-17.08:45:00>
139 - "08-13.22:13" means <Date yyyy-08-14.03:13:00>
140 - "11-07.09:32:43" means <Date yyyy-11-07.14:32:43>
141 - "14:25" means
142 - <Date yyyy-mm-dd.19:25:00>
143 - "8:47:11" means
144 - <Date yyyy-mm-dd.13:47:11>
145 - the special date "." means "right now"
146
147
148 When searching, a plain date entered as a search field will match that date
122 exactly in the database. We may also accept ranges of dates. You can 149 exactly in the database. We may also accept ranges of dates. You can
123 specify range of dates in one of two formats: 150 specify range of dates in one of two formats:
124 151
125 1. English syntax:: 152 1. English syntax::
126 153
136 Either first or second ``<value>`` can be omitted in both syntaxes. 163 Either first or second ``<value>`` can be omitted in both syntaxes.
137 164
138 For example, if you enter string "from 9:00" to "Creation date" field, 165 For example, if you enter string "from 9:00" to "Creation date" field,
139 roundup will find all issues, that were created today since 9 AM. 166 roundup will find all issues, that were created today since 9 AM.
140 167
168 The ``<value>`` may also be an interval, as described in the next section.
141 Searching of "-2m; -1m" on activity field gives you issues which were 169 Searching of "-2m; -1m" on activity field gives you issues which were
142 active between period of time since 2 months up-till month ago. 170 active between period of time since 2 months up-till month ago.
143 171
144 Other possible examples (consider local time is Sat Mar 8 22:07:48 172 Other possible examples (consider local time is 2003-03-08.22:07:48)::
145 2003):: 173
146 174 - "from 2-12 to 4-2" means
147 >>> Range("from 2-12 to 4-2") 175 <Range from 2003-02-12.00:00:00 to 2003-04-02.00:00:00>
148 <Range from 2003-02-12.00:00:00 to 2003-04-02.00:00:00> 176 - "FROM 18:00 TO +2m" means
149 177 <Range from 2003-03-08.18:00:00 to 2003-05-08.20:07:48>
150 >>> Range("FROM 18:00 TO +2m") 178 - "12:00;" means
151 <Range from 2003-03-08.18:00:00 to 2003-05-08.20:07:48> 179 <Range from 2003-03-08.12:00:00 to None>
152 180 - "tO +3d" means
153 >>> Range("12:00;") 181 <Range from None to 2003-03-11.20:07:48>
154 <Range from 2003-03-08.12:00:00 to None> 182 - "2002-11-10; 2002-12-12" means
155 183 <Range from 2002-11-10.00:00:00 to 2002-12-12.00:00:00>
156 >>> Range("tO +3d") 184 - "; 20:00 +1d" means
157 <Range from None to 2003-03-11.20:07:48> 185 <Range from None to 2003-03-09.20:00:00>
158 186 - "2003" means
159 >>> Range("2002-11-10; 2002-12-12") 187 <Range from 2003-01-01.00:00:00 to 2003-12-31.23:59:59>
160 <Range from 2002-11-10.00:00:00 to 2002-12-12.00:00:00> 188 - "2003-04" means
161 189 <Range from 2003-04-01.00:00:00 to 2003-04-30.23:59:59>
162 >>> Range("; 20:00 +1d")
163 <Range from None to 2003-03-09.20:00:00>
164
165 >>> Range("2003")
166 <Range from 2003-01-01.00:00:00 to 2003-12-31.23:59:59>
167
168 >>> Range("2003-04")
169 <Range from 2003-04-01.00:00:00 to 2003-04-30.23:59:59>
170 190
171 191
172 Interval properties 192 Interval properties
173 ~~~~~~~~~~~~~~~~~~~ 193 ~~~~~~~~~~~~~~~~~~~
174 194
175 XXX explain... 195 Date intervals are specified using the suffixes "y", "m", and "d". The
176 196 suffix "w" (for "week") means 7 days. Time intervals are specified in
177 When searching on interval properties use the same syntax as for dates. 197 hh:mm:ss format (the seconds may be omitted, but the hours and minutes
198 may not).
199
200 - "3y" means three years
201 - "2y 1m" means two years and one month
202 - "1m 25d" means one month and 25 days
203 - "2w 3d" means two weeks and three days
204 - "1d 2:50" means one day, two hours, and 50 minutes
205 - "14:00" means 14 hours
206 - "0:04:33" means four minutes and 33 seconds
178 207
179 208
180 Simple support for collision detection 209 Simple support for collision detection
181 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
182 211

Roundup Issue Tracker: http://roundup-tracker.org/