試験管のなかのコード

[DocBook] DocBook Doclet にチャレンジ

DocBook Doclet

DocBook Doclet は Javadoc のカスタム doclet。 API Document を PDF や Docbook 形式など様々な形式で出力することができるスグレモノ。 API Document を Docbook 形式で出力できると便利なので早速試してみた。

dbdoclet

http://www.michael-a-fuchs.de/index.html

DocBook Doclet のインストール

DocBook Doclet は、Javadoc へ組み込んで使用する jar と単体で動作する GUI アプリケーションの 2 種類のバイナリが提供されている。 とりあえず時間もないので GUI アプリケーションを試してみることに。

1. こちらから Windows 用のバイナリをダウンロードする。ここでは dbdoclet-0_70_1.exe を使用。
2. ダウンロードしたバイナリを実行するとインストーラが起動するので、後はインストーラの指示通りにインストールする。
   但し、インストール先ディレクトリはスペースが含まれないパスに変更した。念のためだけれど。
3. デスクトップ上に作成されるショートカットを削除(使用できなかったので)
4. 起動用のバッチファイルを作成

   set JAVA_HOME=c:\_java\jdk\1.5.0_06
   set PATH=%JAVA_HOME%\bin;%PATH%
   set DOCLET_HOME=C:\_java\tool\DocBookDoclet
   set DOCLET_JAR=%DOCLET_HOME%\jars\tidbit.jar
   
   java.exe -Xmx512m -Dhome=%DOCLET_HOME% -jar %DOCLET_JAR%
   

DocBook Doclet で DocBook 形式の API Document 作成

1. 上で作成した起動用バッチファイルを使用して DocBook Doclet を起動する。
2. プロジェクトを新規作成する
3. "Project" タブで "Project name"、"Destination directory" を設定
4. "Sources" タブで "Sourcepath" を設定して "Add" ボタンを押下
5. "Classpath" タブで "Classpath" を設定して "Add" ボタンを押下
6. 必要に応じて "Javadoc"、"DocBook XML"、"PDF layout"、"Trafo" も設定
7. "DocBook" ボタンを押下
8. "Destination directory" で指定したディレクトリの中に docbook/Reference.xml が生成される

Posted in DocBook | WriteBacks (0) | | | Bookmark this on Delicious

[DocBook] DocBook メモ

DocBook とは

ドキュメント記述用に規定された XML の標準フォーマット。 DocBook でドキュメントを記述しておくと、ツールを使用して HTML や PDF、RTF など様々なフォーマットに変換できるためにドキュメントのポータビリティが向上する。

既に現在のプロジェクトでは DocBook を導入済みで実績もあるのだが、より広範囲に使用したいので再調査。 出来れば DocBook → HTML、PDF、MS Word の変換を出来る環境を整えたい。 環境の構築(Word への変換は自作??)からメンバーの教育まで、難所が多そうだ。

DocBook 参考資料

Docbook 公式サイト

http://docbook.org/

Docbook Specifications ・・・ 様々なバージョンの仕様書

http://docbook.org/specs/index.html

DocBook 5.0: The Definitive Guide

http://docbook.org/tdg5/en/html/docbook.html

DocBook XSL Stylesheets

http://docbook.sourceforge.net/projects/xsl/

DocBook で文書を書こう！

http://members.at.infoseek.co.jp/zzyyb/docbook/

Posted in DocBook | WriteBacks (2) | | | Bookmark this on Delicious