Changes between Version 2 and Version 3 of IcalViewPlugin


Ignore:
Timestamp:
Jul 24, 2009 7:15:22 PM (5 years ago)
Author:
xpech
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • IcalViewPlugin

    v2 v3  
    55Provide iCalendar feeds for ticket queries as standard [http://trac.edgewall.org/roadmap roadmap module]. It use 2 custom fields for event date and duration. 
    66 
    7 == Description == 
     7== Usage == 
    88 
    9 == Limitations == 
     9=== Setup custom fields for date and duration === 
    1010 
    11   * date for date_creation custom field use dd.mm.yyyy format. Working to provide setup options. 
    12   * only support duration in days number. 
     11To transform a ticket to an event, we need at least a date. Trac only provide a creation date or an update date. So we need a planned date by adding a custom field. The default name is 'dtstart' (mathing [http://tools.ietf.org/html/rfc2445 RFC/2445]). 
    1312 
    14 After installation, you need had 2 custom fields to tickets : 
     13trac.ini 
     14{{{ 
     15[ticket-custom] 
     16dtstart = text 
     17dtstart.label = Planned Date 
     18}}} 
     19 
     20To use another field name, you can set it in a new configuration section named 'icalendar' : 
    1521 
    1622{{{ 
     23[ticket-custom] 
     24my_custom_dtstart = text 
     25dtstart.label = Planned Date 
    1726 
     27[icalendar] 
     28dtstart = my_custom_dtstart 
     29}}} 
     30 
     31We also need a duration fields : 
     32{{{ 
    1833[ticket-custom] 
    1934dtstart = text 
    20 dtstart.label = Date 
     35dtstart.label = Planned Date 
     36 
    2137duration = text 
    2238duration.label = Duration in days 
    2339}}} 
    2440 
    25 Other custom fields name may be used, but need a special setup : 
    26  
     41To use another field name : 
    2742 
    2843{{{ 
    2944[icalendar] 
    30 dtstart = my_custom_dtstart 
    31 duration = my_custom_duration 
     45duration = my_custom_duration_field_name 
    3246}}} 
    3347 
     48 
     49=== Date and duration input format === 
     50 
     51Default input date format are : "'%m/%d/%Y"  (month/day/year) for strict date and and "%m/%d/%Y %H:%M" for date and time. 
     52 
     53To customize this format, use the "short_date_format" and "date_time_format" configuration options : 
     54 
     55{{{ 
     56[icalendar] 
     57short_date_format = %d/%m/%Y 
     58date_time_format = %d/%m/%Y %H:%M 
     59}}} 
     60 
     61to support multiple format, use a ';' to separate them: 
     62 
     63{{{ 
     64[icalendar] 
     65short_date_format = %d/%m/%Y;%Y-%m-%d 
     66date_time_format = %d/%m/%Y %H:%M;%Y-%m-%d %H:%M 
     67}}} 
     68 
     69 
     70Duration fied support 4 syntax : 
     71 * Standard hours:minutes format : H:MM ( "8:45" "12:30" ...) 
     72 * a number of days ending by a 'd' : 15d 
     73 * the standard [http://tools.ietf.org/html/rfc2445 RFC/2445] duration begining  with a "P" : "P1W" "P1D" ... 
     74 
     75Some tips  : 
     76 * Tickets with a planned date and no duration are planned as a day event 
     77 * Tickets without a planned date are transfomed as TODO.  
     78 
     79== Limitations == 
     80 
     81The calendar is read only. 
    3482 
    3583== Bugs/Feature Requests ==