From: Neeum Zawan <mailinglists@nawaz.org>
To: emacs-orgmode@gnu.org
Subject: Re: Literate Programming - Continue a Source Block?
Date: Wed, 08 Jun 2011 14:20:57 -0700 [thread overview]
Message-ID: <877h8wj9za.fsf@fester.com> (raw)
In-Reply-To: 87mxhsnmcf.fsf@gmail.com
Eric Schulte <schulte.eric@gmail.com> writes:
>>> Second solution: create one sole block that will be tangled, and which
>>> contains your other blocks (using the <<ref>> syntax), in the order you want.
>>
>> I had thought of this, but I find it somewhat lacking. Consider my
>> example above. I could have created a <<visual-python>> in my
>> <<visual-config>> block. However:
>>
>> 1. That requires me to know I'm going to need it later when I write
>> visual-config.
>>
>
> nit picking here, but while this does require a small edit to
> <<visual-config>>, there is no need for prior knowledge of the need for
> <<visual-python>>.
>
>>
>> 2. If I didn't know I'd need it, I'd have to continually modify various
>> parts of the org document every time I add a new feature to my code. I
>> find this suboptimal and error prone.
>>
>
> Technically only one edit per new block introduced, which does not seem
> overly onerous.
In this case, yes. In a real programming project, it could be a number
of them. For example, I may have a code block dedicated to
imports/includes which I want to be on the top of the file - and I may
have to append to that when adding a new feature. And then the actual
code for the new feature may require edits to other parts of one's
program. Ideally, everything should be decoupled, but reality rarely
follows the ideal ;-)
>> Now the original noweb allows what I'm asking for. If you begin a
>> source block with a name of an existing block but append an "="
>> symbol, it knows to append to that source block.
>>
>> It would be great if org-mode could add that capability.
>
> I agree, and the functionality you describe shouldn't be overly
> difficult to implement.
>
> I like the concision of the "=original-name" syntax used by noweb, but I
> would lean towards the use of a ":noweb-append" type header argument as
> suggested above because currently the names of blocks in Babel carry no
> semantic content and I'd prefer to leave it this way.
I suppose it may also break compatibility in case someone out there uses
the =symbol.
Had it been thought of earlier, I would have preferred the default
behavior being append if you have multiple blocks of the same name, and
an explicit option *not* to append but to overwrite, but your idea makes
the most sense with respect to preserving backward compatibility.
In addition to append, there probably should be another option for
overwriting instead of appending (neither is possible right now).
Also, just on the side, I'm not sure it's documented anywhere what
happens if you have multiple source code blocks of the same name. At the
moment, it seems only the first is used (I would have expected the
last).
> Thanks for the motivating example and the thorough explanation of
> behavior.
>
> I'll certainly put this on my long-term development queue, however, that
> does not guarantee an implementation in the near future. If anyone is
> interested in this functionality and is up for writing some elisp I am
> happy to offer advice and code pointers immediately.
Wish I knew elisp. Anyway, hopefully someone will get it done one day.
Thanks.
next prev parent reply other threads:[~2011-06-08 21:19 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-06-08 5:47 Literate Programming - Continue a Source Block? Neeum Zawan
2011-06-08 7:34 ` Sebastien Vauban
2011-06-08 15:20 ` Neeum Zawan
2011-06-08 19:40 ` Eric Schulte
2011-06-08 21:20 ` Neeum Zawan [this message]
2011-06-10 4:55 ` Avdi Grimm
2011-06-10 19:09 ` Eric Schulte
2011-06-10 19:27 ` Achim Gratz
2011-06-10 20:00 ` Eric Schulte
2011-06-12 8:32 ` Achim Gratz
2011-06-13 22:04 ` Eric Schulte
2011-06-14 20:48 ` Achim Gratz
2011-06-15 17:23 ` Eric Schulte
2011-06-15 21:19 ` Achim Gratz
2011-06-16 4:54 ` Eric Schulte
2011-06-16 2:35 ` Neeum Zawan
2011-06-11 1:02 ` Neeum Zawan
2011-06-11 0:44 ` Neeum Zawan
2011-06-11 20:08 ` Eric Schulte
2011-06-12 5:36 ` Neeum Zawan
2011-06-13 21:57 ` Eric Schulte
2011-06-15 5:17 ` Neeum Zawan
2011-06-15 17:27 ` Eric Schulte
2011-06-15 19:37 ` Neeum Zawan
2011-06-16 2:26 ` Eric Schulte
2011-06-17 4:30 ` Neeum Zawan
2011-06-17 4:39 ` Eric Schulte
2011-06-17 7:00 ` Sebastien Vauban
2011-06-19 23:38 ` Neeum Zawan
2011-06-16 10:14 ` Olaf.Hamann
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=877h8wj9za.fsf@fester.com \
--to=mailinglists@nawaz.org \
--cc=emacs-orgmode@gnu.org \
/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).