Changes between Version 40 and Version 41 of TracCronPlugin

Timestamp:

Feb 21, 2013, 2:25:42 PM (11 years ago)

Author:

Tetsuya Morimoto

Comment:

updated documents and added TicketDeadlineTask

TracCronPlugin

@@ -33 +33 @@
 
 Current stable release is '''0.3.1'''
-You can use easy_install to download the latest egg into your python environment
+You can use easy_install or pip to download the latest package into your python environment
 
 {{{
 #!sh
-easy_install TracCronPlugin
-}}}
-
-or download distributions files at [http://pypi.python.org/pypi/TracCronPlugin pypi] (egg, binary and source)
-
-=== Latest source ===
-
-Download the latest trunk zipped source from [download:traccronplugin here].
+$ easy_install TracCronPlugin
+or 
+$ pip install TracCronPlugin
+}}}
+
+or download distributions files at [http://pypi.python.org/pypi/TracCronPlugin pypi] (only source distributions)
 
 == Source ==
@@ -276 +274 @@
 '''note''': since 0.2dev_r9390
 
-
 Trac allow the administrator to postpone still opened ticket in a given milestone when he close a this milestone. But this is not mandatory. The auto postpone task will help to not forget opened tickets in closed milestone. The task look for such tickets and postpone them in the more recent still opened milestone (milestone must have a due date)
 
+=== Ticket deadline task ===
+
+'''note''': since 0.3
+
+This task notify to ticket's reporter and owner when its ticket is near the deadline as a custom field. You can add date field for ticket using [http://trac-hacks.org/wiki/DateFieldPlugin DateFieldPlugin]. Besides scheduler settings, there are 3 options to configure when DateFieldPlugin is used.
+
+ - days_before: notify days before the deadline
+ - date_field: ticket custom field's name
+ - date_format: this format string is handled by datetime module
+
+[[Image(ticket-with-duedate.png)]]
+
+Here is a sample configuration for trac.ini.
+
+{{{
+#!ini
+[traccron]
+ticker_enabled = True
+ticker_interval = 1
+ticket_deadline.cron = * 0 10 * * ? * 
+ticket_deadline.cron.enabled = True
+ticket_deadline.enabled = True
+days_before=3
+date_field=due_date
+date_format=%Y-%m-%d
+
+[ticket-custom]
+due_date = text
+due_date.date = true
+due_date.label = Due Date
+due_date.value = YYYY-MM-DD
+due_date.date_empty = true
+
+[datefield]
+format = ymd 
+separator = -
+first_day = 1
+}}}
+
 == Bundled Scheduler ==
 
@@ -300 +336 @@
 
 Since 0.2dev_r9375 there is a cron scheduler. You can use cron syntaxe to define the schedule. Currenlty you can use
+
  * single value
  * range value both with - or / special character
@@ -312 +349 @@
 '''warning''' : since TracCronPlugin ticker interval is at least one minute, this means the seconds cannot be specified and so the first item of the cron expression is useless.
 
-Please refer to cron documentation for more details [http://en.wikipedia.org/wiki/CRON_expression cron syntax ]
+The cron like expression is here. Set either day-of-month or day-of-week and the other one must be '?'.
+
+{{{
+ex: *  *  *  ?  *  ?  *
+    ┬  ┬  ┬  ┬  ┬  ┬  ┬
+    │  │  │  │  │  │  └──── year (omissible)
+    │  │  │  │  │  └─────── day of week (1 - 7, 1 is Monday)
+    │  │  │  │  └────────── month (1 - 12)
+    │  │  │  └───────────── day of month (1 - 31)
+    │  │  └──────────────── hour (0 - 23)
+    │  └─────────────────── min (0 - 59)
+    └────────────────────── None (reserved?)
+}}}
+
+Please refer to cron documentation for more details [http://en.wikipedia.org/wiki/CRON_expression cron syntax]
 
 == Bundled Listener ==