From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.1.3 (2006-06-01) on yquem.inria.fr X-Spam-Level: X-Spam-Status: No, score=0.0 required=5.0 tests=none autolearn=disabled version=3.1.3 Received: from mail4-relais-sop.national.inria.fr (mail4-relais-sop.national.inria.fr [192.134.164.105]) by yquem.inria.fr (Postfix) with ESMTP id C95C1BBAF for ; Tue, 14 Oct 2008 19:22:12 +0200 (CEST) X-IronPort-AV: E=Sophos;i="4.33,410,1220220000"; d="scan'208";a="30337153" Received: from pericui.inria.fr (HELO localhost) ([128.93.24.186]) by mail4-relais-sop.national.inria.fr with ESMTP; 14 Oct 2008 19:22:12 +0200 Received: from 217.109.87.61 ([217.109.87.61]) by pops-rocq.inria.fr (Horde MIME library) with HTTP; Tue, 14 Oct 2008 19:22:12 +0200 Message-ID: <20081014192212.jranx5bddwc4woog@pops-rocq.inria.fr> Date: Tue, 14 Oct 2008 19:22:12 +0200 From: Maxence Guesdon To: Dario Teixeira Cc: caml-list@yquem.inria.fr Subject: Re: [Caml-list] File inclusion with Ocamldoc References: <595837.10580.qm@web54607.mail.re2.yahoo.com> In-Reply-To: <595837.10580.qm@web54607.mail.re2.yahoo.com> MIME-Version: 1.0 Content-Type: text/plain; charset=ISO-8859-1; DelSp="Yes"; format="flowed" Content-Disposition: inline Content-Transfer-Encoding: quoted-printable User-Agent: Internet Messaging Program (IMP) H3 (4.1.3) X-Spam: no; 0.00; maxence:01 guesdon:01 maxence:01 guesdon:01 ocamldoc:01 customised:01 ocamldoc:01 mli:01 -html:01 beginner's:01 ocaml:01 bug:01 beginners:01 caml-list:01 caml-list:01 Dario Teixeira a ?it=A0: > Hi, Hello, > I want to create a customised APIDOC starter page that includes > links to child pages containing various tutorials for the API. > Now, Ocamldoc already has a -intro option that allows an external > file to be used as an APIDOC starter page. But I see no way > to create a link to an external file from within this starter > page, and to tell Ocamldoc to also process and include the > external file. Does someone know of a straightforward solution > for this problem? You can use .txt files to do this. Simply type ocamldoc comment =20 (without (** *)) in a file.txt file and pass it to ocamldoc like any =20 .ml or .mli file. This will be considered as a File module and you can =20 refer to it by {!File} from any ocamldoc comment. Example: cat > file.txt This is the {!File} file. ocamldoc -html file.txt Hope this helps, Maxence Guesdon > Thanks! > Dario Teixeira > > > > > > _______________________________________________ > Caml-list mailing list. Subscription management: > http://yquem.inria.fr/cgi-bin/mailman/listinfo/caml-list > Archives: http://caml.inria.fr > Beginner's list: http://groups.yahoo.com/group/ocaml_beginners > Bug reports: http://caml.inria.fr/bin/caml-bugs > ---------------------------------------------------------------- This message was sent using IMP, the Internet Messaging Program.