From mboxrd@z Thu Jan 1 00:00:00 1970 From: Nick Dokos Subject: Re: Org-mode Code Blocks Manuscript: Request For Comments Date: Fri, 03 Dec 2010 02:16:17 -0500 Message-ID: <12760.1291360577@gamaville.dokosmarshall.org> References: <87lj487z50.fsf@gmail.com> Reply-To: nicholas.dokos@hp.com Return-path: Received: from [140.186.70.92] (port=40276 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1POPsg-0005ws-Nt for emacs-orgmode@gnu.org; Fri, 03 Dec 2010 02:16:35 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1POPsf-0005yQ-Bg for emacs-orgmode@gnu.org; Fri, 03 Dec 2010 02:16:34 -0500 Received: from vms173001pub.verizon.net ([206.46.173.1]:43160) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1POPsf-0005yA-8K for emacs-orgmode@gnu.org; Fri, 03 Dec 2010 02:16:33 -0500 Received: from gamaville.dokosmarshall.org ([unknown] [173.76.32.106]) by vms173001.mailsrvcs.net (Sun Java(tm) System Messaging Server 7u2-7.02 32bit (built Apr 16 2009)) with ESMTPA id <0LCU00GSEC76HN50@vms173001.mailsrvcs.net> for emacs-orgmode@gnu.org; Fri, 03 Dec 2010 01:16:19 -0600 (CST) In-reply-to: Message from "Eric Schulte" of "Thu, 02 Dec 2010 12:28:27 MST." <87lj487z50.fsf@gmail.com> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Eric Schulte Cc: nicholas.dokos@hp.com, Org Mode Eric Schulte 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