Browse thread
[Caml-list] Documentation tools
-
Xavier Leroy
- Sven LUTHER
- Peter Ronnquist
- Christian Lindig
- markus.kliegl@t...
- Stefan Monnier
- Emmanuel LEDINOT
[
Home
]
[ Index:
by date
|
by threads
]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
| Date: | -- (:) |
| From: | Christian Lindig <lindig@e...> |
| Subject: | Re: [Caml-list] Documentation tools |
> Suggestions and pointers to existing documentation systems are most
> welcome.
Lesser known markup languages:
Perl's POD: http://www.perldoc.com/perl5.6/pod/perlpod.html
Can be translated to man, HTML, LaTeX, plain text.
WikiWiki syntax: http://www.c2.com/cgi/wiki?TextFormattingRules
Many Wiki implementations use more advanced markup but this is the
original.
Python's Structured Text: http://www.cis.upenn.edu/~edloper/pydoc/stminus-001.html
All three markup languages aim to use as feq special syntax as
possible. Structured Text seems to be the most advanced using
indentation to denote structure. This is in a sharp contrast to the
SGML/XML approach which is quite verbose at the source level. LaTeX
seems to have found a middle ground. Personally I'd prefer something
like Structured Text or LaTeX for OCaml.
-- Christian
--
Christian Lindig Harvard University - DEAS
lindig@eecs.harvard.edu 33 Oxford St, MD 242, Cambridge MA 02138
phone: +1 (617) 496-7157 http://www.eecs.harvard.edu/~lindig/
-------------------
To unsubscribe, mail caml-list-request@inria.fr. Archives: http://caml.inria.fr