Mantis Bug Tracker

View Issue Details Jump to Notes ] Issue History ] Print ]
IDProjectCategoryView StatusDate SubmittedLast Update
0005497OCamlOCaml documentationpublic2012-01-31 11:252013-08-31 12:46
Reporterkosik 
Assigned To 
PrioritylowSeverityminorReproducibilityalways
StatusclosedResolutionfixed 
PlatformOSOS Version
Product Version3.12.1 
Target VersionFixed in Version3.13.0+dev 
Summary0005497: Ocaml source-code examples are not "copy-paste-able" (if they employ apostrophe-character)
DescriptionThe program that renders HTML and PDF version of the Reference Manual projects ordinary apostrophe-character to (in case of HTML)

  ’

and in case of PDFs probably to some non-ASCII character.

As a result, when reader tries to copy-paste provided examples to Ocaml toplevel, e.g.

   http://caml.inria.fr/pub/docs/manual-ocaml/manual003.html#toc5 [^]

he gets an error:

   # ??a’;;
   Error: Illegal character (\128)

"Reader-friendly-ness" can be improved if source-code excerpts, that include apostrophe-characters, can be freely copy-pasted without the need to manually translate characters.
TagsNo tags attached.
Attached Files

- Relationships
related to 0005261closed Parse errors reported by toplevel for code of section 1.8 

-  Notes
(0006857)
dbuenzli (reporter)
2012-01-31 11:51

To the doc maintainers. If you are using the listings package. Add the following at the beginning of the document :

\lstset{upquote=true} %% Otherwise ticks look like backticks.
(0006871)
doligez (administrator)
2012-02-01 13:56

This is the second problem reported in PR#5261.
(0006881)
xleroy (administrator)
2012-02-05 11:33

The LaTeX sources for the manual do not use the listings package, but some old TeX hacks very similar to verbatim and alltt styles. And, yes, these are proper ASCII single quote characters in the LaTeX sources.

For the PDF output, we really don't control what's going on between pdflatex and the PDF reader. However, for the Hevea-generated HTML output, one would hope that ASCII quotes can be generated. Luc, could you please have a look at this issue?
(0006905)
doligez (administrator)
2012-02-09 19:09
edited on: 2012-02-10 10:12

Fixed in the PDF version in trunk [3.13.0] (commit 12142).
Fixed also for backquote characters (commit 12145).

TODO: see with Luc how to fix it in the HTML version.

(0006926)
doligez (administrator)
2012-02-15 13:25

Fixed also in the HTML version in trunk [3.13.0] (commit 12157).

- Issue History
Date Modified Username Field Change
2012-01-31 11:25 kosik New Issue
2012-01-31 11:51 dbuenzli Note Added: 0006857
2012-02-01 13:55 doligez Relationship added related to 0005261
2012-02-01 13:56 doligez Note Added: 0006871
2012-02-01 13:56 doligez Status new => confirmed
2012-02-05 11:33 xleroy Note Added: 0006881
2012-02-09 19:09 doligez Note Added: 0006905
2012-02-10 10:12 doligez Note Edited: 0006905 View Revisions
2012-02-15 13:25 doligez Note Added: 0006926
2012-02-15 13:25 doligez Status confirmed => resolved
2012-02-15 13:25 doligez Resolution open => fixed
2012-02-15 13:25 doligez Fixed in Version => 3.13.0+dev
2013-08-31 12:46 xleroy Status resolved => closed


Copyright © 2000 - 2011 MantisBT Group
Powered by Mantis Bugtracker