Version française
Home     About     Download     Resources     Contact us    
Browse thread
[Caml-list] CDK binary release
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: -- (:)
From: Thorsten Ohl <ohl@h...>
Subject: Re: [Caml-list] CDK binary release
Jean-Christophe Filliatre writes:

> But  the purposes  of cdk_doc and ocamlweb are clearly different:
>
>  - cdk_doc is nice to produce  HTML documentations of libraries, to be
>    browsed when developping.
> 
>  - ocamlweb is a  literate programming tool; it means  that it is used
>    to produce  a document describing  the all code i.e.  interface but
>    also implementation,

Yes, but it would be very useful if the markup could serve both
purposes simultaneously.  I'm using ocamlweb extensively and I find
myself writing *.mli files that could be turned into online
documentation (see
http://heplix.ikp.physik.tu-darmstadt.de/~ohl/omega/omega.pdf for an
extended example).  Navigating a hyperlinked PDF version of the woven
file is easy enough, but quick online documentation generated from the
_same_ *.mli files (ignoring the implementation files) would also be a
very welome addition.

It's not entirely trivial to design something doesn't constrain
ocamlweb too much, in particula in the math arena, but it could be
done.

A first step would be for ocamlweb to ignore the cdk_doc markup and
for cdk_doc to map TeX commands to a ``under construction'' tag.
-- 
Thorsten Ohl, Physics Department, TU Darmstadt -- ohl@hep.tu-darmstadt.de
http://heplix.ikp.physik.tu-darmstadt.de/~ohl/ [<=== PGP public key here]
-------------------
To unsubscribe, mail caml-list-request@inria.fr.  Archives: http://caml.inria.fr