VTCalendar (XML) Export Format
The VTCalendar (XML) format is used for importing and exporting events between instances of VTCalendar.
This allows sponsors to backup and restore their events.
It should not be used to backup and entire calendar or VTCalendar installation.
Top-Level Elements :
In the example below, we see that the root element is <events>, which contains one or more <event> elements.
The <event> element contains several child elements, all of which are required (but some can be empty).
||The index number of this event
||The short identifier of the organization that inputed the event into the calendar
||The name of the organization that inputed the event into the calendar
||The name of the sponsor that is displayed in the calendar's detailed view
||The URL of the homepage of the sponsor that is displayed in the calendar's detailed view
||The date the event takes place, written in the ISO-8601 format
- The time the event begins, written in the ISO-8601 format (military/24 hour time)
- If the value is "00:00" and timeend is "23:59" the event is considered to be an
"all day event"
- The time the event ends, written in the ISO-8601 format (military/24 hour time)
- If the value is completely ommitted the event is considered to not have a specified
- If the event is a recurring event it contains the recurrence definition in
- e.g. "W1 MO WE FR 20000502T235900" means that an event repeats every week
Monday, Wednesday & Friday until May 2, 2000
If the event is a recurring event it contains the date where the recurrence starts
If the event is a recurring event it contains the date where the recurrence ends
An index number indicating the category of the event (see table below)
The name of the category associated with the event
||The event title (displayed in weekly, monthly and detailed view)
||A long text describing the specifics of an event
the description is only displayed in the detailed view
||The location where the event takes place (building, room etc.)
The price of the event
||The name of a person that can be contacted if further info is required
Contact phone number(s)
||Contact email address
||No longer used as of 2.3.0. URL of a web page specifically describing the event
||A timestamp indicating when this event was changed the last time
Example - Non-Repeating Event:
In the example below, we now see a full <event> element for a non-repeating event.
In the example below note the following:
- As of VTCalendar version 2.3.0, the URL field is still supported for importing, but will always be blank in export XML.
<displayedsponsor>School of Law Law Journal Symposium</displayedsponsor>
<title>5th Annual Wiley A. Branton Law Journal Symposium</title>
<description>The symposium theme this year is "Thurgood Marshall.</description>
<location>Law School (West Campus), Moot Court Room</location>
<price>open to the public</price>
Example - Repeating Event
In the example below, we now see a full <event> element for an event that repeats every Sunday.
<repeat_vcaldef>W1 SU 20081207T235900</repeat_vcaldef>
<title>Call to Chapel</title>
<description>Speaker Schedule forthcoming at: http://chapel.example.edu/schedule.htm</description>