Org-mode mailing list
 help / color / mirror / Atom feed
From: Eric S Fraga <e.fraga@ucl.ac.uk>
To: Emacs Org mode mailing list <emacs-orgmode@gnu.org>
Subject: [patch] documentation update (was Re: could a :var header argument refer to a data table in another file?)
Date: Mon, 03 May 2021 13:43:13 +0100
Message-ID: <874kfkvvha.fsf_-_@ucl.ac.uk> (raw)
In-Reply-To: <CAJ51EToJVdsmZmf4qQ2guKVSfWmOcqdW=tMojF9XZmmDv7J9KQ@mail.gmail.com> (John Kitchin's message of "Thu, 29 Apr 2021 10:51:52 -0400")

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

On Thursday, 29 Apr 2021 at 10:51, John Kitchin wrote:
> I don't know if it is in the manual. It would be great to have it in
> https://orgmode.org/manual/Environment-of-a-Code-Block.html.

Attached is a patch for this.  Thank you.

-- 
: Eric S Fraga via Emacs 28.0.50, Org release_9.4.5-393-gd44bd5

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-manual.org-describe-external-reference-for-var-h.patch --]
[-- Type: text/x-diff, Size: 1191 bytes --]

From 339e44b08b73ed083c15311d230db5f4d98abc8a Mon Sep 17 00:00:00 2001
From: Eric S Fraga <e.fraga@ucl.ac.uk>
Date: Mon, 3 May 2021 13:37:58 +0100
Subject: [PATCH] org-manual.org: describe external reference for :var header

* org-manual.org: the description of the :var header argument for
working with source code has been expanded to mention the possibility
of having an external reference, a reference to an element in another
file.
---
 doc/org-manual.org | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 42a12e9d4..3008d5a48 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -16797,7 +16797,11 @@ the =var= header argument.
 body.  {{{var(ASSIGN)}}} is a literal value, such as a string,
 a number, a reference to a table, a list, a literal example, another
 code block---with or without arguments---or the results of evaluating
-a code block.
+a code block.  {{{var(ASSIGN)}}} may specify a filename for references
+to elements in a different file, using a =:= to separate the filename
+from the reference.
+
+: :var NAME=FILE:REFERENCE
 
 Here are examples of passing values by reference:
 
-- 
2.29.2


  parent reply	other threads:[~2021-05-03 12:52 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-29 12:22 could a :var header argument refer to a data table in another file? Eric S Fraga
2021-04-29 13:17 ` John Kitchin
2021-04-29 13:42   ` Eric S Fraga
2021-04-29 14:51     ` John Kitchin
2021-04-29 15:36       ` Eric S Fraga
2021-05-03 12:43       ` Eric S Fraga [this message]
2021-05-03 13:00         ` [patch] documentation update (was Re: could a :var header argument refer to a data table in another file?) Bastien
2021-05-03 13:35           ` Eric S Fraga
2021-05-03 13:43             ` Bastien
2021-05-03 13:47               ` Eric S Fraga
2021-04-29 14:02   ` could a :var header argument refer to a data table in another file? Eric S Fraga
2021-05-01  5:58 ` Michael Welle
2021-05-01  8:42   ` Eric S Fraga

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://orgmode.org

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=874kfkvvha.fsf_-_@ucl.ac.uk \
    --to=e.fraga@ucl.ac.uk \
    --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

Org-mode mailing list

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://orgmode.org/list/0 list/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 list list/ https://orgmode.org/list \
		emacs-orgmode@gnu.org
	public-inbox-index list

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.yhetil.org/yhetil.emacs.orgmode
	nntp://news.gmane.io/gmane.emacs.orgmode


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git