Ocamldoc and Unicode characters

Ocamldoc and Unicode characters

[Romain Bardou]

Hello,

If I put some unicode characters inside an ocamldoc comment, it is 
copied as is, but the browser does not print them correctly because the 
page header does not say that the page is encoded using unicode.

Is there a way I can change the header of the generated pages 
automatically to change the encoding information?

Thanks,

-- 
Romain Bardou

Re: [Caml-list] Ocamldoc and Unicode characters

[Daniel Bünzli]

> Is there a way I can change the header of the generated pages automatically to change the encoding information?

AFAIK, no (also had this problem once).

Best,

Daniel

Re: [Caml-list] Ocamldoc and Unicode characters

[Maxence Guesdon]

On Thu, 03 Jun 2010 15:04:42 +0200
Romain Bardou <Romain.Bardou@lri.fr> wrote:

> Hello,
> 
> If I put some unicode characters inside an ocamldoc comment, it is 
> copied as is, but the browser does not print them correctly because the 
> page header does not say that the page is encoded using unicode.
> 
> Is there a way I can change the header of the generated pages 
> automatically to change the encoding information?
> 
> Thanks,
> 
> -- 
> Romain Bardou
> 
> _______________________________________________
> 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

I see two easy solutions:

1. Something like
  sed 's:iso-8859-1:UTF-8:'
 on each ocamldoc-generated html file

2. or create and use your own ocamldoc-generator as explained here:
    http://caml.inria.fr/pub/docs/manual-ocaml/manual029.html#toc112
In this generator, just set the character_encoding field something else
than the default which is
 "<meta content=\"text/html; charset=\"iso-8859-1\" http-equiv=\"Content-Type\">\n"

Somehting like the following code should to the trick:
class my_doc_gen =
  object
    initializer
       character_encoding <-
       "<meta content=\"text/html; charset=\"UTF-8\" http-equiv=\"Content-Type\">\n"
  end

let my_generator = new my_doc_gen
let _ = Odoc_args.set_doc_generator (my_generator :> Odoc_args.doc_generator)

(code not tested)

Hope this helps,

-- 
Maxence Guesdon                             http://yquem.inria.fr/~guesdon/
Service Expérimentation et Développements         https://sed-roc.inria.fr/
INRIA Paris-Rocquencourt                  http://www.inria.fr/rocquencourt/

Re: [Caml-list] Ocamldoc and Unicode characters

[Maxence Guesdon]

On Thu, 3 Jun 2010 15:27:51 +0200
Maxence Guesdon <Maxence.Guesdon@inria.fr> wrote:

> 
> Somehting like the following code should to the trick:
> class my_doc_gen =
>   object

I forgot:
  inherit Odoc_html.html

...

Regards,

-- 
Maxence Guesdon                             http://yquem.inria.fr/~guesdon/
Service Expérimentation et Développements         https://sed-roc.inria.fr/
INRIA Paris-Rocquencourt                  http://www.inria.fr/rocquencourt/

Re: [Caml-list] Ocamldoc and Unicode characters

[Daniel Bünzli]

> I see two easy solutions:

[...]

Sure they are easy but they significantly complicate one's build
system for very little.

A command line switch for this in ocamldoc would be nice and forward
looking (since the rest of the tool suite is perfectly able to deal
directly with UTF-8 encoded sources).

Best,

Daniel

Re: [Caml-list] Ocamldoc and Unicode characters

[Maxence Guesdon]

Le Thu, 3 Jun 2010 16:18:43 +0200,
Daniel Bünzli <daniel.buenzli@erratique.ch> a écrit :

> > I see two easy solutions:
> 
> [...]
> 
> Sure they are easy but they significantly complicate one's build
> system for very little.
> 
> A command line switch for this in ocamldoc would be nice and forward
> looking (since the rest of the tool suite is perfectly able to deal
> directly with UTF-8 encoded sources).

Agreed, but 3.12.0 is already in feature freeze. Will be for 3.12.1.

Regards,

Maxence

Re: [Caml-list] Ocamldoc and Unicode characters

[David MENTRE]

Hello,

2010/6/3 Maxence Guesdon <maxence.guesdon@inria.fr>:
> Daniel Bünzli <daniel.buenzli@erratique.ch> a écrit :
>> A command line switch for this in ocamldoc would be nice and forward
>> looking (since the rest of the tool suite is perfectly able to deal
>> directly with UTF-8 encoded sources).
>
> Agreed, but 3.12.0 is already in feature freeze. Will be for 3.12.1.

BTW, maybe switching to UTF-8 by default wouldn't be that bad.

Best regards,
d.

Re: [Caml-list] Ocamldoc and Unicode characters

[Romain Bardou]

On 03/06/2010 22:29, Maxence Guesdon wrote:
> Le Thu, 3 Jun 2010 16:18:43 +0200,
> Daniel Bünzli<daniel.buenzli@erratique.ch>  a écrit :
>
>>> I see two easy solutions:
>>
>> [...]
>>
>> Sure they are easy but they significantly complicate one's build
>> system for very little.
>>
>> A command line switch for this in ocamldoc would be nice and forward
>> looking (since the rest of the tool suite is perfectly able to deal
>> directly with UTF-8 encoded sources).
>
> Agreed, but 3.12.0 is already in feature freeze. Will be for 3.12.1.

Great ! I'll just wait then :p

-- 
Romain Bardou