Variable: diary-icalendar-vtodo-format-function

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

Value

diary-icalendar-vtodo-skeleton

Documentation

Function to format VTODO components for the diary.

This function is called with one argument VTODO, an icalendar-vtodo. It should insert formatted data from this task 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 VTODO.

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 task should be formatted for
  an alarm notification in advance of the task. The symbol indicates
  the type of alarm: email means to format the task 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 task
ical-attendees (list of strings) - the participants of the task,
  formatted by diary-icalendar-attendee-format-function
ical-categories (list of strings) - categories specified in the task ical-access - the task's access classification ical-comments (list of strings) - comments specified in the task ical-completed - when the task was completed, formatted as a local
  date-time string
ical-description - the task's description ical-start - start-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 due date
  and time. If the task 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-due - due date and time in a single string ical-end - same as ical-due ical-work-time-sexp - when the task has both a start date and a due date,
  this is a %%(diary-time-block ...) diary S-expression representing the
  time from the start date to the due date (only non-nil when
  importing). You can use this e.g. to make a separate entry for the
  task's work time, so that it shows up every day in the diary until it
  is due.
ical-importing (a boolean) - t if the task should be formatted for import.
  When nil, the task should be formatted for display rather than import.
  When importing it is important to include all information from the task
  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 task's location, or geographical coordinates ical-nonmarking (a boolean) - if non-nil, the diary entry should be nonmarking ical-organizer - the task's organizer, formatted by
  diary-icalendar-attendee-format-function
ical-percent-complete (a number between 0 and 100) - the percentage of
  the task which has already been completed
ical-priority (a number) - the task's priority (1 = highest priority,
  9 = lowest; 0 = undefined)
ical-rrule-sexp - a string containing a diary S-expression for a
  recurring task (only non-nil when importing). When 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 task ical-uid - the unique identifier of the task ical-url - a URL for the task

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:vtodo-format-function #'di:vtodo-skeleton
  "Function to format VTODO components for the diary.

This function is called with one argument VTODO, an `icalendar-vtodo'.
It should insert formatted data from this task 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
VTODO.

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 task should be formatted for
  an alarm notification in advance of the task.  The symbol indicates
  the type of alarm: `email' means to format the task 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 task
`ical-attendees' (list of strings) - the participants of the task,
  formatted by `diary-icalendar-attendee-format-function'
`ical-categories' (list of strings) - categories specified in the task
`ical-access' - the task's access classification
`ical-comments' (list of strings) - comments specified in the task
`ical-completed' - when the task was completed, formatted as a local
  date-time string
`ical-description' - the task's description
`ical-start' - start-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 due date
  and time.  If the task 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-due' - due date and time in a single string
`ical-end' - same as `ical-due'
`ical-work-time-sexp' - when the task has both a start date and a due date,
  this is a %%(diary-time-block ...) diary S-expression representing the
  time from the start date to the due date (only non-nil when
  importing).  You can use this e.g. to make a separate entry for the
  task's work time, so that it shows up every day in the diary until it
  is due.
`ical-importing' (a boolean) - t if the task should be formatted for import.
  When nil, the task should be formatted for display rather than import.
  When importing it is important to include all information from the task
  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 task's location, or geographical coordinates
`ical-nonmarking' (a boolean) - if non-nil, the diary entry should be nonmarking
`ical-organizer' - the task's organizer, formatted by
  `diary-icalendar-attendee-format-function'
`ical-percent-complete' (a number between 0 and 100) - the percentage of
  the task which has already been completed
`ical-priority' (a number) - the task's priority (1 = highest priority,
  9 = lowest; 0 = undefined)
`ical-rrule-sexp' - a string containing a diary S-expression for a
  recurring task (only non-nil when importing).  When 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 task
`ical-uid' - the unique identifier of the task
`ical-url' - a URL for the task"
  :version "31.1"
  :type '(radio (function-item di:vjournal-skeleton)
                (function :tag "Other function")))