Variable: diary-icalendar-vjournal-format-function

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

Value

diary-icalendar-vjournal-skeleton

Documentation

Function to format VJOURNAL components for the diary.

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

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-attachments (list of strings) - URLs or filenames of attachments
  in the journal entry
ical-attendees (list of strings) - the participants of the journal entry,
  formatted by diary-icalendar-attendee-format-function
ical-categories (list of strings) - categories specified in the journal entry ical-access - the journal entry's access classification ical-comments (list of strings) - comments specified in the journal entry ical-description - the journal entry's description(s) as a single
  string, separated by newlines (more than one description is allowed in
  VJOURNAL components)
ical-start - start date and time in a single string. When importing,
  includes the date, otherwise just the (local) time.
ical-importing (a boolean) - t if the journal entry should be
  formatted for import. When nil, the entry should be formatted for
  display rather than import. When importing it is important to include
  all information from the entry 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-nonmarking (a boolean) - if non-nil, the diary entry should be nonmarking ical-organizer - the journal entry's organizer, formatted by
  diary-icalendar-attendee-format-function
ical-rrule-sexp - a string containing a diary S-expression for a recurring
  journal entry. If this is non-nil, you should normally use it instead
  of the start-* variables to form the date of the entry.
ical-status - overall status specified by the organizer (e.g. "draft") ical-summary - a summary of the journal entry ical-uid - the unique identifier of the journal entry ical-url - a URL for the journal entry

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
(defcustom di:vjournal-format-function #'di:vjournal-skeleton
  "Function to format VJOURNAL components for the diary.

This function is called with one argument VJOURNAL, an
`icalendar-vjournal'.  It should insert formatted data from this journal
entry into the current buffer.  It is convenient to express such a
function as a skeleton; see `define-skeleton' and `skeleton-insert' for
more information, and see `diary-icalendar-vjournal-skeleton' for an
example.  See `icalendar-with-component' for a convenient way to bind
the data in VJOURNAL.

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-attachments' (list of strings) - URLs or filenames of attachments
  in the journal entry
`ical-attendees' (list of strings) - the participants of the journal entry,
  formatted by `diary-icalendar-attendee-format-function'
`ical-categories' (list of strings) - categories specified in the journal entry
`ical-access' - the journal entry's access classification
`ical-comments' (list of strings) - comments specified in the journal entry
`ical-description' - the journal entry's description(s) as a single
  string, separated by newlines (more than one description is allowed in
  VJOURNAL components)
`ical-start' - start date and time in a single string.  When importing,
  includes the date, otherwise just the (local) time.
`ical-importing' (a boolean) - t if the journal entry should be
  formatted for import.  When nil, the entry should be formatted for
  display rather than import.  When importing it is important to include
  all information from the entry 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-nonmarking' (a boolean) - if non-nil, the diary entry should be nonmarking
`ical-organizer' - the journal entry's organizer, formatted by
  `diary-icalendar-attendee-format-function'
`ical-rrule-sexp' - a string containing a diary S-expression for a recurring
  journal entry.  If this is non-nil, you should normally use it instead
  of the start-* variables to form the date of the entry.
`ical-status' - overall status specified by the organizer (e.g. \"draft\")
`ical-summary' - a summary of the journal entry
`ical-uid' - the unique identifier of the journal entry
`ical-url' - a URL for the journal entry"
  :version "31.1"
  :type '(radio (function-item di:vjournal-skeleton)
                (function :tag "Other function")))