emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Visuwesh <visuweshm@gmail.com>
To: org-mode-email <emacs-orgmode@gnu.org>
Subject: Bad interaction between org-capture entry type and file+function target?
Date: Thu, 21 Nov 2024 11:16:45 +0530	[thread overview]
Message-ID: <87h681b0l6.fsf@gmail.com> (raw)

[-- Attachment #1: Type: text/plain, Size: 2495 bytes --]

In the attached file "test.org", I want to capture new headings above
"Projects" always.  To achieve this, I used a file+function target to
move the point above "Projects" like below

    (let* ((heading "test")
           (file "tttt.pdf")
           (org-capture-templates
        `(("n" "blah"
               entry
               (file+function "/tmp/test.org"
                              ,(lambda ()
                     (goto-char (point-min))
                     (re-search-forward "^\\* Projects")
                     (goto-char (match-beginning 0))
                     (insert "\n")
                     (forward-char -1)))
           ,(concat "* " heading "\n"
                ":PROPERTIES:\n"
                ":NOTER_DOCUMENT: " file "\n"
                ":END:\n\n")
           :immediate-finish t
           :empty-lines-before 1))))
      (org-capture nil "n"))

However, when evaluating this sexp, the heading "test" is always
appended to the end of file contrary to what the docstring says:

    (file+function "path/to/file" function-finding-location)
        A function to find the right location in the file

This is because of the 'else' clause in the cond form in
org-capture-place-entry:

    (when exact-position (goto-char exact-position))
    (cond
     ;; Force insertion at point.
     (insert-here?
      ....)
     ;; Insert as a child of the current entry.
     ((org-capture-get :target-entry-p)
      ...)
     ;; Insert as a top-level entry at the beginning of the file.
     (reversed?
      ...)
     ;; Otherwise, insert as a top-level entry at the end of the file.
     (t (goto-char (point-max))
        ^^^^^^^^^^^^^^^^^^^^^^^
        ;; Make sure that last point is not folded.
        (org-fold-core-cycle-over-indirect-buffers
          (org-fold-region (max 1 (1- (point-max))) (point-max) nil))))

Should this be here?  Am I misunderstanding the documentation?  After
all, it is too terse (the same text is in the Info manual too).  The
documentation for the 'entry' type does not mention this quirk either:

    entry       an Org node, with a headline.  Will be filed
                as the child of the target entry or as a  
                top-level entry.  Its default template is:
                  "* %?\n%a"

The documentation for :prepend does mention that entries will be
inserted at the end if it is nil but I would think that using a function
would rule this out.

Changing the type to 'plain' from 'entry' works as expected though.


[-- Attachment #2: test.org --]
[-- Type: text/plain, Size: 151 bytes --]

* Heading 1
blah blah blah

* Heading 2
AAAAAAAA

* Projects
** Some subheading
something else here

* Glossary
** Some more subheading
something here

             reply	other threads:[~2024-11-21  5:47 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-21  5:46 Visuwesh [this message]
2024-11-21 13:33 ` Bad interaction between org-capture entry type and file+function target? Visuwesh

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=87h681b0l6.fsf@gmail.com \
    --to=visuweshm@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /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).