From d0b6c661528c5d7ae0f7fb3d393797aad2a291f8 Mon Sep 17 00:00:00 2001 From: Jack Kamm Date: Sun, 12 Jan 2025 13:10:34 -0800 Subject: [PATCH] org-(export,icalendar)-with-timestamps: active-exclude-diary option * lisp/ox.el (org-export-with-timestamps): Add option `active-exclude-diary' to export active timestamps without diary timestamps. (org-export--skip-p): Use new helper function `org-export--skip-timestamp-p'. (org-export--skip-timestamp-p): Helper function to decide whether to skip a timestamp during export * lisp/ox-icalendar.el (org-icalendar-with-timestamps): Add option `active-exclude-diary' to export active timestamps without diary timestamps. (org-icalendar-entry): Use new helper function `org-export--skip-timestamp-p' to decide whether to skip a timestamp. * testing/lisp/test-ox-icalendar.el (test-ox-icalendar/exclude-diary-timestamp): Test that diary timestamp is excluded when `active-exclude-diary'. --- etc/ORG-NEWS | 4 ++++ lisp/ox-icalendar.el | 29 ++++++++++++++--------- lisp/ox.el | 39 ++++++++++++++++++++----------- testing/lisp/test-ox-icalendar.el | 15 ++++++++++++ 4 files changed, 63 insertions(+), 24 deletions(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index aebd0dedd..3b86ece18 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -100,6 +100,10 @@ This should have minimal impact on non-iCalendar exporters, since users who manually set ~org-export-with-timestamps~ to ~active~ will now have diary timestamps included as well. +To export active timestamps only without diary timestamps, users can +set ~org-export-with-timestamps~ and ~org-icalendar-with-timestamps~ +to ~active-exclude-diary~. + *** =ob-calc.el=: Vector and matrix are now inserted as Org tables by default ~ob-calc~ now formats vector and matrix results as Org tables. This diff --git a/lisp/ox-icalendar.el b/lisp/ox-icalendar.el index bb01f1a22..da6339381 100644 --- a/lisp/ox-icalendar.el +++ b/lisp/ox-icalendar.el @@ -202,18 +202,27 @@ (defcustom org-icalendar-categories '(local-tags category) (defcustom org-icalendar-with-timestamps 'active "Non-nil means make an event from plain time stamps. -It can be set to `active', `inactive', t or nil, in order to make -an event from, respectively, only active timestamps, only -inactive ones, all of them or none. +It can be set to `active', `active-exclude-diary', `inactive', t +or nil, in order to make an event from, respectively, only active +timestamps (with/without diary timestamps), only inactive ones, +all of them or none. + +This variable has the same options as +`org-export-with-timestamps', and takes precedence over it. +However, note that this variable applies to all timestamps within +an entry, whereas `org-export-with-timestamps' only applies to +timestamps isolated in a paragraph containing only timestamps. -This variable has precedence over `org-export-with-timestamps'. It can also be set with the #+OPTIONS line, e.g. \"<:t\"." :group 'org-export-icalendar :type '(choice (const :tag "All timestamps" t) - (const :tag "Only active timestamps" active) + (const :tag "Active timestamps, including diary timestamps" active) + (const :tag "Active timestamps, excluding diary timestamps" + active-exclude-diary) (const :tag "Only inactive timestamps" inactive) - (const :tag "No timestamp" nil))) + (const :tag "No timestamp" nil)) + :safe (lambda (x) (memq x '(t nil active active-exclude-diary inactive)))) (defcustom org-icalendar-include-todo nil "Non-nil means create VTODO components from TODO items. @@ -744,11 +753,9 @@ (defun org-icalendar-entry (entry contents info) (org-element-contents inside)) 'timestamp (lambda (ts) - (when (let ((type (org-element-property :type ts))) - (cl-case (plist-get info :with-timestamps) - (active (memq type '(active active-range diary))) - (inactive (memq type '(inactive inactive-range))) - ((t) t))) + (unless (org-export--skip-timestamp-p + (plist-get info :with-timestamps) + (org-element-property :type ts)) (let ((uid (format "TS%d-%s" (cl-incf counter) uid))) (org-icalendar--vevent entry ts uid summary loc desc cat tz class)))) diff --git a/lisp/ox.el b/lisp/ox.el index 6ef0d2699..646d09b51 100644 --- a/lisp/ox.el +++ b/lisp/ox.el @@ -802,10 +802,11 @@ (defcustom org-export-with-timestamps t "Non-nil means allow timestamps in export. It can be set to any of the following values: - t export all timestamps. - `active' export active timestamps only. - `inactive' export inactive timestamps only. - nil do not export timestamps + t export all timestamps. + `active' export active timestamps, including diary timestamps. + `active-exclude-diary' export active timestamps, excluding diary timestamps. + `inactive' export inactive timestamps only. + nil do not export timestamps This only applies to timestamps isolated in a paragraph containing only timestamps. Other timestamps are always @@ -816,10 +817,12 @@ (defcustom org-export-with-timestamps t :group 'org-export-general :type '(choice (const :tag "All timestamps" t) - (const :tag "Only active timestamps" active) + (const :tag "Active timestamps, including diary timestamps" active) + (const :tag "Active timestamps, excluding diary timestamps" + active-exclude-diary) (const :tag "Only inactive timestamps" inactive) (const :tag "No timestamp" nil)) - :safe (lambda (x) (memq x '(t nil active inactive)))) + :safe (lambda (x) (memq x '(t nil active active-exclude-diary inactive)))) (defcustom org-export-with-todo-keywords t "Non-nil means include TODO keywords in export. @@ -1857,13 +1860,23 @@ (defun org-export--skip-p (datum options selected excluded) (lambda (obj) (or (not (stringp obj)) (org-string-nw-p obj))) options t)))) - (cl-case (plist-get options :with-timestamps) - ((nil) t) - (active - (not (memq (org-element-property :type datum) '(active active-range diary)))) - (inactive - (not (memq (org-element-property :type datum) - '(inactive inactive-range))))))))) + (org-export--skip-timestamp-p + (plist-get options :with-timestamps) + (org-element-property :type datum)))))) + +(defun org-export--skip-timestamp-p (with-timestamps timestamp-type) + "Decides whether to skip a timestamp during export. +WITH-TIMESTAMPS should be a valid option for +`org-export-with-timestamps'. TIMESTAMP-TYPE should be the +`:type' property of a timestamp element." + (cl-case with-timestamps + ((nil) t) + (active + (not (memq timestamp-type '(active active-range diary)))) + (active-exclude-diary + (not (memq timestamp-type '(active active-range)))) + (inactive + (not (memq timestamp-type '(inactive inactive-range)))))) ;;; The Transcoder diff --git a/testing/lisp/test-ox-icalendar.el b/testing/lisp/test-ox-icalendar.el index c7c74c526..8c0ab6377 100644 --- a/testing/lisp/test-ox-icalendar.el +++ b/testing/lisp/test-ox-icalendar.el @@ -143,5 +143,20 @@ (ert-deftest test-ox-icalendar/diary-timestamp () (should (search-forward "RRULE:FREQ=MONTHLY;BYDAY=1SU")))) (when (file-exists-p tmp-ics) (delete-file tmp-ics))))) +(ert-deftest test-ox-icalendar/exclude-diary-timestamp () + "Test icalendar exclude of diary timestamps." + (let* ((org-icalendar-with-timestamps 'active-exclude-diary) + (tmp-ics (org-test-with-temp-text-in-file + "* Test entry with 2 timestamps +<%%(diary-float t 0 1)> +<2025-01-12 Sunday>" + (expand-file-name (org-icalendar-export-to-ics))))) + (unwind-protect + (with-temp-buffer + (insert-file-contents tmp-ics) + (save-excursion + (should (not (search-forward "RRULE:FREQ=MONTHLY;BYDAY=1SU" nil t))))) + (when (file-exists-p tmp-ics) (delete-file tmp-ics))))) + (provide 'test-ox-icalendar) ;;; test-ox-icalendar.el ends here -- 2.47.1