Re: hypertext ML code

Re: hypertext ML code

[Valerie Menissier-Morain]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain, Size: 861 bytes --]


Etags (for emacs), ctags (for vi) do this. It seems to me that there was
a small package to create ml ad hoc tags in the distribution of Caml-Light
0.6 with the name mletags.

-----------------------------------------------------------
Valérie Ménissier-Morain 
-----------------------------------------------------------
INRIA Projets Coq & Cristal
Domaine de Voluceau -- BP 105 -- F-78153 Rocquencourt Cedex
Tel.: (33 1) (16 1) 39 63 55 98 
Fax: (33 1) (16 1) 39 63 53 30
E-mail: Valerie.Menissier@inria.fr
-----------------------------------------------------------
Université d'Évry Val d'Essonne
Département Informatique/Mathématiques
4, Boulevard des Coquibus
91025 Évry Cedex
Tel.: (33 1) (16 1) 69 47 74 74
Fax: (33 1) (16 1) 69 47 74 72
E-mail: Valerie.Menissier-Morain@lami.univ-evry.fr
-----------------------------------------------------------

Re: hypertext ML code

[Mark Hayden]

>Etags (for emacs), ctags (for vi) do this. It seems to me that there was
>a small package to create ml ad hoc tags in the distribution of Caml-Light
>0.6 with the name mletags.

I'm aware of this package.  However, it is not exactly what
I want.  It provides information to help emacs/vi let you
browse your source code.  What I want is a marked-up
version of my source code, so that I can browse it in, for
instance, a WWW browser.  I do not believe this is possible
with mletags alone.

My end goal is to combine hypertext source code with
hypertext text documentation (latex source compiled with
latex2html) into a single, browsable hypertext document.

--Mark

Re: hypertext ML code

[Pierre Weis]

> I'm aware of this package [mletags].  However, it is not exactly what
> I want.  It provides information to help emacs/vi let you
> browse your source code.  What I want is a marked-up
> version of my source code, so that I can browse it in, for
> instance, a WWW browser.  I do not believe this is possible
> with mletags alone.
> 
> My end goal is to combine hypertext source code with
> hypertext text documentation (latex source compiled with
> latex2html) into a single, browsable hypertext document.

With the standard distribution, the contribution by Franc,ois Rouaix
in the directory

contrib/camltk/browser/ 

provides a unix camlbrowser command that may be helpful

``camlbrowser: A Caml Light environment browser.
  camlbrowser is an hypertext tool to browse library and program modules.''

I guess you need to change the sources of camlbrowser to meet your
goal, or even need to inspire from another Web tool from Franc,ois
Rouaix the mmm browser (http://pauillac.inria.fr:80/~rouaix/mmm/).

Nevertheless I daily use camlbrowser, which is very useful to manage
your sources or to find documentation about the Caml Light library functions...

Pierre Weis
----------------------------------------------------------------------------
WWW Home Page: http://pauillac.inria.fr/~weis
Projet Cristal
INRIA, BP 105, F-78153 Le Chesnay Cedex (France)
E-mail: Pierre.Weis@inria.fr
Telephone: +33 1 39 63 55 98
Fax: +33 1 39 63 53 30
----------------------------------------------------------------------------

Re: hypertext ML code

[Xavier Leroy]

> My end goal is to combine hypertext source code with
> hypertext text documentation (latex source compiled with
> latex2html) into a single, browsable hypertext document.

Ah, if you're into literate programming in Caml, you might find
Norman Ramsey's NoWeb package interesting
(http://www.cs.purdue.edu/homes/nr/noweb/).
It is claimed to have indexing capabilites for several languages
including Standard ML (should be easy to adapt to Caml) and generates
both LaTeX and HTML.

I haven't used it myself, but have heard positive comments about
it. If you find it useful for Caml source, let us know.

- Xavier Leroy

Re: hypertext ML code

[Thorsten Ohl]

>>>>> "Xavier" == Xavier Leroy <Xavier.Leroy@inria.fr> writes:

Xavier> Ah, if you're into literate programming in Caml, you might
Xavier> find Norman Ramsey's NoWeb package interesting
Xavier> (http://www.cs.purdue.edu/homes/nr/noweb/).  It is claimed to
Xavier> have indexing capabilites for several languages including
Xavier> Standard ML (should be easy to adapt to Caml) and generates
Xavier> both LaTeX and HTML.

Just my 2 centimes: I can wholeheartedly recommend it and I ``don't
code without it'' :-).

With a little makefile hacking it can support CSL-style separate
compilation easily.  If somebody is fluent in the Icon language,
he/she should be able to adapt the automatic cross referencer for SML
to CSL without much trouble (I couldn't find free docs for Icon, so I
punted on that).

Marking the definitions by hand isn't too inconvenient either and
gives you more fine grained control (in case do not want to cross
reference everything).  References are handled automatically anyway.

-Thorsten

/// Thorsten Ohl, TH Darmstadt, Schlossgartenstr. 9, D-64289 Darmstadt, Germany
//// http://crunch.ikp.physik.th-darmstadt.de/~ohl //// voice: +49-6151-16-3116
///// email: Thorsten.Ohl@Physik.TH-Darmstadt.de /// secretary: 2072, fax: 2421

hypertext ML code

[Mark Hayden]

Hi,
  I am interested in automatically generating
from normal ML source code hypertext ML code
that has links from references to type/value
binding occurences.  Does anyone know of an
existing package that does this?  It seems
that this should be easy build such a
compiler by hacking an existing ML compiler.

thanks, Mark