Re: [Caml-list] Literate (sort-of) programming in OCaml

[Maxence Guesdon <Maxence.Guesdon@inria.fr>]

On Mon, 02 Sep 2013 18:59:33 +0300
Török Edwin <edwin+ml-ocaml@etorok.net> wrote:

> On 09/02/2013 06:39 PM, Jonathan Protzenko wrote:
> > Hi,
> > 
> > I am currently writing a big, mostly textual document in format blah 
> > (blah being of a course a meta-variable). Are there any tools that 
> > would allow me to interleave OCaml code with the contents of my 
> > document?
> > 
> > More on my use-case. Creating this document requires me to perform 
> > various subtasks, such as:
> > - write a code snippet in the document,
> > - put the code snippet in a file,
> > - call an external program on the file,
> > - paste the output into the document.
> > 
> > Naturally, I wish to automate this. I could roll my own set of 
> > commands, and parse them with OCaml, but I would be re-creating a 
> > scripting language, and it seems to me that interleaving OCaml code 
> > within my document would be better. Here's what I have in mind:
> > 
> > 
> > blah blah blah blah blah blah blah blah blah blah blah blah blah blah 
> > blah blah
> > blah blah blah blah blah blah blah blah blah blah blah blah blah blah 
> > blah blah
> > blah ... we thus write the following code ... :
> > 
> > {%
> >   let code = "<sample code>" in
> >   output code
> > %}
> > 
> > blah blah blah ... after running the command blah ... the output is as 
> > follows ... blah
> > 
> > {%
> >   let f = write_into_temp_file code in
> >   let s = run_and_read "myprogram" [f] in
> >   output s
> > %}
> > 
> > blah blah blah blah blah blah blah blah blah blah blah blah blah blah 
> > blah blah ...
> > 
> > 
> > Are you aware of any tool that would allow me to achieve this?
> 
> http://zoggy.github.io/stog/posts/ocaml-sessions.html

You can have a look at a huge usage of this in my ocaml introduction:
  http://form-ocaml.forge.ocamlcore.org/
The document:
  http://form-ocaml.forge.ocamlcore.org/intro_ocaml.html
The source code:
  http://forge.ocamlcore.org/scm/?group_id=228

You will need stog and stog-writing:
  http://zoggy.github.io/stog/
  http://zoggy.github.io/stog/stog-writing.html

Hope this helps,

Maxence