From mboxrd@z Thu Jan 1 00:00:00 1970 Received: (from majordomo@localhost) by pauillac.inria.fr (8.7.6/8.7.3) id PAA29501; Mon, 14 May 2001 15:32:17 +0200 (MET DST) X-Authentication-Warning: pauillac.inria.fr: majordomo set sender to owner-caml-list@pauillac.inria.fr using -f Received: from concorde.inria.fr (concorde.inria.fr [192.93.2.39]) by pauillac.inria.fr (8.7.6/8.7.3) with ESMTP id PAA29487 for ; Mon, 14 May 2001 15:32:16 +0200 (MET DST) Received: from lakeland.eecs.harvard.edu (lakeland.eecs.harvard.edu [140.247.62.173]) by concorde.inria.fr (8.11.1/8.10.0) with ESMTP id f4EDWE527342 for ; Mon, 14 May 2001 15:32:14 +0200 (MET DST) Received: by lakeland.eecs.harvard.edu (Postfix, from userid 32148) id EC801183F2; Mon, 14 May 2001 09:32:10 -0400 (EDT) Date: Mon, 14 May 2001 09:32:10 -0400 From: Christian Lindig To: Xavier Leroy Cc: caml-list@pauillac.inria.fr Subject: Re: [Caml-list] Documentation tools Message-ID: <20010514093210.C11616@lakeland.eecs.harvard.edu> Mail-Followup-To: Christian Lindig , Xavier Leroy , caml-list@pauillac.inria.fr References: <20010514101144.A22215@pauillac.inria.fr> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline User-Agent: Mutt/1.2.5i In-Reply-To: <20010514101144.A22215@pauillac.inria.fr>; from Xavier.Leroy@inria.fr on Mon, May 14, 2001 at 10:11:44AM +0200 Sender: owner-caml-list@pauillac.inria.fr Precedence: bulk > 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