From 9858c2acc3aef0561dacd740d2ee353f77239fe2 Mon Sep 17 00:00:00 2001 From: Jason Dunsmore Date: Wed, 6 Nov 2019 21:49:43 -0600 Subject: [PATCH] org-capture.el: Add support for month trees * doc/org-manual.org: Add `:tree-type month' option for capture templates. * etc/ORG-NEWS: Document new `:tree-type month' option. * lisp/org-capture.el (org-capture-set-target-location): Add `:tree-type month' option to capture templates to group entries by month. * lisp/org-datetree.el (org-datetree-find-month-create): Add `org-datetree-find-month-create' function to add datetree entries grouped by month. * testing/lisp/test-org-datetree.el (test-org-datetree/find-month-create): Add test for new function. --- doc/org-manual.org | 7 ++++--- etc/ORG-NEWS | 5 ++++- lisp/org-capture.el | 10 +++++++--- lisp/org-datetree.el | 27 +++++++++++++++++++++++---- testing/lisp/test-org-datetree.el | 11 +++++++++++ 5 files changed, 49 insertions(+), 11 deletions(-) diff --git a/doc/org-manual.org b/doc/org-manual.org index 5e69ef074..cd133739d 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -7592,9 +7592,10 @@ Now lets look at the elements of a template definition. Each entry in - ~:tree-type~ :: - When ~week~, make a week tree instead of the month tree, i.e., - place the headings for each day under a heading with the current - ISO week. + Use ~week~ to make a week tree instead of the month-day tree, + i.e., place the headings for each day under a heading with the + current ISO week. Use @code{month} to group entries by month + only. Default is to group entries by day. - ~:unnarrowed~ :: diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index bdcfc24fd..35e8d2864 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -335,7 +335,9 @@ the headline to use for making the table of contents. ,* Another section ,#+TOC: headlines 1 :target "#TargetSection" #+end_example - +*** New option to group captured datetime entries by month +A new `:tree-type month' option was added to org-capture-templates to +group new datetime entries by month. ** New functions *** ~org-dynamic-block-insert-dblock~ @@ -348,6 +350,7 @@ dynamic block in ~org-dynamic-block-alist~. *** ~org-table-cell-left~ *** ~org-table-cell-right~ *** ~org-habit-toggle-display-in-agenda~ +*** ~org-datetree-find-month-create~ ** Removed functions and variables *** Removed Org Drill diff --git a/lisp/org-capture.el b/lisp/org-capture.el index 4f97e17ea..ab0db0c27 100644 --- a/lisp/org-capture.el +++ b/lisp/org-capture.el @@ -998,9 +998,13 @@ Store them in the capture property list." ;; Make a date/week tree entry, with the current date (or ;; yesterday, if we are extending dates for a couple of hours) (funcall - (if (eq (org-capture-get :tree-type) 'week) - #'org-datetree-find-iso-week-create - #'org-datetree-find-date-create) + (cond + ((eq (org-capture-get :tree-type) 'week) + #'org-datetree-find-iso-week-create) + ((eq (org-capture-get :tree-type) 'month) + #'org-datetree-find-month-create) + (t + #'org-datetree-find-date-create)) (calendar-gregorian-from-absolute (cond (org-overriding-default-time diff --git a/lisp/org-datetree.el b/lisp/org-datetree.el index b4797de1e..0ae3cf6ec 100644 --- a/lisp/org-datetree.el +++ b/lisp/org-datetree.el @@ -51,11 +51,29 @@ Added time stamp is active unless value is `inactive'." ;;;###autoload (defun org-datetree-find-date-create (d &optional keep-restriction) - "Find or create an entry for date D. + "Find or create a day entry for date D. If KEEP-RESTRICTION is non-nil, do not widen the buffer. When it is nil, the buffer will be widened to make sure an existing date tree can be found. If it is the symbol `subtree-at-point', then the tree will be built under the headline at point." + (org-datetree--find-create-group d 'day keep-restriction)) + +;;;###autoload +(defun org-datetree-find-month-create (d &optional keep-restriction) + "Find or create a month entry for date D. +Compared to `org-datetree-find-date-create' this function creates +entries grouped by month instead of days. +If KEEP-RESTRICTION is non-nil, do not widen the buffer. +When it is nil, the buffer will be widened to make sure an existing date +tree can be found. If it is the symbol `subtree-at-point', then the tree +will be built under the headline at point." + (org-datetree--find-create-group d 'month keep-restriction)) + +(defun org-datetree--find-create-group + (d time-grouping &optional keep-restriction) + "Find or create an entry for date D. +If time-period is day, group entries by day. If time-period is +month, then group entries by month." (setq-local org-datetree-base-level 1) (save-restriction (if (eq keep-restriction 'subtree-at-point) @@ -84,9 +102,10 @@ will be built under the headline at point." (org-datetree--find-create "^\\*+[ \t]+%d-\\([01][0-9]\\) \\w+$" year month) - (org-datetree--find-create - "^\\*+[ \t]+%d-%02d-\\([0123][0-9]\\) \\w+$" - year month day)))) + (if (eq time-grouping 'day) + (org-datetree--find-create + "^\\*+[ \t]+%d-%02d-\\([0123][0-9]\\) \\w+$" + year month day))))) ;;;###autoload (defun org-datetree-find-iso-week-create (d &optional keep-restriction) diff --git a/testing/lisp/test-org-datetree.el b/testing/lisp/test-org-datetree.el index 5d55f6fc6..5557d5e23 100644 --- a/testing/lisp/test-org-datetree.el +++ b/testing/lisp/test-org-datetree.el @@ -113,6 +113,17 @@ (org-datetree-find-date-create '(3 29 2012))) (buffer-substring (point) (line-end-position)))))) +(ert-deftest test-org-datetree/find-month-create () + "Test `org-datetree-find-month-create' specifications." + ;; When date is missing, create it with the entry under month. + (should + (string-match + "\\`\\* 2012\n\\*\\* 2012-03 .*\\'" + (org-test-with-temp-text "" + (let ((org-datetree-add-timestamp nil)) + (org-datetree-find-month-create '(3 29 2012))) + (org-trim (buffer-string)))))) + (ert-deftest test-org-datetree/find-iso-week-create () "Test `org-datetree-find-iso-date-create' specificaiton." ;; When date is missing, create it. -- 2.17.1