From: Fabrice Le Fessant <fabrice.le_fessant@inria.fr>
To: John Max Skaller <skaller@ozemail.com.au>
Cc: Markus Mottl <mottl@miss.wu-wien.ac.at>, caml-list@inria.fr
Subject: Re: [Caml-list] CDK binary release
Date: Thu, 10 May 2001 11:19:40 +0200 (CEST) [thread overview]
Message-ID: <15098.23852.403551.65183@cremant.inria.fr> (raw)
In-Reply-To: <3AF9D067.93E6DE1A@ozemail.com.au>
The CDK documentation tool has still many problems, but it is
currently the only tool which produces man pages for Ocaml modules and
functions. Moreover, LaTeX is not used by all Ocaml users (some are
using Windows and its wonderful editors). For now, I think the best
language is a specific language, for example, a subset of HTML.
This would have the benefit of being easily translatable to LaTex(ie PS),
HTML and MAN (I think HTML --> LaTeX is easier than LaTeX --> HTML,
even with HeVea). Note that the current language used by cdk_doc is
documented in the HTML documentation of the CDK (cdk_doc.html).
cdk_doc was not designed for being used by everybody, but to generate
immediatly some documentation for the CDK with a minimal effort. Now,
we have to think about how to change Sebastien's tool in a more
general documentation tool. But, we have the same problem with
cdk_config (and findlib).
Another approach I used a few years ago was to generate HTML
documentation using the compiler, which can add cross-links between
modules (and even between types in the same module). This could be
another good idea ...
- Fabrice
-------------------
To unsubscribe, mail caml-list-request@inria.fr. Archives: http://caml.inria.fr
next prev parent reply other threads:[~2001-05-10 9:34 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 [this message]
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
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.23852.403551.65183@cremant.inria.fr \
--to=fabrice.le_fessant@inria.fr \
--cc=caml-list@inria.fr \
--cc=mottl@miss.wu-wien.ac.at \
--cc=skaller@ozemail.com.au \
/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).