2013年3月18日月曜日

補足: OpenCTMのドキュメンテーション

先ほどOpenCTMを紹介する記事を書きましたが、「ドキュメンテーションはどこじゃ?」となるかもしれません。

たいていのOSSではオンラインの公式サイトに直接転がっていますが、OpenCTMのドキュメンテーションは、ライブラリーやツールと一緒にソースコードと同梱で配布されています。

但し、ビルドしないと読めません(*´ω`*)
(Windows向けのビルド済みパッケージにはドキュメンテーションもビルド済みで同梱されていた気がするけど。)

Linux Mint(≈Ubuntu)環境でOpenCTMのドキュメンテーションのビルドに必要なツールは、
  • texlive-full
  • doxygen
  • groff
の3つ。全てaptで導入できます。

必要なツールを導入の後、ソースのdocディレクトリーで
  • make -f Makefile.linux
と、すると、
  • DevelopperManual.pdf
    • 開発者マニュアル
  • FormatSpecification.pdf
    • ファイル形式仕様書
  • APIReference/index.html
    • APIリファレンス
  • ctmconv.html
    • ctmconvコマンドラインツール説明書
  • ctmview.html
    • ctmviewコマンドラインツール説明書
が生成されます。

(追記: 2013-03-18 21:50頃)

そのままだとAPIReferenceはHTML形式で出力されますが、

  1. DoxyfileのGENERATE_LATEXをNO→YESに書き換え、
  2. doxygenしてlatexを生成し、
  3. cd latex
  4. make pdf
とかするとrefman.pdfとしてPDF形式のAPIリファレンスも生成できます。お好みに応じてどうぞ(*´ω`*)

0 件のコメント:

コメントを投稿