Is it possible to do literate programming without org-babel?

Is it possible to do literate programming without org-babel?

[I.S.]

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?

-- 
Thanks,
-I.S.

Re: Is it possible to do literate programming without org-babel?

[Eric S Fraga]

"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)

Re: Is it possible to do literate programming without org-babel?

[Eric Schulte]

If your collaborators don't mind the existence of some Org-mode specific
comments in the .py file, you can tangle with comments on and then use
the `org-babel-detangle' function to bring changes in the source file
back into your Org-mode buffer.  In this way it should be possible for
you to collaborate without leaving Org-mode.

Best -- Eric

Eric S Fraga <e.fraga@ucl.ac.uk> writes:

> "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.

Re: Is it possible to do literate programming without org-babel?

[Eric S Fraga]

"Eric Schulte" <schulte.eric@gmail.com> writes:

> If your collaborators don't mind the existence of some Org-mode specific
> comments in the .py file, you can tangle with comments on and then use
> the `org-babel-detangle' function to bring changes in the source file
> back into your Org-mode buffer.  In this way it should be possible for
> you to collaborate without leaving Org-mode.

Ah, very true; I'd forgotten about detangle...  I'll give it a shot
tonight when I get back to this particular project!
-- 
: Eric S Fraga (GnuPG: 0xC89193D8FFFCF67D) in Emacs 23.2.1
: using Org-mode version 7.3 (release_7.3.169.g0d0e)

Re: Is it possible to do literate programming without org-babel?

[Pierre de Buyl]

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