From mboxrd@z Thu Jan 1 00:00:00 1970 From: tsd@tsdye.com (Thomas S. Dye) Subject: [PATCH] :wrap header documentation Date: Wed, 11 Jan 2012 16:14:53 -1000 Message-ID: References: <87ipkm3vda.fsf@Rainer.invalid> <87hb06yniw.fsf@gmx.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" Return-path: Received: from eggs.gnu.org ([140.186.70.92]:52436) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RlABy-0002IM-Ng for emacs-orgmode@gnu.org; Wed, 11 Jan 2012 21:15:04 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1RlABw-0004es-Si for emacs-orgmode@gnu.org; Wed, 11 Jan 2012 21:15:02 -0500 Received: from oproxy6-pub.bluehost.com ([67.222.54.6]:43208) by eggs.gnu.org with smtp (Exim 4.71) (envelope-from ) id 1RlABw-0004eo-Jr for emacs-orgmode@gnu.org; Wed, 11 Jan 2012 21:15:00 -0500 In-Reply-To: (Thomas S. Dye's message of "Sun, 08 Jan 2012 11:31:03 -1000") List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: Eric Schulte Cc: Achim Gratz , emacs-orgmode@gnu.org --=-=-= Hi Eric, Attached please find a first draft of a patch for the manual entry documenting a :wrap header argument. All the best, Tom --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-doc-org.texi-added-documentation-for-wrap.patch Content-Description: Manual patch >From 4e3a66a4fbfd8d6914fbfd3924981ae5c526aa4a Mon Sep 17 00:00:00 2001 From: Thomas Dye Date: Wed, 11 Jan 2012 16:06:17 -1000 Subject: [PATCH] * doc/org.texi: added documentation for :wrap --- doc/org.texi | 12 +++++++++++- 1 files changed, 11 insertions(+), 1 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index f619c90..7ca797b 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -715,6 +715,7 @@ Specific header arguments * rownames:: Handle row names in tables * shebang:: Make tangled files executable * eval:: Limit evaluation of specific code blocks +* wrap:: Mark source block evaluation results Miscellaneous @@ -13007,6 +13008,7 @@ argument in lowercase letters. The following header arguments are defined: * rownames:: Handle row names in tables * shebang:: Make tangled files executable * eval:: Limit evaluation of specific code blocks +* wrap:: Mark source block evaluation results @end menu Additional header arguments are defined on a language-specific basis, see @@ -13865,7 +13867,7 @@ Setting the @code{:shebang} header argument to a string value first line of any tangled file holding the code block, and the file permissions of the tangled file are set to make it executable. -@node eval, , shebang, Specific header arguments +@node eval, wrap, shebang, Specific header arguments @subsubsection @code{:eval} The @code{:eval} header argument can be used to limit the evaluation of specific code blocks. The @code{:eval} header argument can be useful for @@ -13890,6 +13892,14 @@ If this header argument is not set then evaluation is determined by the value of the @code{org-confirm-babel-evaluate} variable see @ref{Code evaluation security}. +@node wrap, , eval, Specific header arguments +@subsubsection @code{:wrap} +The @code{:wrap} header argument is used to mark the results of source block +evaluation. The header argument can be passed a string that typically will +be appended to @code{#+BEGIN_} and @code{#+END_}, which will then be used to +wrap the results. An exception to this rule is the string @code{drawer}, +which instead wraps the results in an Org mode drawer. + @node Results of evaluation, Noweb reference syntax, Header arguments, Working With Source Code @section Results of evaluation @cindex code block, results of evaluation -- 1.7.5.4 --=-=-= tsd@tsdye.com (Thomas S. Dye) writes: > Eric Schulte writes: > >> Achim Gratz writes: >> >>> tsd@tsdye.com (Thomas S. Dye) writes: >>>> The attached patch defines a new header argument, :special, which wraps >>>> the results of Org babel source block execution in a #BEGIN_ ... #+END_ >>>> block. The block name is taken from a new variable >>>> org-babel-wrap-special, which is initialized as "results". >>> >>> What is the rationale for feeding the block name via a configuration >>> variable rather then a value to the header argument ":special"? >>> >>> >>> Regards, >>> Achim. >> >> Attached is an alternate patch and an example of its use. This patch >> introduces a ":wrap" header argument which accepts an optional value >> used to specify the name of the block with which to wrap results. If >> this looks workable we could push it up once it gets some documentation >> and tests. >> >> Cheers, >> >> >> #+Title: demonstrating the new :wrap header argument >> >> #+begin_src emacs-lisp :wrap schulte >> '((1 2) >> (3 4)) >> #+end_src >> >> #+results: >> #+BEGIN_schulte >> | 1 | 2 | >> | 3 | 4 | >> #+END_schulte > > Hi Eric, > > Thanks for the :wrap header argument. It works for me. > > The attached patch on top of your patch looks for :wrap drawer, and puts > the result in a drawer, rather than wrapping the results in #+begin > ... #+end. > > What I'm trying to do is make :results wrap obsolete. > > Also, note that with the :wrap header argument, :results org and > :results latex are both redundant. I'm not sure how you want to handle > this--whether to leave them in place or remove them. > > I'll volunteer to work on the documentation. > > All the best, > Tom -- Thomas S. Dye http://www.tsdye.com --=-=-=--