Jump to content

iCalendar

From Wikipedia, the free encyclopedia

This is an old revision of this page, as edited by Ogai (talk | contribs) at 07:45, 14 September 2018 (Added the nowadays important GEO property in the vevent example about a Bastille Day Party). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

Not to be confused with Apple's Calendar application (previously named iCal).
iCalendar
Filename extension
.ical, .ics, .ifb, .icalendar
Internet media type
text/calendar
Type of formatCalendar data exchange
StandardRFC 5545
(Updated by: RFC 5546, RFC 6868, RFC 7529)
Free format?Yes
iCalendar components and their properties

iCalendar is a computer file format which allows Internet users to send meeting requests and tasks to other Internet users by sharing or sending files in this format through various methods. The files usually have an extension of .ics. With supporting software, such as an email reader or calendar application, recipients of an iCalendar data file can respond to the sender easily or counter-propose another meeting date/time. The file format is specified in a proposed internet standard (RFC 5545) for calendar data exchange.[1]

iCalendar is used and supported by a large number of products, including Google Calendar, Apple Calendar (formerly iCal), IBM Notes (formerly Lotus Notes),[2] Yahoo! Calendar, Evolution (software), eM Client, Lightning extension for Mozilla Thunderbird and SeaMonkey, and partially by Microsoft Outlook and Novell GroupWise.

iCalendar is designed to be independent of the transport protocol. For example, certain events can be sent by traditional email or whole calendar files can be shared and edited by using a WebDav server, or SyncML. Simple web servers (using just the HTTP protocol) are often used to distribute iCalendar data about an event and to publish busy times of an individual. Publishers can embed iCalendar data in web pages using hCalendar, a 1:1 microformat representation of iCalendar in semantic (X)HTML.

History and design

iCalendar was first created in 1998 [3] by the Calendaring and Scheduling Working Group of the Internet Engineering Task Force, chaired by Anik Ganguly of Open Text Corporation, and was authored by Frank Dawson of Lotus Development Corporation and Derik Stenerson of Microsoft Corporation. iCalendar is heavily based on the earlier vCalendar by the Internet Mail Consortium (IMC). iCalendar data files are plain text files with the extension .ics or .ifb (for files containing availability information only). RFC 5545 replaced RFC 2445 in September 2009 and now defines the standard.

iCalendar data have the MIME content type text/calendar.

The filename extension of ics is to be used for files containing calendaring and scheduling information, ifb for files with free or busy time information consistent with this MIME content type. The equivalent file type codes in Apple Macintosh operating system environments are iCal and iFBf.

By default, iCalendar uses the UTF-8 character set; a different character set can be specified using the "charset" MIME parameter (if the transport method used supports MIME, such as Email or HTTP).

Each line is terminated by CR+LF (in hexadecimal: 0D0A). Lines should be limited to 75 octets (not characters) long. Where a data item is too long to fit on a single line it can be continued on following lines by starting the continuation lines with a space character (in hex: 20) or a tab character (in hex: 09).

Actual line feeds in data items are encoded as a backslash followed by the letter n or N (the bytes 5C 6E or 5C 4E in UTF-8).

Limitations and future

The iCalendar format is designed to transmit calendar-based data, such as events, and intentionally does not describe what to do with that data. Thus, other programming may be needed to negotiate what to do with this data.[4]

iCalendar is meant to "provide the definition of a common format for openly exchanging calendaring and scheduling information across the Internet". While the features most often used by users are widely supported by iCalendar, some more advanced capabilities have problems. For example, most vendors do not support Journals (VJOURNAL). VTODOs have had conversion problems as well.[5]

iCalendar's calendar is also not compatible with some non-Gregorian calendars such as the lunar calendars used in Israel and Saudi Arabia.[6]

The memo "Calendar Access Protocol" (RFC 4324) was an initial attempt at a universal system to create real-time calendars. This protocol was eventually abandoned, possibly because of excessive complexity. Regardless, iCalendar-based code such as GroupDAV and CalDAV are now being used more frequently in both client and server software packages.

The IETF "Calendaring and Scheduling Working Group" (ietf-calsify WG) has published additional proposed revisions to the iCalendar standards[7] (as RFC-drafts/"Proposed"),[8] but as of January 2011, the group has 'ended'.[9] The work being picked up by the "Calendaring Extensions Working Group" (ietf-calext WG).[10]

Technical specifications

Core object

The top-level element in iCalendar is the Calendaring and Scheduling Core Object, a collection of calendar and scheduling information. Typically, this information will consist of a single iCalendar object. However, multiple iCalendar objects can be grouped together.

The first line must be BEGIN:VCALENDAR, and the last line must be END:VCALENDAR; the contents between these lines is called the "icalbody".
The second line VERSION:2.0 indicates that the data is in iCalendar format. VERSION:1.0 was used to specify that data is in the old vCalendar format.

The body of the iCalendar object (the icalbody) is made up of a list of calendar properties and one or more calendar components. The calendar properties apply to the entire calendar. The calendar components are several calendar properties which create a calendar schematic (design). For example, the calendar component can specify an event, a to-do list, a journal entry, time zone information, or free/busy time information, or an alarm. Empty lines are not allowed in some versions of usage (Google calendar).

Here is a simple example[11] of an iCalendar object, "Bastille Day Party" event which occurs July 14, 1997 17:00 (UTC) through July 15, 1997 03:59:59 (UTC): 

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//hacksw/handcal//NONSGML v1.0//EN
BEGIN:VEVENT
UID:uid1@example.com
DTSTAMP:19970714T170000Z
ORGANIZER;CN=John Doe:MAILTO:john.doe@example.com
DTSTART:19970714T170000Z
DTEND:19970715T035959Z
SUMMARY:Bastille Day Party
GEO:48.85299;2.36885
END:VEVENT
END:VCALENDAR

There are many different types of components which can be used in iCalendar, as described below.[12]

Events (VEVENT)

VEVENT describes an event, which has a scheduled amount of time on a calendar. Normally, when a user accepts the calendar event, this will cause that time to be considered busy.[13] A VEVENT may include a VALARM which allows an alarm. Such events have a DTSTART which sets a starting time, and a DTEND which sets an ending time. If the calendar event is recurring, DTSTART sets up the start of the first event.

A VALARM code (reminder 1 day before): 

BEGIN:VALARM
TRIGGER:-PT1440M
ACTION:DISPLAY
DESCRIPTION:Reminder
END:VALARM

VEVENT also is used for calendar events without a specific time, such as anniversaries and daily reminders.[14] If the user needs to send in a cancellation for an event, the UID should be the same as the original event, and the component properties should be set to cancel Ex. 

METHOD:CANCEL
STATUS:CANCELLED

For sending an UPDATE for an event the UID should match the original UID. The other component property to be set is: 

SEQUENCE:<Num of Update>

I.e., for the first update: 

SEQUENCE:1

In Microsoft Outlook, the SUMMARY corresponds to the "Subject" entry in the "Appointment" form, and DESCRIPTION to the descriptive text below it. In addition, Outlook 2002 and Outlook 2003 demand a UID and a DTSTAMP.

To-do (VTODO)

VTODO explains a to-do item, i.e., an action-item or assignment.

Not all calendar applications recognize VTODO items. In particular, Outlook does not export Tasks as VTODO items, and ignores VTODO items in imported calendars.[15]

The following is an example of a to-do due on April 15, 1998.[16] An audio alarm has been specified to remind the calendar user at noon, the day before the to-do is expected to be completed and repeat hourly, four additional times. The SEQUENCE element shows this to-do has been modified twice since it was initially created. 

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//ABC Corporation//NONSGML My Product//EN
BEGIN:VTODO
DTSTAMP:19980130T134500Z
SEQUENCE:2
UID:uid4@example.com
DUE:19980415T235959
STATUS:NEEDS-ACTION
SUMMARY:Submit Income Taxes
BEGIN:VALARM
ACTION:AUDIO
TRIGGER:19980414T120000
ATTACH;FMTTYPE=audio/basic:http://example.com/pub/audio-
 files/ssbanner.aud
REPEAT:4
DURATION:PT1H
END:VALARM
END:VTODO
END:VCALENDAR

Journal entry (VJOURNAL)

VJOURNAL is a journal entry. They attach descriptive text to a particular calendar date, may be used to record a daily record of activities or accomplishments, or describe progress with a related to-do entry. A "VJOURNAL" calendar component does not take up time on a calendar, so it has no effect on free or busy time (just like TRANSPARENT entries). In practice, few programs support VJOURNAL entries, although examples exist: Plum Canary's Chirp software uses VTODO and VJOURNAL together. Also KOrganizer from the KDE desktop and Evolution from the GNOME desktop support VJOURNAL.

The following is an example of a journal entry:[11] 

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//ABC Corporation//NONSGML My Product//EN
BEGIN:VJOURNAL
DTSTAMP:19970324T120000Z
UID:uid5@example.com
ORGANIZER:MAILTO:jsmith@example.com
STATUS:DRAFT
CLASS:PUBLIC
CATEGORIES:Project Report, XYZ, Weekly Meeting
DESCRIPTION:Project xyz Review Meeting Minutes\n
 Agenda\n1. Review of project version 1.0 requirements.\n2.
 Definition 
 of project processes.\n3. Review of project schedule.\n
 Participants: John Smith\, Jane Doe\, Jim Dandy\n-It was
  decided that the requirements need to be signed off by
  product marketing.\n-Project processes were accepted.\n
 -Project schedule needs to account for scheduled holidays
  and employee vacation time. Check with HR for specific
  dates.\n-New schedule will be distributed by Friday.\n-
 Next weeks meeting is cancelled. No meeting until 3/23.
END:VJOURNAL
END:VCALENDAR

(Note: This example is taken from RFC 2445 with the correction of changing the word 'CATEGORY' to 'CATEGORIES', which is a mistake in the original RFC)

Free/busy time (VFREEBUSY)

VFREEBUSY is a request for free/busy time, is a response to a request, or is a published set of busy time.[clarification needed] [17]

The following is an example of published busy time information:[18] 

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//RDU Software//NONSGML HandCal//EN
BEGIN:VFREEBUSY
DTSTAMP:20151013T080000Z
UID:uid6@example.com
ORGANIZER:MAILTO:jsmith@example.com
DTSTART:19980313T141711Z
DTEND:19980410T141711Z
FREEBUSY:19980314T233000Z/19980315T003000Z
FREEBUSY:19980316T153000Z/19980316T163000Z
FREEBUSY:19980318T030000Z/19980318T040000Z
URL:http://www.example.com/calendar/busytime/jsmith.ifb
END:VFREEBUSY
END:VCALENDAR

Other component types

Other component types include VAVAILABILITY, VTIMEZONE (time zones) and VALARM (alarms). Some components can include other components (VALARM is often included in other components).[19]

Distributing updates

The UID field distributes updates when a scheduled event changes. When the event is first generated a globally unique identifier is created. If a later event is distributed with the same UID, it replaces the original one.[20]

Calendar extensions

vCalendar and iCalendar support private software extensions, with a "X-" prefix, a number of which are in common usage.

Some of these include:

  • X-RECURRENCE-ID - vCalendar 1.0 extension which mimics the iCalendar 2.0 RECURRENCE-ID (Nokia S60 3rd Edition)
  • X-EPOCAGENDAENTRYTYPE - defines the client calendar type
  • X-FUNAMBOL-AALARMOPTIONS
  • X-FUNAMBOL-ALLDAY - All Day event flag
  • X-MICROSOFT-CDO-ALLDAYEVENT - Microsoft Outlook all day event flag
  • X-MICROSOFT-CDO-BUSYSTATUS - Microsoft Outlook status information
  • X-MICROSOFT-CDO-INTENDEDSTATUS
  • X-WR-CALNAME - The display name of the calendar
  • X-WR-CALDESC - A description of the calendar
  • X-WR-RELCALID - A globally unique identifier for the calendar[21]
  • X-WR-TIMEZONE
  • X-PUBLISHED-TTL - Recommended update interval for subscription to the calendar
  • X-ALT-DESC - Used to include HTML markup in an event's description. Standard DESCRIPTION tag should contain non-HTML version.

vCalendar 1.0

iCalendar's design was based on the previous file format vCalendar created by the Internet Mail Consortium (IMC).[22]

Here is an example of information in vCalendar format: 

BEGIN:VCALENDAR
VERSION:1.0
BEGIN:VEVENT
CATEGORIES:MEETING
STATUS:TENTATIVE
DTSTART:19960401T033000Z
DTEND:19960401T043000Z
SUMMARY:Your Proposal Review
DESCRIPTION:Steve and John to review newest proposal material
CLASS:PRIVATE
END:VEVENT
END:VCALENDAR

It has the .vcs file extension. After iCalendar was released, the Internet Mail Consortium stated that it "hopes that all vCalendar developers take advantage of these new open standards and make their software compatible with both vCalendar 1.0 and iCalendar."[23]

Representations

xCal

Main article: xCal

xCal is an XML representation of iCalendar data, as defined in RFC 6321.

jCal

jCal is a JSON representation of iCalendar data, as defined in RFC 7265.

See also

Notes

  1. ^ The standard and file type are sometimes referred to as "iCal", which was the name of the Apple Inc. calendar program until 2012 (see iCal), which provides one of the implementations of the standard.
  2. ^ "IBM Lotus Notes 8.5 iCalendar: Interoperability, implementation, and application". IBM DeveloperWorks. Retrieved 2015-04-05.
  3. ^ "iCalendar.org". Z Content. Retrieved 2018-03-28.
  4. ^ A companion standard, "iCalendar Transport-Independent Interoperability" (iTIP) (RFC 2446), defines a protocol for exchanging iCalendar objects for the purposes of group calendaring and scheduling between "Calendar Users" (CUs); whoever initiates the exchange of data takes on the role of the "Organizer". This standard defines methods such as PUBLISH, REQUEST, REPLY, ADD, CANCEL, REFRESH, COUNTER (to negotiate a change in the entry), and DECLINE-COUNTER (to decline the counter-proposal). Another companion standard, "iCalendar Message-based Interoperability Protocol (iMIP)" (RFC 2447), defines a standard method for implementing iTIP on standard Internet email-based transports. The "Guide to Internet Calendaring" (RFC 3283) explains how iCalendar interacts with other calendar computer language (current and future).
  5. ^ CalConnect, 2004
  6. ^ Although there exist one-to-one mappings between Gregorian and many other calendar scales, the lack of defined CALSCALE values for those calendars and limitations in various date fields can make native support impossible. For example the Hebrew calendar year may contain either 12 or 13 months, and the Japanese Emperor-based calendar scale contains many eras.
  7. ^ "Calendaring and Scheduling Standards Simplification (calsify)". IETF. Retrieved 2015-04-05.
  8. ^ "Calendaring and Scheduling Standards Simplification (calsify)". IETF. Retrieved 2015-04-05.
  9. ^ Lear, Eliot (2010-12-10). "the end of calsify working group– not the end of the mailing list". ietf-calsify mailing list. Retrieved 2015-04-05.
  10. ^ "Calendaring Extensions (calext)". IETF. Retrieved 2016-12-01.
  11. ^ a b From RFC 2445
  12. ^ Note that Apple iCal and Microsoft Outlook use additional descriptors, as follows, to provide further information about the calendar.
    X-WR-CALNAME:Revolution Parties
    X-WR-CALDESC:Celebrations of various revolutionary activities.
    X-WR-RELCALID:3E26604A-50F4-4449-8B3E-E4F4932D05B5
    X-WR-TIMEZONE:US/Pacific

    Where the X-WR-RELCALID is a UUID.
  13. ^ But an event can be set to be "TRANSPARENT" to change this interpretation.
  14. ^ These events would have a DATE value type for the DTSTART property instead of the default DATE-TIME, and need not include a DTEND property.
  15. ^ "[RFC5546] Section 3.4 Methods for VTODO Components". Microsoft Developer Network. Retrieved 7 August 2015.
  16. ^ From RFC 2445.
  17. ^ As described in RFC 2445:

    When used to request free/busy time information, the "ATTENDEE" property specifies the calendar users whose free/busy time is being requested; the "ORGANIZER" property specifies the calendar user who is requesting the free/busy time; the "DTSTART" and "DTEND" properties specify the window of time for which the free/busy time is being requested; the "UID" and "DTSTAMP" properties are specified to assist in proper sequencing of multiple free/busy time requests.

    When used to reply to a request for free/busy time, the "ATTENDEE" property specifies the calendar user responding to the free/busy time request; the "ORGANIZER" property specifies the calendar user that originally requested the free/busy time; the "FREEBUSY" property specifies the free/busy time information (if it exists); and the "UID" and "DTSTAMP" properties are specified to assist in proper sequencing of multiple free/busy time replies.

    When used to publish busy time, the "ORGANIZER" property specifies the calendar user associated with the published busy time; the "DTSTART" and "DTEND" properties specify an inclusive time window that surrounds the busy time information; the "FREEBUSY" property specifies the published busy time information; and the "DTSTAMP" property specifies the date/time that iCalendar object was created.
  18. ^ From RFC 2445 The iCalendar object might be placed at some URL with the extension ".ifb"
  19. ^ Some components are often defined to support other components defined after them (VTIMEZONE is often used this way).[clarification needed]
  20. ^ An example UID might be "Y2007S2C131M5@example.edu", for the 5th meeting of class 131 in semester 2 at a hypothetical college.
  21. ^ "[MS-OXCICAL]: Property: X-WR-RELCALID". msdn.microsoft.com. Retrieved 2016-02-23.
  22. ^ "vCalendar: The Electronic Calendaring and Scheduling Exchange Format, Version 1.0". Internet Mail Consortium. 1996-09-18. Archived from the original on 2016-03-21. Retrieved 2018-03-28. {{cite web}}: Unknown parameter |deadurl= ignored (|url-status= suggested) (help)
  23. ^ "Personal Data Interchange - vCard and vCalendar". Internet Mail Consortium. 2006-11-26. Archived from the original on 2015-09-06. Retrieved 2016-02-28. {{cite web}}: Unknown parameter |deadurl= ignored (|url-status= suggested) (help)
  • RFC 5545 Internet Calendaring and Scheduling Core Object Specification (iCalendar) (replaces RFC 2445)
  • RFC 5546 iCalendar Transport-Independent Interoperability Protocol (iTIP) (replaces RFC 2446)
  • RFC 6047 iCalendar Message-Based Interoperability Protocol (iMIP) (replaces RFC 2447)
  • RFC 6321 xCal: The XML format for iCalendar (iCalendar XML Representation)
  • RFC 6868: update of the data formats for including certain characters, forbidden by the existing specification, in parameter values
  • RFC 7265 jCal: The JSON Format for iCalendar
  • RFC 7986 New Properties for iCalendar (additional properties to the iCalendar specification)
  • "An Introduction to Internet Calendaring and Scheduling". CalConnect. 2011-10-20.
  • "Personal Data Interchange - vCard and vCalendar". Internet Mail Consortium. Archived from the original on 2017-02-27. - This describes the relationship of vCard, vCalendar, and iCalendar, and includes IMC's request for implementors to support both vCalendar and iCalendar.
  • "iCalendar Resources". - A list of resources for iCalendar and related standards.
Retrieved from "https://en.wikipedia.org/w/index.php?title=ICalendar&oldid=859471123"