Version française
Home     About     Download     Resources     Contact us    
Browse thread
File inclusion with Ocamldoc
[ Home ] [ Index: by date | by threads ]
[ Search: ]

[ Message by date: previous | next ] [ Message in thread: previous | next ] [ Thread: previous | next ]
Date: -- (:)
From: Maxence Guesdon <maxence.guesdon@i...>
Subject: Re: [Caml-list] File inclusion with Ocamldoc
Dario Teixeira <darioteixeira@yahoo.com> a ?it :

> 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  
(without (** *)) in a file.txt file and pass it to ocamldoc like any  
.ml or .mli file. This will be considered as a File module and you can  
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.