From: Nick Dokos <nicholas.dokos@hp.com>
To: Eric Schulte <schulte.eric@gmail.com>
Cc: nicholas.dokos@hp.com, Org Mode <emacs-orgmode@gnu.org>
Subject: Re: Org-mode Code Blocks Manuscript: Request For Comments
Date: Fri, 03 Dec 2010 02:16:17 -0500 [thread overview]
Message-ID: <12760.1291360577@gamaville.dokosmarshall.org> (raw)
In-Reply-To: Message from "Eric Schulte" <schulte.eric@gmail.com> of "Thu, 02 Dec 2010 12:28:27 MST." <87lj487z50.fsf@gmail.com>
Eric Schulte <schulte.eric@gmail.com> wrote:
> Dan Davison, Tom Dye, Carsten Dominik and myself have been working on a
> paper introducing Org-mode's code block functionality. We plan to
> submit this paper to the Journal of Statistical Software. As both
> Org-mode and the code block functionality are largely products of this
> mailing list community, and in the spirit of an open peer review process
> we are releasing the current draft of the paper here to solicit your
> review and comments.
>
> Both the .org and .pdf formats of the paper are available at the
> following locations.
>
> http://cs.unm.edu/~eschulte/org-paper/babel.org
>
> http://cs.unm.edu/~eschulte/org-paper/babel.pdf
>
I just finished reading the paper. I have watched babel go by without
doing much with it so far, so I knew a little of the motivation and the
functionality, but seeing the examples in action is another matter
altogether: beautiful stuff.
I haven't tried evaluating all the code blocks yet, but here are some
corrections to minor things and some questions, after this first
reading:
o p.9, Sec. 3.1.2: in the TODO example, a \texttt has sneaked into the
output.
o p.14, Sec 3.3: second line of the "weaving" description, "...to export
to HTML an number of other target formats,..." should probably be
"...to export to HTML and a number of other target formats,..."
perhaps?
o p. 17, Sec. 4.1.2, code block ps-to-fig, the #+ATT should
be #+ATTR_LaTeX: I think.
o p. 20, Sec. 4.3, end of first paragraph: is "propagate" the right
word? should it perhaps be "populate"?
o p.21, Sec. 4.3, sqlite code block: it does not have a #+source
attribute (should it?) and the quoted code is out of sync with the
"real" code, missing the "drop table" construct and some header args.
I take it there is no concept of radio-code that would populate the
``#+begin_src org'' block with an up-to-date copy of the real code, is
there?
o p.21, Sec. 4.3, paragraph after sqlite code block: refers to get-temps
code block which does not exist. Even if omitted from the published
version for brevity, it should be included in babel.org.
o p.23, Sec. 5: in the "Widely available" description, "... an wide
variety..." should be "... a wide variety...". In the "General and
extensible" description, I would omit "pursuit of".
o There are widows/orphans in some examples (e.g. bottom of p.8, top of
p.17) but I presume you'll wait to deal with those at the very end.
Finally, the questions: in Sec. 4.1.3, I may be missing something
fundamental, but I don't understand how that works at all. In
particular, is the table formula complete as it stands? How does it get
the diagonals? How are these things passed to the code block? Why does
the code block have values given to the variables? Is it correct as it
stands, or are things missing? This is the one section where I was
completely lost. Could somebody explain?
Thanks,
Nick
next prev parent reply other threads:[~2010-12-03 7:16 UTC|newest]
Thread overview: 26+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-12-02 19:28 Org-mode Code Blocks Manuscript: Request For Comments Eric Schulte
2010-12-02 19:36 ` Jeff Horn
2010-12-02 23:13 ` Eric S Fraga
2010-12-03 1:17 ` Thomas S. Dye
2010-12-03 12:26 ` Eric S Fraga
2010-12-03 17:29 ` Thomas S. Dye
2010-12-03 20:07 ` Eric S Fraga
2010-12-03 7:16 ` Nick Dokos [this message]
2010-12-07 22:55 ` Sébastien Vauban
2010-12-08 16:33 ` Thomas S. Dye
2010-12-08 19:55 ` Eric Schulte
[not found] ` <87bp4w0zmx.fsf-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2010-12-09 13:22 ` **: " Sébastien Vauban
2010-12-09 14:46 ` Eric Schulte
2010-12-09 19:48 ` Sébastien Vauban
2010-12-08 19:54 ` Eric Schulte
2010-12-03 7:58 ` Detlef Steuer
2010-12-05 6:03 ` Thomas S. Dye
2010-12-06 19:52 ` Charles C. Berry
2010-12-07 0:13 ` Sunny Srivastava
2010-12-07 4:48 ` Charles C. Berry
2010-12-07 14:24 ` Thomas S. Dye
2010-12-07 17:05 ` Charles C. Berry
2010-12-09 7:20 ` Charles C. Berry
2010-12-09 8:07 ` Thomas S. Dye
2010-12-06 2:02 ` Christopher Allan Webber
2010-12-08 19:54 ` Eric Schulte
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=12760.1291360577@gamaville.dokosmarshall.org \
--to=nicholas.dokos@hp.com \
--cc=emacs-orgmode@gnu.org \
--cc=schulte.eric@gmail.com \
/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).