wiki:IcalViewPlugin

Version 3 (modified by xpech, 5 years ago) (diff)

--

iCalendar plugin for ticket queries

Description

Provide iCalendar feeds for ticket queries as standard roadmap module. It use 2 custom fields for event date and duration.

Usage

Setup custom fields for date and duration

To 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 RFC/2445).

trac.ini

[ticket-custom]
dtstart = text
dtstart.label = Planned Date

To use another field name, you can set it in a new configuration section named 'icalendar' :

[ticket-custom]
my_custom_dtstart = text
dtstart.label = Planned Date

[icalendar]
dtstart = my_custom_dtstart

We also need a duration fields :

[ticket-custom]
dtstart = text
dtstart.label = Planned Date

duration = text
duration.label = Duration in days

To use another field name :

[icalendar]
duration = my_custom_duration_field_name

Date and duration input format

Default input date format are : "'%m/%d/%Y" (month/day/year) for strict date and and "%m/%d/%Y %H:%M" for date and time.

To customize this format, use the "short_date_format" and "date_time_format" configuration options :

[icalendar]
short_date_format = %d/%m/%Y
date_time_format = %d/%m/%Y %H:%M

to support multiple format, use a ';' to separate them:

[icalendar]
short_date_format = %d/%m/%Y;%Y-%m-%d
date_time_format = %d/%m/%Y %H:%M;%Y-%m-%d %H:%M

Duration fied support 4 syntax :

  • Standard hours:minutes format : H:MM ( "8:45" "12:30" ...)
  • a number of days ending by a 'd' : 15d
  • the standard RFC/2445 duration begining with a "P" : "P1W" "P1D" ...

Some tips :

  • Tickets with a planned date and no duration are planned as a day event
  • Tickets without a planned date are transfomed as TODO.

Limitations

The calendar is read only.

Bugs/Feature Requests

Existing bugs and feature requests for IcalViewPlugin are here.

If you have any issues, create a new ticket.

Download

Download the zipped source from here.

Source

You can check out IcalViewPlugin from here using Subversion, or browse the source with Trac.

Example

Add a iCalendar links in ticket's queries footer.

Recent Changes

[7253] by xpech on 2009-12-14 10:34:46
commit error
[7252] by xpech on 2009-12-14 10:33:36
Fix #6323: best multi-line description support
[7251] by xpech on 2009-12-14 10:12:16
Fix #6323: best multi-line description support

Author/Contributors

Author: xpech
Contributors: