Sử dụng các ký tự unicode trong tài liệu Haddock

Question

Haddock có vẻ không mã hóa lại các ký tự không phải ASCII trong tài liệu trong các tệp nguồn được mã hóa UTF-8. Tôi thường cần bao gồm các công thức toán học trong tài liệu và chúng có thể đọc được nhiều hơn nếu một số biểu tượng toán phổ biến như tổng kết (∑) có thể được sử dụng.

Tuy nhiên, sau khi chạy tệp qua mã khóa, các biểu tượng này trở thành ô trống. Haddock có tùy chọn --use-unicode nhưng chỉ chuyển đổi các mũi tên chức năng trong chữ ký chức năng, vv thành các ký tự unicode, trong khi vẫn phá vỡ tài liệu thực sự.

Thậm chí tốt hơn nếu điều này có thể được kiểm soát từ cabal haddock!

Tôi đang sử dụng phiên bản Haddock 2.9.4.

Answer 1

Lưu ý rằng Haddock sử dụng API GHC để phân tích cú pháp. Các ký tự không phải ASCII trong các chú thích không được xử lý đúng cách bởi GHC < 7.4, nhưng có vẻ như với GHC 7.4 nó hoạt động tốt.

Answer 2

Nếu không thể sử dụng UTF-8 và tham chiếu ký tự số như ∑ hoặc &­#x2211; (đây là các tham chiếu chính xác cho biểu tượng tổng kết n-ary) được coi là không thể đọc được, thì tôi sợ tùy chọn duy nhất tài liệu tham khảo như ∑, nếu chúng được chuyển qua kết quả HTML và được hỗ trợ bởi (các) trình duyệt sẽ được sử dụng.

Đó là một lớn “nếu”, kể từ khi tổ chức HTML5 mới có hỗ trợ khá hạn chế, nhưng có lẽ trong một mạng nội bộ mà tất cả mọi người sử dụng Firefox ... HTML5 thực thể: http://www.whatwg.org/specs/web-apps/current-work/multipage/named-character-references.html

(Và hầu hết các tài liệu tham khảo không như được ghi nhớ là ∑.)