Glossary

components

component

The body of the iCalendar object consists of a sequence of calendar properties and one or more calendar components. The calendar properties are attributes that apply to the calendar object as a whole. The calendar components are collections of properties that express a particular calendar semantic. For example, the calendar component can specify an event, a to-do, a journal entry, time zone information, free/busy time information, or an alarm.

All calendar components start with the letter "V". For example, "VEVENT" refers to the event calendar component.

See also

RFC 5545 Section 3.6

icalendar

This Python package, with a lower-case "c", used for parsing and generating iCalendar files following various RFC standards.

iCalendar

The RFC called Internet Calendaring and Scheduling Core Object Specification (iCalendar), with an upper-case "C". Files that follow the iCalendar specification are called iCalendar files.

iCalendar file

iCalendar files

A file with iCalendar content. The file name extension is ics.

jCal

The RFC called jCal: The JSON Format for iCalendar, with an upper-case "C". Files that follow the jCal specification are called jCal files.

jCal file

jCal files

A file with iCalendar content. The recommended file name extension is json. icalendar uses jcal in tests and examples.

properties

property

A property in an iCalendar file is the definition of an individual attribute describing a calendar object or a calendar component. A property takes the form defined by the "contentline" notation defined in RFC 5545 Section 3.1.

The body of an iCalendar file consists of a sequence of calendar properties and one or more calendar components.

See also

RFC 5545 Section 3.5

round-trip

A round-trip happens when a calendar is converted into at least one other representation and back. Examples of a round-trip are:

• A calendar file is read into icalendar and converted back to the original calendar file format.

• A calendar is created with Calendar.new, converted to xCal using to_xcal(), and then read back into a Calendar object using from_xcal().

Vale

Vale is an open-source, command-line tool that helps maintain a consistent and on-brand voice in documentation. icalendar documentation uses it to check spelling, English grammar and syntax, and style guides.

xCal

The RFC called xCal: The XML Format for iCalendar, with an upper-case "C". Files that follow the xCal specification are called xCal files.

xCal file

xCal files

A file with xCal content. No file name extension is standardized. icalendar uses xml.