Variable: diary-icalendar-other-properties-parser

diary-icalendar-other-properties-parser is a customizable variable defined in diary-icalendar.el.gz.

Value

nil

Documentation

Function to parse additional iCalendar properties from diary entries.

If you like to keep your diary entries in a particular format, you can set this to a function which parses that format to iCalendar properties during iCalendar export, so that other calendar applications can use them.

The parsing function will be called with the current restriction set to the boundaries of a diary entry. If diary-icalendar-export-linewise is non-nil, the restriction will correspond to a single event in a multi-line diary entry.

The function should accept two arguments, TYPE and PROPERTIES. TYPE is the iCalendar type symbol (one of 'icalendar-vevent,
'icalendar-vjournal, or 'icalendar-vtodo) for the component being
generated for the entry. PROPERTIES is the list of property nodes that diary-icalendar-parse-entry has already parsed from the entry and will be included in the exported component.

The function should return a list of iCalendar property nodes, which
(in addition to PROPERTIES) will be incorporated into the
icalendar-vevent, icalendar-vjournal, or icalendar-vtodo component node created from the current entry. See the docstrings of those symbols for more information on the properties they can contain, and the icalendar-make-property macro for a simple way to create property nodes from values parsed from the 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:other-properties-parser nil
  "Function to parse additional iCalendar properties from diary entries.

If you like to keep your diary entries in a particular format, you can
set this to a function which parses that format to iCalendar properties
during iCalendar export, so that other calendar applications can use
them.

The parsing function will be called with the current restriction set to
the boundaries of a diary entry.  If `diary-icalendar-export-linewise'
is non-nil, the restriction will correspond to a single event in a
multi-line diary entry.

The function should accept two arguments, TYPE and PROPERTIES.  TYPE is
the iCalendar type symbol (one of \\='icalendar-vevent,
\\='icalendar-vjournal, or \\='icalendar-vtodo) for the component being
generated for the entry.  PROPERTIES is the list of property nodes that
`diary-icalendar-parse-entry' has already parsed from the entry and will
be included in the exported component.

The function should return a list of iCalendar property nodes, which
(in addition to PROPERTIES) will be incorporated into the
`icalendar-vevent', `icalendar-vjournal', or `icalendar-vtodo' component
node created from the current entry.  See the docstrings of those
symbols for more information on the properties they can contain, and the
`icalendar-make-property' macro for a simple way to create property
nodes from values parsed from the entry."
  :version "31.1"
  :type '(radio (const :tag "Do not parse additional properties" nil)
                (function :tag "Parsing function")))