doxygenで日本語PDFを作成
doxygenで日本語PDFを作成
doxygenとは、C/C++/PHP等のソースコードに組み込まれたコメントからドキュメントを生成するためのツールであり、JAVAのJAVADOCと同様な物です。このdoxygenはHTMLからRTFまたは、PDF等の出力が可能で大変高機能です。ただし、そのままでは日本語が文字化けしますので、ここではPDFの作成と通して日本語の文字化け対策を整えたい思います。
doxygenの設定と環境整備
まずは、適当な方法でdoxygenとgraphvizをインストールします。graphvizをインストールしておくと関数相関図等の大変グラフィカルな出力に対応できます。
doxygenの設定ファイルは
doxygen -g
のように-gオプションをつけて実行すると雛形が生成されます。以下のような設定を施します。
PROJECT_NAME = Sample Project
PROJECT_NUMBER = 1.0.0
OUTPUT_DIRECTORY = doxygen
OUTPUT_LANGUAGE = Japanese
JAVADOC_AUTOBRIEF = YES
TAB_SIZE = 4
OPTIMIZE_OUTPUT_FOR_C = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
SORT_MEMBER_DOCS = NO
SOURCE_BROWSER = YES
STRIP_CODE_COMMENTS = NO
GENERATE_TREEVIEW = YES
LATEX_CMD_NAME = platex
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
HAVE_DOT = YES
UML_LOOK = YES
あるいは、doxygenのGUIツールを利用して設定してもよいでしょう。
日本語LaTeXの環境設定
http://www.nn.iij4u.or.jp/~tutimura/tex/ptetex.htmlで配布されているtetex関連のファイルをダウンロードします。それぞれ最新のものを利用します。
- ptetex3-20090610.tar.gz
- tetex-src-3.0.tar.gz
- tetex-texmf-3.0po.tar.gz
これらを同一のディレクトリー(例えば、/usr/local/src等）に保存します。
次に、ptetex3をtar xvzf等で解凍し、その中のmy_option.sampleを先ほどのトップディレクトリーにコピーします。
cp my_option.sample ../my_option
以下が修正箇所です。
JAPANESE=international KANJI_CODE=UTF8 conf_option --enable-kanji-iconv XDVI=echo PXDVI=echo
コンパイルを行います。このコンパイルが結構ハマる部分でして、筆者の環境でもエラーがいくつか発生しました。まず、flexとbisonが必須です。また、/usr/include/stdio.hで定義されているreadlineが競合しているため、コメントアウトで対応しました。それと、xaw関連のライブラリーでエラーが発生しました。これは、このライブラリーがインストールされていないためでした。libxaw7-devをインストールしたところエラーは消えました。一つ一つ丁寧に進めればコンパイルは完了できると思います。
その後、rootになって、make installを実行してインストールを行います。インストール中のメッセージにも記載されていますが、/usr/local/TeTeX/binにパスを通す必要があります。/etc/profileに設定して対応しました。
doxygenのLaTeXをコンパイルしてみる
ここまでの設定で日本語PDFを生成する準備ができました。では早速PDFのコンパイルを行ってみましょう。
まず、doxygenによって生成されたlatexディレクトリーに移動し、makeを実行します。設定が正常ならdviファイルが生成されます。
次に、このdviファイルをdvi2pdfmxコマンドでPDFに変換します。
最後に
お疲れ様です。ちゃんと出力できましたか？もし、出力がおかしい場合やカスタマイズを行いたい場合には、doxygenのマニュアル等を参照してみてください。
参考URL
