emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Pierre de Buyl <pdebuyl@chem.utoronto.ca>
To: Eric S Fraga <e.fraga@ucl.ac.uk>
Cc: emacs-orgmode@gnu.org, "I.S." <inquisitive.scientist@gmail.com>
Subject: Re: Is it possible to do literate programming without org-babel?
Date: Fri, 3 Dec 2010 09:42:13 -0500	[thread overview]
Message-ID: <DF9BAFFB-9962-4198-9413-13E4BC613E18@chem.utoronto.ca> (raw)
In-Reply-To: <87bp53q6fm.fsf@ucl.ac.uk>

Hello,

I have taken a reverse approach, even with no collaboration.
I write the source code in pure $LANGUAGE (fortran 90 for now) and  
add comments in org-mode syntax with a special header:
in prog.f90

!!subroutine compute
! This subroutine performs a task
subroutine compute(myarg)
integer, intent(in) :: myarg
write(*,*) myarg
end subroutine compute

get translated by a script to

** subroutine compute
This subroutine performs a task
#begin_src f90
subroutine compute(myarg)
integer, intent(in) :: myarg
write(*,*) myarg
end subroutine compute
#end_src

which can be exported with the language font locking of emacs in html  
via orgmode. It gives me a typeset documentation from my source code  
directly.

I think that a feature similar to C-' in org-mode would be wonderful:  
I could edit my "pure" f90 program and edit my comment blocks in org- 
mode.

Regards,

Pierre

Le 3 déc. 10 à 09:25, Eric S Fraga a écrit :

> "I.S." <inquisitive.scientist@gmail.com> writes:
>
>> Dear Experts,
>>
>> I think org-babel is great and use it when I can. But on larger
>> projects where some people are not emacs users, it may not be  
>> feasible
>> for the master file to be an org-mode file.
>>
>> Do you have any suggestions on using literate programming techniques
>> when the source code must be in a .py file?
>>
>> One thing I have tried is switching to org-mode when I want to write
>> comments, create links, etc. and do that in org-mode and then switch
>> back to python mode. This actually works reasonably well but it's
>> annoying to switch modess.
>>
>> Any better ideas?
>
> This probably is not going to help you but I have the same problem.
>
> What I do, *when* the project is one in which I am the main lead,  
> is to
> keep using org mode, without switching modes, but when I need to share
> something with my collaborator, I *tangle* all the code and send him
> both the code and the org document.  This means that he can run the
> code.  However, the code has no comments in it...
>
> Of course, incorporating any changes my collaborator makes back  
> into the
> org document is annoying but manageable.
> -- 
> : Eric S Fraga (GnuPG: 0xC89193D8FFFCF67D) in Emacs 23.2.1
> : using Org-mode version 7.3 (release_7.3.169.g0d0e)
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

      parent reply	other threads:[~2010-12-03 14:42 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-12-03 13:09 Is it possible to do literate programming without org-babel? I.S.
2010-12-03 14:25 ` Eric S Fraga
2010-12-03 14:33   ` Eric Schulte
2010-12-03 15:18     ` Eric S Fraga
2010-12-03 14:42   ` Pierre de Buyl [this message]

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=DF9BAFFB-9962-4198-9413-13E4BC613E18@chem.utoronto.ca \
    --to=pdebuyl@chem.utoronto.ca \
    --cc=e.fraga@ucl.ac.uk \
    --cc=emacs-orgmode@gnu.org \
    --cc=inquisitive.scientist@gmail.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).