Использование символов Юникода в документации Haddock - PullRequest
9 голосов
/ 01 марта 2012

Кажется, что Хэддок неправильно перекодирует символы, не входящие в ASCII, в документации в кодированных исходных файлах UTF-8. Мне часто нужно включать математические формулы в документацию, и они гораздо более читабельны, если можно использовать некоторые общие математические символы, такие как суммирование (mation).

Однако, после запуска файлов через пикшу, эти символы становятся пустыми квадратами. В Haddock есть опция --use-unicode, но она просто преобразует стрелки функций в сигнатурах функций и т. Д. В символы Юникода, в то же время нарушая действительную документацию.

Еще лучше было бы, если бы этим можно было управлять с cabal haddock!

Я использую Haddock версии 2.9.4.

Ответы [ 2 ]

8 голосов
/ 02 марта 2012

Обратите внимание, что Haddock использует GHC API для анализа. Не-ASCII символы в комментариях не обрабатываются должным образом GHC <7.4, но кажется, что с GHC 7.4 он работает нормально. </p>

3 голосов
/ 01 марта 2012

Если UTF-8 нельзя использовать и числовые ссылки на символы, такие как &#8721; или &­#x2211; (это правильные ссылки для n -ного символа суммирования ∑), считаются нечитаемыми, то, боюсь, единственный вариант -использовать именованные ссылки, такие как &sum;, если они передаются через HTML-результат, и поддерживаются используемым браузером.

Это большое «если,»Поскольку новые сущности HTML5 имеют довольно ограниченную поддержку, но, возможно, во внутренней сети, где все используют Firefox ... сущности HTML5: http://www.whatwg.org/specs/web-apps/current-work/multipage/named-character-references.html

(И большинство ссылок не являются такими же мнемоническими, как &sum;.)

...