Changes between Version 40 and Version 41 of TracCronPlugin


Ignore:
Timestamp:
Feb 21, 2013 3:25:42 PM (17 months ago)
Author:
t2y
Comment:

updated documents and added TicketDeadlineTask

Legend:

Unmodified
Added
Removed
Modified
  • TracCronPlugin

    v40 v41  
    3333 
    3434Current stable release is '''0.3.1''' 
    35 You can use easy_install to download the latest egg into your python environment 
     35You can use easy_install or pip to download the latest package into your python environment 
    3636 
    3737{{{ 
    3838#!sh 
    39 easy_install TracCronPlugin 
    40 }}} 
    41  
    42 or download distributions files at [http://pypi.python.org/pypi/TracCronPlugin pypi] (egg, binary and source) 
    43  
    44 === Latest source === 
    45  
    46 Download the latest trunk zipped source from [download:traccronplugin here]. 
     39$ easy_install TracCronPlugin 
     40or  
     41$ pip install TracCronPlugin 
     42}}} 
     43 
     44or download distributions files at [http://pypi.python.org/pypi/TracCronPlugin pypi] (only source distributions) 
    4745 
    4846== Source == 
     
    276274'''note''': since 0.2dev_r9390 
    277275 
    278  
    279276Trac 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) 
    280277 
     278=== Ticket deadline task === 
     279 
     280'''note''': since 0.3 
     281 
     282This 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. 
     283 
     284 - days_before: notify days before the deadline 
     285 - date_field: ticket custom field's name 
     286 - date_format: this format string is handled by datetime module 
     287 
     288[[Image(ticket-with-duedate.png)]] 
     289 
     290Here is a sample configuration for trac.ini. 
     291 
     292{{{ 
     293#!ini 
     294[traccron] 
     295ticker_enabled = True 
     296ticker_interval = 1 
     297ticket_deadline.cron = * 0 10 * * ? *  
     298ticket_deadline.cron.enabled = True 
     299ticket_deadline.enabled = True 
     300days_before=3 
     301date_field=due_date 
     302date_format=%Y-%m-%d 
     303 
     304[ticket-custom] 
     305due_date = text 
     306due_date.date = true 
     307due_date.label = Due Date 
     308due_date.value = YYYY-MM-DD 
     309due_date.date_empty = true 
     310 
     311[datefield] 
     312format = ymd  
     313separator = - 
     314first_day = 1 
     315}}} 
     316 
    281317== Bundled Scheduler == 
    282318 
     
    300336 
    301337Since 0.2dev_r9375 there is a cron scheduler. You can use cron syntaxe to define the schedule. Currenlty you can use 
     338 
    302339 * single value 
    303340 * range value both with - or / special character 
     
    312349'''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. 
    313350 
    314 Please refer to cron documentation for more details [http://en.wikipedia.org/wiki/CRON_expression cron syntax ] 
     351The cron like expression is here. Set either day-of-month or day-of-week and the other one must be '?'. 
     352 
     353{{{ 
     354ex: *  *  *  ?  *  ?  * 
     355    ┬  ┬  ┬  ┬  ┬  ┬  ┬ 
     356    │  │  │  │  │  │  └──── year (omissible) 
     357    │  │  │  │  │  └─────── day of week (1 - 7, 1 is Monday) 
     358    │  │  │  │  └────────── month (1 - 12) 
     359    │  │  │  └───────────── day of month (1 - 31) 
     360    │  │  └──────────────── hour (0 - 23) 
     361    │  └─────────────────── min (0 - 59) 
     362    └────────────────────── None (reserved?) 
     363}}} 
     364 
     365Please refer to cron documentation for more details [http://en.wikipedia.org/wiki/CRON_expression cron syntax] 
    315366 
    316367== Bundled Listener ==