2012-03-01 12 views
9

Haddockは、UTF-8でエンコードされたソースファイルのドキュメントで非ASCII文字を間違って再エンコードしているようです。私はしばしばドキュメントに数式を含める必要があり、集計(Σ)などの一般的な数学記号を使用できる場合は、はるかに読みやすくなります。Haddockのドキュメントでのユニコード文字の使用

ただし、haddockでファイルを実行した後、これらの記号は空白の四角になります。 Haddockにはオプション--use-unicodeがありますが、実際のドキュメントを破ったまま、関数シグネチャなどの関数矢印をUnicode文字に変換するだけです。

cabal haddockからこれを制御することができます。

私はHaddockバージョン2.9.4を使用しています。

+0

ASCII以外の記号には「ς」などを使用できます。 –

+0

OKですが、ソースが判読できなくなる... –

+0

true、しかしhaddockがUTF-8を自動的に処理していない場合は、その内部を知ることができません。 –

答えて

8

HaddockはGHC APIを使用して解析を行います。コメント内の非ASCII文字は、GHC < 7.4では正しく処理されませんが、GHC 7.4ではうまくいきます。

+4

関連するtracチケット:http://trac.haskell.org/haddock/ticket/20 –

+0

良い情報、ありがとう! –

+0

この回答とHaddockは現在コメントでユニコードを行っているので、すべてパッチを当てています。 –

3

UTF-8を使用することはできないと&#8721;または&­#x2211;などの数値文字参照が(これらは、n進総和記号Σの正しい基準となる)読めないと見なされている場合は、私が唯一の選択肢という名前を使用することです怖いです&sum;のような参照は、HTML結果に渡されると、使用されるブラウザでサポートされます。

新しいHTML5のエンティティがかなり限定されたサポートを持っていますが、おそらく誰もがFirefoxの... HTML5のエンティティを使用して、イントラネットでいるため「もし」大きいです: http://www.whatwg.org/specs/web-apps/current-work/multipage/named-character-references.html

(および参照の多くはありません)

関連する問題