emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Syntax of Org Babel results
@ 2013-03-10 11:55 Sebastien Vauban
  2013-03-15  9:54 ` Syntax of Org Babel ":results" header argument Sebastien Vauban
  0 siblings, 1 reply; 10+ messages in thread
From: Sebastien Vauban @ 2013-03-10 11:55 UTC (permalink / raw)
  To: emacs-orgmode-mXXj517/zsQ

Hello,

Before Org 8 is out, I'm willing to put light on some last syntax which I find
counter-intuitive and not along the lines of the rest: it concerns the
`results' parameter.

Let's sum up first the list of all parameters:

1. Collection

   - :results value
   - :results output

2. Type of results (when :results is set to `value'):

   - Result types

     + :results vector
     + :results scalar
     + :results list
     + :results file

   - Result wrappers

     + :results raw
     + :results drawer
     + :results org (removed, right?)
     + :results html
     + :results code
     + :results latex
     + :results pp

3. Handling

   - :results replace
   - :results silent
   - :results none
   - :results append
   - :results prepend

As you see (by the shown structure), the different values answer different
questions:

- How the results should be collected from the source code block?
- How they will be inserted into the Org mode buffer?
- How to interpret/wrap the results?
- How the results should be handled?

And answering many of these questions at the same time means giving a
*multi-value* to the parameter, such as:

  :results list append

Wouldn't it make more sense (and be more easily parsed by the machine and be
cleaner and less error-prone for us, poor humans) if `results' would be split
in different parameters for the different questions they answer, each of those
parameters getting at most one value?

Something along the lines of:

  :results_type file :results_insertion append

  (those names may be ugly, it just for the purpose of explaining my idea).

I know that it's the ultimate moment to discuss such a change, would there be
consensus, before Org 8 is out.

Best regards,
  Seb

-- 
Sebastien Vauban

^ permalink raw reply	[flat|nested] 10+ messages in thread

end of thread, other threads:[~2013-03-18 20:06 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-03-10 11:55 Syntax of Org Babel results Sebastien Vauban
2013-03-15  9:54 ` Syntax of Org Babel ":results" header argument Sebastien Vauban
2013-03-15 11:41   ` Eric S Fraga
2013-03-15 17:30     ` shripad sinari
2013-03-15 18:47       ` Jay Kerns
2013-03-17  8:30   ` Bastien
2013-03-17 21:31     ` Eric Schulte
2013-03-17 23:22       ` Thomas S. Dye
2013-03-18  8:27         ` Andreas Leha
2013-03-18 20:06           ` Sebastien Vauban

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