emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed

From: Tim Landscheidt <tim@tim-landscheidt.de>
To: emacs-orgmode@gnu.org
Subject: Possible to robustly embed elisp links in source block table results?
Date: Sat, 12 Feb 2022 10:52:45 +0000	[thread overview]
Message-ID: <87pmnsjr0i.fsf@vagabond.tim-landscheidt.de> (raw)

Hi,

I want org-mode to display a tab-separated values table ge-
nerated by jq that includes elisp links that do something
(differently) for each row, especially containing data that
is not displayed in other columns.

The source block:

| #+BEGIN_SRC sh :colnames '(Column\ A Column\ B Column\ C)
|   jq --null-input -r 'range(1; 4) | tostring | [ "A" + ., "B" + ., "[[elisp:(ignore)][Do it]]"] | @tsv'
| #+END_SRC

evaluates to:

| #+RESULTS:
| | Column A | Column B | Column C |
| |----------+----------+----------|
| | A1       | B1       | [[elisp:(ignore)][Do it]]    |
| | A2       | B2       | [[elisp:(ignore)][Do it]]    |
| | A3       | B3       | [[elisp:(ignore)][Do it]]    |

which org-mode displays as:

| #+RESULTS:
| | Column A | Column B | Column C |
| |----------+----------+----------|
| | A1       | B1       | Do it    |
| | A2       | B2       | Do it    |
| | A3       | B3       | Do it    |

with each "Do it" being a button that, when pressed and con-
firmed, executes ignore.  Great!

Executing Emacs Lisp:

| (org-insert-link nil "elisp:(ignore \"1\")" "Do it")

results in the org-mode source code:

| [[elisp:(ignore "1")][Do it]]

so let's try jq generating that with:

| #+BEGIN_SRC sh :colnames '(Column\ A Column\ B Column\ C)
|   jq --null-input -r 'range(1; 4) | tostring | [ "A" + ., "B" + ., "[[elisp:(ignore \"" + . + "\")][Do it]]"] | @tsv'
| #+END_SRC

This jq call, executed in a shell, evaluates to the output
(tab-separated):

| A1      B1      [[elisp:(ignore "1")][Do it]]
| A2      B2      [[elisp:(ignore "2")][Do it]]
| A3      B3      [[elisp:(ignore "3")][Do it]]

When org-mode evaluates the source block, it strips it down
to:

| #+RESULTS:
| | Column A | Column B | Column C |
| |----------+----------+----------|
| | A1       | B1       |        1 |
| | A2       | B2       |        2 |
| | A3       | B3       |        3 |

where "1", "2" and "3" are not buttons or anything else but
plain text, and any other input has been permanently dis-
carded (i. e., is not just not displayed).

If however I set ":results raw" in the source block:

| #+BEGIN_SRC sh :colnames '(Column\ A Column\ B Column\ C) :results raw
|   jq --null-input -r 'range(1; 4) | tostring | [ "A" + ., "B" + ., "[[elisp:(ignore \"" + . + "\")][Do it]]"] | @tsv'
| #+END_SRC

org-mode evaluates that to:

| #+RESULTS:
| A1	B1	Do it
| A2	B2	Do it
| A3	B3	Do it

with each "Do it" being a button that, when pressed and con-
firmed, will execute (ignore "1"), (ignore "2") and (ignore
"3"), respectively.

So in the first and third source block, org-mode teases me
that I can embed elisp links in that very nice table format
(first source block) with "complex" Lisp code (third source
block), but when I try to combine the two (second source
block), it slaps me in the face.

Surely I must be missing some obvious solution?  Is there
another syntax I need to use?  Do I need to have jq output
the raw columns A, B, D and E and then define a :post source
block that converts that to A, B and C = f(D, E)?

My alternative and thus benchmark for such "dashboards" that
show "stuff" and offer things to do with it are derivatives
of tabulated-list-mode, but their programming requires de-
finitions of functions & Co. that need to be updated syn-
chronously; an org-mode source block on the other hand just
does what it says on the tin.

TIA,
Tim

next             reply	other threads:[~2022-02-12 10:54 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-02-12 10:52 Tim Landscheidt [this message]
2022-02-13 15:17 ` Possible to robustly embed elisp links in source block table results? John Kitchin

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=87pmnsjr0i.fsf@vagabond.tim-landscheidt.de \
    --to=tim@tim-landscheidt.de \
    --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

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).