From: Tim Visher <tim.visher@gmail.com>
To: Ihor Radchenko <yantar92@posteo.net>
Cc: Emacs Org Mode mailing list <emacs-orgmode@gnu.org>
Subject: Re: [PATCH] org-capture.el: Allow `(here)' as a template target
Date: Wed, 21 Jun 2023 14:30:27 -0400 [thread overview]
Message-ID: <CAHa53uzfSZjQJBT6MvLCcAZdJWjvVusVKhkS9CHJ2kZ=myF0MA@mail.gmail.com> (raw)
In-Reply-To: <87352kerhb.fsf@localhost>
[-- Attachment #1.1: Type: text/plain, Size: 1323 bytes --]
On Wed, Jun 21, 2023 at 11:54 AM Ihor Radchenko <yantar92@posteo.net> wrote:
> Tim Visher <tim.visher@gmail.com> writes:
>
> >> Also, may you update the docstring of `org-capture-templates'
> >
> >
> > Good catch! This has been done in patch 0004 now. Look good?
>
> Yup.
>
👍
>> "10.1.3.1 Template elements" section of Org manual?
> >
> > I'm confused about what you're referring to here. Isn't that what 0002
> does?
>
> Yes, it does. I saw it, then noticed the missing `org-capture-templates'
> docstring update, and somehow deduced that manual must be missing
> :facepalm:
>
👍
> > Again, happy to squash and provide a single complete patch once we're all
> > done the review. Thanks again, Ihor! :)
>
> Please, also add all the necessary changelog entries to the final commit
> message.
>
Will do! I've attached a prospective patch file but I'm not sure I follow
what you mean by 'add all the necessary changelog entries to the final
commit
message'. Looking at this commit
<https://git.savannah.gnu.org/cgit/emacs/org-mode.git/commit/?id=294a4d2fe21ffcdc1acbbafed1bfc69a1ece7d13>
I'm guessing that I should have an `* …` entry for every file except
`etc/NEWS` that I changed so I've done that but please do let me know if
that was the wrong interpretation. :)
[-- Attachment #1.2: Type: text/html, Size: 2149 bytes --]
[-- Attachment #2: 0001-org-capture.el-Allow-here-as-a-template-target 3.patch --]
[-- Type: application/octet-stream, Size: 3288 bytes --]
From 42fb53de48e51639cfd6fc9cc5a24bde051f24e5 Mon Sep 17 00:00:00 2001
From: Tim Visher <tim.visher@gmail.com>
Date: Fri, 12 May 2023 11:32:21 -0400
Subject: [PATCH] org-capture.el: Allow `(here)' as a template target
* lisp/org-capture.el (org-capture-set-target-location): Allow
`(here)' as a template target in addition to `here'.
Templates had no user accessible way to target the current location
directly from a capture template. Attempting to directly utilize the
behavior accessible through a 0 prefix arg exposed the inconsistent
treatment of the `:target` property in
`org-capture`. `org-capture-set-target-location` understood that it
could be both a symbol and a list, while `org-capture` itself required
it to be a list through its use of `car`.
This change opts to make `org-capture-set-target-location` more
liberal in what it accepts rather than making `org-capture` agree that
targets can be lists. This is because the manual implies, especially
in the `(clock)' entry, that targets are expected to be lists even if
they are meant as specific points.
* doc/org-manual.org (Template elements): Add `(here)' target
documentation
TINYCHANGE
---
doc/org-manual.org | 4 ++++
etc/ORG-NEWS | 5 +++++
lisp/org-capture.el | 6 +++++-
3 files changed, 14 insertions(+), 1 deletion(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index 21582fe8e..76131f110 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -7946,6 +7946,10 @@ Now lets look at the elements of a template definition. Each entry in
File to the entry that is currently being clocked.
+ - =(here)= ::
+
+ The position of =point=.
+
- =(function function-finding-location)= ::
Most general way: write your own function which both visits the
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 94efa8fa8..01d2975d3 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -303,6 +303,11 @@ skipped (with a warning) if the ox-icalendar export encounters them:
Also note that only vanilla repeaters are currently exported; the
special repeaters ~++~ and ~.+~ are skipped.
+*** Capture templates now support ~(here)~ as a target
+
+A capture template can target ~(here)~ which is the equivalent of
+invoking a capture template with a zero prefix.
+
** Miscellaneous
*** =org-crypt.el= now applies initial visibility settings to decrypted entries
diff --git a/lisp/org-capture.el b/lisp/org-capture.el
index d4311dd20..40a7f78f1 100644
--- a/lisp/org-capture.el
+++ b/lisp/org-capture.el
@@ -220,6 +220,9 @@ target Specification of where the captured item should be placed.
(clock)
File to the entry that is currently being clocked
+ (here)
+ The position of point
+
(function function-finding-location)
Most general way: write your own function which both visits
the file and moves point to the right location
@@ -991,7 +994,8 @@ Store them in the capture property list."
(let ((target-entry-p t))
(save-excursion
(pcase (or target (org-capture-get :target))
- (`here
+ ((or `here
+ `(here))
(org-capture-put :exact-position (point) :insert-here t))
(`(file ,path)
(set-buffer (org-capture-target-buffer path))
--
2.40.1
next prev parent reply other threads:[~2023-06-21 18:31 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-12 15:35 [PATCH] org-capture.el: Allow `(here)' as a template target Tim Visher
2023-05-12 16:35 ` Ihor Radchenko
2023-06-20 19:32 ` Tim Visher
2023-06-21 10:33 ` Ihor Radchenko
2023-06-21 13:12 ` Tim Visher
2023-06-21 15:59 ` Ihor Radchenko
2023-06-21 18:30 ` Tim Visher [this message]
2023-06-22 10:18 ` Ihor Radchenko
2023-06-22 13:53 ` Tim Visher
2023-06-23 10:58 ` Ihor Radchenko
2023-06-23 12:02 ` Tim Visher
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAHa53uzfSZjQJBT6MvLCcAZdJWjvVusVKhkS9CHJ2kZ=myF0MA@mail.gmail.com' \
--to=tim.visher@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@posteo.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).