emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: Stefano Ghirlanda <dr.ghirlanda@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Colons in :var header arguments
Date: Sat, 21 Oct 2023 10:12:52 +0000	[thread overview]
Message-ID: <87sf64thaz.fsf@localhost> (raw)
In-Reply-To: <CAK_gY-Q4f82dbDQgyS+FfyeQaHAMXHqygq3e6ZsWnEj-+eoG9A@mail.gmail.com>

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

Stefano Ghirlanda <dr.ghirlanda@gmail.com> writes:

> I have run into an inconvenience in that colons in :var header
> arguments to source blocks are invariably interpreted as referring to
> another file. However, I use cleveref in LaTeX export (via org-ref) to
> automatically format references using labels like tab:data, and in
> these cases :var data=tab:data gives a reference not found because tab
> is interpreted as a filename.

I agree that it is a problem.
Attaching tentative patch that will make Org babel fall back to
searching in current file when FILE in FILE:REF does not exist.

It is technically a breaking change. If this is affecting someone's
workflow, please chime in.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-babel-ref-resolve-Search-current-buffer-when-FIL.patch --]
[-- Type: text/x-patch, Size: 2682 bytes --]

From 024cc1e6b31e9e3e9e4b8d3aee83221cb3326ee2 Mon Sep 17 00:00:00 2001
Message-ID: <024cc1e6b31e9e3e9e4b8d3aee83221cb3326ee2.1697883034.git.yantar92@posteo.net>
From: Ihor Radchenko <yantar92@posteo.net>
Date: Sat, 21 Oct 2023 13:08:55 +0300
Subject: [PATCH] org-babel-ref-resolve: Search current buffer when FILE in
 FILE:REF does not exist

* lisp/ob-ref.el (org-babel-ref-resolve): Only search in other file
when FILE in FILE:REF exists.
* doc/org-manual.org (Passing arguments):
* etc/ORG-NEWS (Babel references =FILE:REFERENCE= now search current
buffer when =FILE= does not exist): Document the change.

Reported-by: Stefano Ghirlanda <dr.ghirlanda@gmail.com>
Link: https://orgmode.org/list/CAK_gY-Q4f82dbDQgyS+FfyeQaHAMXHqygq3e6ZsWnEj-+eoG9A@mail.gmail.com
---
 doc/org-manual.org | 4 ++++
 etc/ORG-NEWS       | 6 ++++++
 lisp/ob-ref.el     | 5 +++--
 3 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index c0e9c8d7e..9a51a38a1 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -17764,6 +17764,10 @@ *** Passing arguments
 
 : :var NAME=FILE:REFERENCE
 
+When =FILE= does not exist, the reference is searched in the current
+file, using the verbatim reference.  This way,
+=:var table=tbl:example= will be searched inside the current buffer.
+
 Here are examples of passing values by reference:
 
 - table ::
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 985488016..f64081964 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -13,6 +13,12 @@ Please send Org bug reports to mailto:emacs-orgmode@gnu.org.
 
 * Version 9.7 (not released yet)
 ** Important announcements and breaking changes
+*** Babel references =FILE:REFERENCE= now search current buffer when =FILE= does not exist
+
+When =FILE= does not exist, the reference is searched in the current
+file, using the verbatim reference.  This way,
+=:var table=tbl:example= will be searched inside the current buffer.
+
 *** New export option ~org-export-expand-links~
 
 The new option makes Org expand environment variables in link and INCLUDE paths.
diff --git a/lisp/ob-ref.el b/lisp/ob-ref.el
index fd6927ccf..b7858569a 100644
--- a/lisp/ob-ref.el
+++ b/lisp/ob-ref.el
@@ -156,8 +156,9 @@ (defun org-babel-ref-resolve (ref)
 	  (when (string-match "^\\(.+\\):\\(.+\\)$" ref)
 	    (setq split-file (match-string 1 ref))
 	    (setq split-ref (match-string 2 ref))
-	    (find-file split-file)
-	    (setq ref split-ref))
+            (when (file-exists-p split-file)
+	      (find-file split-file)
+	      (setq ref split-ref)))
 	  (org-with-wide-buffer
 	   (goto-char (point-min))
 	   (let* ((params (append args '((:results . "none"))))
-- 
2.42.0


[-- Attachment #3: Type: text/plain, Size: 224 bytes --]


-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

  reply	other threads:[~2023-10-21 10:12 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-10-19 13:34 Colons in :var header arguments Stefano Ghirlanda
2023-10-21 10:12 ` Ihor Radchenko [this message]
2023-10-24 13:42   ` Stefano Ghirlanda
2023-11-10 10:34   ` Ihor Radchenko

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=87sf64thaz.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=dr.ghirlanda@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).