From mboxrd@z Thu Jan 1 00:00:00 1970 Received: (from weis@localhost) by pauillac.inria.fr (8.7.6/8.7.3) id SAA23388 for caml-redistribution; Sat, 29 Aug 1998 18:44:22 +0200 (MET DST) Received: from nez-perce.inria.fr (nez-perce.inria.fr [192.93.2.78]) by pauillac.inria.fr (8.7.6/8.7.3) with ESMTP id FAA21066 for ; Fri, 28 Aug 1998 05:00:55 +0200 (MET DST) Received: from ruby.kaist.ac.kr (ruby.kaist.ac.kr [143.248.190.10]) by nez-perce.inria.fr (8.8.7/8.8.7) with ESMTP id FAA02844 for ; Fri, 28 Aug 1998 05:00:45 +0200 (MET DST) Received: (from jay@localhost) by ruby.kaist.ac.kr (8.8.8H1/8.8.8) id LAA14357; Fri, 28 Aug 1998 11:59:55 +0900 (KST) To: Vincent Poirriez Cc: caml-list@inria.fr Subject: Re: documentation automatique References: <35E55383.1EA9CF14@univ-valenciennes.fr> X-Url: http://pllab.kaist.ac.kr/~jay Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: 8bit Reply-to: jay@compiler.kaist.ac.kr From: Jae-Youn Chung Date: 28 Aug 1998 11:59:55 +0900 In-Reply-To: Vincent Poirriez's message of "Thu, 27 Aug 1998 14:39:32 +0200" Message-ID: X-Mailer: Gnus v5.5/Emacs 20.3 Sender: weis * Vincent Poirriez , 8/27/1998 - 14:39 | I am just reading the new html manual for ocaml 2.0. I appreciate the | introduction of colours in ocaml presentation. let me just ask for a favor of me to html version of manual distributors. I believe that emacs with caml mode and html manual is a perfect combination for programming in caml. In many cases, I really miss for the tools like HyperSpec in common lisp community provided from Harlequin which can be browsed directly from emacs with small pieces of codes (called hyperspec.el). This is possible because HyperSpec html document has xx every identifiers so that we can easily extract that attributes and write down small elisp code with browse-url feature. I've tried to extract every function and type and exceptions in O'caml manual by observing the patterns but which is not so accurate and in some cases failed :(. I think html version must been made from latex or something like that version. Can anybody add some identifiers tag during the translations so that emacs users can easily adopt it to his/her tastes? And one more: In common lisp, there's nice manual browsing program, not to mention HyperSpec which is really an good job, something like clman which is unix *man* like interfaces for lisp functions. I believe caml manual can easily convert like that way. | It should be nice if an automatic documentation tool could be provided | for ocaml. It should take .ml and/or .mli files correctly documented | and return a nice latex/html (eventually via HeVeA) docummentation. I don't know what you exactly want, but if you want to convert your caml code to html with syntax coloring and the like, I'd suggest you the htmlize.el in emacs which is written by Hrvoje Niksic . I believe that converting to latex format is not so hard anyway. (Isn't there many packages which converts program code to latex file?) -- Chung jay youn mailto:jay@pllab.kaist.ac.kr http://pllab.kaist.ac.kr/~jay