From mboxrd@z Thu Jan 1 00:00:00 1970 From: Eric Schulte Subject: Re: Tangling without clutter? Date: Wed, 14 Mar 2012 14:34:43 -0400 Message-ID: <878vj3ni9o.fsf@gmx.com> References: <44B0EAE8544C834188E8790873CDE1CC3EA752@ARCEXCHANGE.arc.local> <44B0EAE8544C834188E8790873CDE1CC3EA82A@ARCEXCHANGE.arc.local> <87y5r30zdd.fsf@gmx.com> <44B0EAE8544C834188E8790873CDE1CC3EA8C0@ARCEXCHANGE.arc.local> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([208.118.235.92]:45949) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1S7uuK-0001rC-Rz for emacs-orgmode@gnu.org; Wed, 14 Mar 2012 16:35:17 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1S7uuI-0007J8-8J for emacs-orgmode@gnu.org; Wed, 14 Mar 2012 16:34:52 -0400 Received: from mailout-us.gmx.com ([74.208.5.67]:40048) by eggs.gnu.org with smtp (Exim 4.71) (envelope-from ) id 1S7uuI-0007He-1V for emacs-orgmode@gnu.org; Wed, 14 Mar 2012 16:34:50 -0400 In-Reply-To: <44B0EAE8544C834188E8790873CDE1CC3EA8C0@ARCEXCHANGE.arc.local> (Jos'h Fuller's message of "Wed, 14 Mar 2012 19:35:32 +0000") 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: Jos'h Fuller Cc: "emacs-orgmode@gnu.org" , "Thomas S. Dye" Jos'h Fuller writes: > Hi! > >> > It seems like I almost need some variant of the "tangle" argument to >> > :noweb where syntax references are expanded for evaluation, but not >> > for anything else. >> > >> >> Why would you want to tangle out a python src file with an un-expanded >> noweb reference? Either way, who am I to judge. I've just added a new >> "eval" option to the noweb header argument which will expand noweb >> references *only* during interactive evaluation. > > Please allow me to explain, I think it's a legitimate use case... > > I would like to provide a listing of a Python function, then later in > the document show a demonstration of how it's used. I just did this > when preparing some documentation for another programmer who is > porting an application between languages. > > So I listed the function, then after a discussion, I had a > demonstration of how to use the function. I wanted the output from the > demonstration to be "live", generated from the demonstration > code. Therefore, I needed to reference the function defined > above. Unfortunately, the reference was expanded during export so that > the same block of code appeared /twice/, presenting the reader with > something like this: > > : Here's a function: > : def gorking(): > : return "gork" > : > : Here's how to use the function: > : def gorking(): > : return "gork" > : > : print gorking() > : > : Which gives us: > : gork > > As you can see, it's rather clumsy to have the function in the output > twice. It's not too bad for this example, but anything more than a few > lines becomes quite a distraction! This would have been preferable: > > : Here's a function: > : def gorking(): > : return "gork" > : > : Here's how to use the function: > : <> > : > : print gorking() > : > : Which gives us: > : gork > > The original %.org file would look like this: > > : Here's a function: > : #+name: function-gorking > : #+begin_src python :tangle yes > : def gorking(): > : return "gork" > : #+end_src > : > : Here's how to use the function: > : #+name: function-gorking-demo > : #+begin_src python :tangle yes > : <> > : > : print gorking() > : #+end_src > : > : Which gives us: > : #+results: function-gorking-demo > : gork > > Does that explain it better? > Yes, although it seems that the existing "no-export" or "strip-export" options to the :noweb header argument may better suit your purposes. These are described in the Org-mode manual, however, they are not mentioned in the online version of the manual which is out of date. Cheers, > > Thanks! > > Jos'h > > > -- Eric Schulte http://cs.unm.edu/~eschulte/