From: Thorsten Ohl <ohl@hep.tu-darmstadt.de>
To: caml-list@inria.fr
Subject: Re: [Caml-list] CDK binary release
Date: Thu, 10 May 2001 18:08:12 +0200 [thread overview]
Message-ID: <15098.48364.427110.543643@heplix4.ikp.physik.tu-darmstadt.de> (raw)
In-Reply-To: <15098.46839.795500.758294@pc803>
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
next prev parent reply other threads:[~2001-05-10 16:08 UTC|newest]
Thread overview: 31+ messages / expand[flat|nested] mbox.gz Atom feed top
2001-05-07 9:06 Fabrice Le Fessant
2001-05-07 16:09 ` Miles Egan
2001-05-07 17:17 ` John Max Skaller
2001-05-09 10:58 ` Markus Mottl
2001-05-09 12:01 ` [Caml-list] About documentation tools David Mentre
2001-05-09 13:18 ` [Caml-list] " Markus Mottl
2001-05-09 18:17 ` John Max Skaller
2001-05-09 17:58 ` [Caml-list] CDK binary release John Max Skaller
2001-05-09 22:40 ` Markus Mottl
2001-05-09 23:19 ` John Max Skaller
2001-05-10 9:19 ` Fabrice Le Fessant
2001-05-10 10:34 ` [Caml-list] CDK Documentation format Dave Mason
2001-05-13 21:26 ` Stefan Monnier
2001-05-10 11:16 ` [Caml-list] CDK binary release Sven LUTHER
2001-05-10 13:18 ` Markus Mottl
2001-05-10 15:42 ` Jean-Christophe Filliatre
2001-05-10 16:08 ` Thorsten Ohl [this message]
2001-05-10 22:53 ` Markus Mottl
2001-05-10 20:36 ` John Max Skaller
2001-05-10 14:01 ` David Mentre
2001-05-10 15:09 ` Patrick M Doane
2001-05-10 15:06 ` Patrick M Doane
2001-05-11 11:58 ` Fabrice Le Fessant
2001-05-11 15:31 ` John Max Skaller
2001-05-11 15:44 ` Fabrice Le Fessant
2001-05-13 21:33 ` Stefan Monnier
2001-05-11 17:30 ` Patrick M Doane
2001-05-12 7:46 ` Fabrice Le Fessant
2001-05-11 23:24 ` Brian Rogoff
2001-05-10 15:49 ` John Max Skaller
2001-05-14 8:21 ` Olivier Andrieu
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=15098.48364.427110.543643@heplix4.ikp.physik.tu-darmstadt.de \
--to=ohl@hep.tu-darmstadt.de \
--cc=caml-list@inria.fr \
/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.
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 NNTP newsgroup(s).