emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Dan Davison <davison@stats.ox.ac.uk>
To: "Sébastien Vauban" <wxhgmqzgwmuf@spammotel.com>
Cc: emacs-orgmode@gnu.org, Giles Chamberlin <giles.chamberlin@tandberg.com>
Subject: Re: Re: Limited #+INCLUDE ?
Date: Mon, 26 Apr 2010 15:40:35 -0400	[thread overview]
Message-ID: <87eii26lzg.fsf@stats.ox.ac.uk> (raw)
In-Reply-To: <87k4ruy5pd.fsf@mundaneum.com> ("Sébastien Vauban"'s message of "Mon, 26 Apr 2010 10:32:30 +0200")

Sébastien Vauban <wxhgmqzgwmuf@spammotel.com> writes:

> Hi Giles,
>
> Giles Chamberlin wrote:
>> I've been using org-mode for some course work: "write an essay about
>> your software including the interesting bits, add all source code in an
>> appendix".
>>
>> #+INCLUDE solves the inclusion of source code files very nicely - I'm 
>> guaranteed that my document includes the latest versions, type set as I
>> wish.
>>
>> Unfortunately at the moment I'm cutting and pasting the snippets of
>> "interesting" code into the body of the essay.  What I'd like to do is
>> be able to label interesting regions of code in the source file and then
>> import the labelled blocks into my essay. Is there a way of doing this?
>
> Have a look at Org-Babel.
>
> Though, it means your source code would be *inside* your Org document, and you
> would have to "tangle" it (generate it) from there.
>
> Seb

I'm considering investigating the following and would appreciate
comments on this idea. The aim is to make it easier to use Org-mode to
work pure code files which are *external to Org-mode* (i.e. this
proposal lies outside of the current org-babel tangling framework).

- Extend Org file links to allow links to a range of lines in a
  file. The syntax could be
  [[file:/path/to/file::from::to][linkname]]

- These links will bring up a buffer visiting the target file, narrowed
  to the target region.

- The link back in the Org-mode file can be adjusted from the target
  file, by widening and then narrowing again. (During this procedure the
  target region would be highlighted.)

- Export to HTML and LaTeX will have the ability to include the target
  regions, fontified according to the appropriate major-mode, similar to
  how begin_src blocks behave on export.

- 'from' and 'to' could be line numbers, or regexps for text search.

For programmers, this would allow a sort of org-mode mediated literate
programming in projects where it is not feasible/desirable to actually
include the source code in the org-mode file.

Any comments or suggestions?

Dan

  reply	other threads:[~2010-04-26 19:40 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-04-23 11:25 Limited #+INCLUDE ? Giles Chamberlin
2010-04-26  8:32 ` Sébastien Vauban
2010-04-26 19:40   ` Dan Davison [this message]
2010-04-27  0:34     ` Mark Elston
2010-04-27  2:19       ` Dan Davison
2010-04-28  0:52         ` Mark Elston
2010-04-27  8:27     ` Eric S Fraga
2010-04-27 10:25       ` Darlan Cavalcante Moreira
2010-04-27 15:12         ` Eric Schulte
2010-04-27 17:26           ` Dan Davison
2010-04-27 17:58             ` Eric Schulte
2010-04-27 18:27             ` Giles Chamberlin
2010-04-27 17:52           ` Samuel Wales
2010-04-27 19:19             ` Dan Davison
2010-04-27 21:56               ` Carsten Dominik
2010-04-29 23:14               ` Samuel Wales

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=87eii26lzg.fsf@stats.ox.ac.uk \
    --to=davison@stats.ox.ac.uk \
    --cc=emacs-orgmode@gnu.org \
    --cc=giles.chamberlin@tandberg.com \
    --cc=wxhgmqzgwmuf@spammotel.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).