« Agile Japan 2011 基調講演は Linda Risingさん | トップページ | TortoiseSVNのバージョンアップ »

Sphinxでテーブル(表)を作成する時の注意点

ドキュメント作成ツール Sphinxについて初めてブログに投稿してから3ケ月以上経ってしまいましたが、地道に文書作成に使っています。makeではHTMLを作っているだけですが、組込みのHTMLテーマを利用することでいくつか見た目の印象が異なる文書を作成できて便利です。練習は別として初めてまとまったドキュメント作成に使ったのが「sphinxdoc」という薄い青灰色のテーマで、他に「traditional」と「nature」の見た目を確認し、今作っているものは「haiku」を選んでみました。

さて、昨日もSphixを使って少しドキュメントを書いていたのですが、罫線を利用してテーブル(日本語だと「表」がいちばんイメージしやすい)を作成すると、かなり調整が必要と分かりました。サンプルとして、rstソースのテキストとFireFox 3.6.13で表示したHTMLの画像を載せておきます。

reStructuredText入門  「テーブル」

テーブル作成での罫線の長さ

====================  =======  =======  =======  =======
図の名称               参照     作成     編集     削除
====================  =======  =======  =======  =======
クラス図               OK       OK       OK       OK
コミュニケーション図   -        -        -        -
データフロー図(DFD)    OK       -        -        -
====================  =======  =======  =======  =======

rstのソースでは日本語と線がずれている(線より日本語が長い)ところはありません。しかし、make結果のHTMLを見ると、等幅フォントのソースでは文字数が多いコミュニケーション図よりも、データフロー図(DFD)の方が長く見えますし、見出し行の「削除」は幅が不足して縦に表示されています。

Table1_2

そこで、ソースに戻って「図の名称」列の罫線を半角2桁増やしてみました。すると、今度は「作成」が縦に表示されました。
Table2

「図の名称」列の罫線を、さらに半角2桁増やしてみます。

========================  =======  =======  =======  =======
図の名称                   参照     作成     編集     削除
========================  =======  =======  =======  =======
クラス図                   OK       OK       OK       OK
コミュニケーション図       -        -        -        -
データフロー図(DFD)        OK       -        -        -
========================  =======  =======  =======  =======

Table3
ようやくすっきりと表示されました。

プロポーショナルフォントで表示されるため、ソースとHTMLの見え方が異なっていますし、どうもテーブルの左側で罫線が不足していると認識されると、右側の表示に影響が出るようです。また、FireFoxの例をあげましたが、同じmake結果のHTMLを IE8で表示すると、縦の線が見えません。rstのシンプルテーブル(==で表を書く方法)を使った場合、IEでは縦線が表示されないのです。
Table4

表示を確認しながら、文字に対する罫線は長めに書くのが良さそうです。

|

« Agile Japan 2011 基調講演は Linda Risingさん | トップページ | TortoiseSVNのバージョンアップ »

Sphinx」カテゴリの記事

コメント

コメントを書く



(ウェブ上には掲載しません)


コメントは記事投稿者が公開するまで表示されません。



トラックバック

この記事のトラックバックURL:
http://app.f.cocolog-nifty.com/t/trackback/98967/38643157

この記事へのトラックバック一覧です: Sphinxでテーブル(表)を作成する時の注意点:

« Agile Japan 2011 基調講演は Linda Risingさん | トップページ | TortoiseSVNのバージョンアップ »