Variable: diary-icalendar-vevent-format-function

diary-icalendar-vevent-format-function is a customizable variable defined in diary-icalendar.el.gz.

Value

diary-icalendar-vevent-skeleton

Documentation

Function to format VEVENT components for the diary.

This function is called with one argument VEVENT, an icalendar-vevent. It should insert formatted data from this event into the current buffer. It is convenient to express such a function as a skeleton; see define-skeleton and skeleton-insert for more information. See icalendar-with-component for a convenient way to bind the data in VEVENT.

For convenience when writing this function as a skeleton, the following variables will be (dynamically) bound when the function is called. All values will be strings unless another type is noted, or nil:

ical-as-alarm (symbol) - non-nil when the event should be formatted for an
  alarm notification in advance of the event. The symbol indicates the
  type of alarm: email means to format the event as the body of an email.
  (Currently only used for EMAIL alarms; see diary-icalendar-export-alarms.)
ical-attachments (list of strings) - URLs or filenames of attachments
  in the event
ical-attendees (list of strings) - the participants of the event,
  formatted by diary-icalendar-attendee-format-function
ical-categories (list of strings) - categories specified in the event ical-access - the event's access classification ical-comments (list of strings) - comments specified in the event ical-description - the event's description ical-start - start date and time in a single string. When importing,
  includes the date, otherwise just the (local) time.
ical-end - end date and time in a single string. When importing,
  includes the date, otherwise just the (local) time.
ical-start-to-end - a single string containing both start and end date and
  (local) time. If the event starts and ends on the same day, the date
  is not repeated. When importing, dates are included, and the string
  may contain a diary s-exp; when displaying, the string contains only
  the times for the displayed date. If there is no end date, same as
  ical-start.
ical-importing (a boolean) - t if the event should be formatted for import.
  When nil, the event should be formatted for display rather than import.
  When importing it is important to include all information from the event
  that you want to be saved in the diary; when displaying, information like
  the date (or date-related S-expressions) and UID can be left out.
ical-location - the event's location, or geographical coordinates ical-nonmarking (a boolean) - if non-nil, the diary entry should be nonmarking ical-organizer - the event's organizer, formatted by
  diary-icalendar-attendee-format-function
ical-priority (a number) - the event's priority (1 = highest priority,
  9 = lowest; 0 = undefined)
ical-rrule-sexp - a string containing a diary S-expression for a
  recurring event. If this is non-nil, you should normally use it
  instead of the start-* and end-* variables to form the date of the
  entry.
ical-status - overall status specified by the organizer (e.g. "confirmed") ical-summary - a summary of the event ical-transparency - the event's time transparency status, either
  "OPAQUE" (busy) or "TRANSPARENT" (free); see icalendar-transp
ical-uid - the unique identifier of the event ical-url - a URL for the event

This variable was added, or its default value changed, in Emacs 31.1.

View in manual

Source Code

;; Defined in /usr/src/emacs/lisp/calendar/diary-icalendar.el.gz