DITADoclet と DITA API 特殊化を利用して DITA Java API リファレンス・マニュアルを生成する

DITA API 特殊化によって Java ソースから自動的にリファレンス・マニュアルを作成する方法

DITADoclet は Java ソース・コードから直接、開発者のコメントを抽出して完全な DITA Java™ API リファレンス・ファイル一式を生成します。時間を節約しながらも、品質の高い API ドキュメントを作成するために、DITADoclet を実行して DITA Java API リファレンス・ファイルを生成する方法、そして DITA Java API ソリューションによってリファレンスを文書化する方法を学んでください。

Mariana Alupului, Information Developer, IBM

Mariana AlupuluiMariana Alupului は、IBM Rational Software の情報開発者です。ソフトウェア・プログラミング環境における Java、VB、C++ の API 文書化プロジェクトのリーダーを務める傍ら、IBM Corporation のメンバーとして、言語に適合したAPI ライブラリーのリファレンス・マニュアルを作成するための DITA (Darwin Information Typing Architecture) XML 特殊化機能、そしてJava DITA API 特殊化を完成する DITADoclet を開発しました。彼女は企業 Java API ガイドライン・ワークグループのリーダーであり、企業 ID Technical Writers Council のメンバーです。STC (Society for Technical Communication) の「Beyond the Bleeding Edge」セッション (2005年)、そして DITA/TechComm Conference (2008 年) で、Java DITA API ソリューションを発表しました。



2014年 5月 08日 (初版 2009年 2月 03日)

2009年 12月 11日の改訂内容: 「この記事の目的」と「org.dita.dost プラグインをインストールする」に、「ダウンロード」へのリンクを追加しました。

2014年 3月 07日の改訂内容: 「参考文献」から、リンク先が削除された「IBM XML 認定」の項目を削除しました。

2014年 3月 17日の改訂内容: 「参考文献」から、リンク先が削除された「The DITA FAQ」の項目を削除しました。

この記事の目的

この記事で学ぶのは、DITADoclet、DITA Java API 特殊化、そして Eclipse IDE を使用して、さまざまなフォーマットで簡単に配布できる Java API リファレンス・マニュアルを作成する方法です。DITADoclet は、DITA Java API ファイルを生成し、自動的に Java API リファレンス・マニュアル用の DITAMAP および MAPLIST ファイル (DITA Java API 特殊化) を作成し、Java ソース・コードから開発者のコメントを抽出し、その情報を生成済みの DITA Java API ファイルにマイグレーションします。

よく使われる頭字語

  • API: Application Programming Interface
  • CHM: Compiled Windows® HTML Help
  • CSS: Cascading Stylesheets
  • DITA: Darwin Information Typing Architecture
  • DTD: Document Type Definition
  • HTML: Hypertext Markup Language
  • IDE: Integrated Development Environment
  • J2EE: Java 2 Platform, Enterprise Edition
  • JDK: Java Development Kit
  • JSP: Java Server Pages
  • URI: Uniform Resource Identifier
  • XHTML: Extensible Hypertext Markup Language
  • XML: Extensible Markup Language
  • XSLT: Extensible Stylesheet Language Transformation

Java ソース・コードから Java API リファレンス・マニュアルを生成するには、一般に Sun Microsystems の Javadoc ツールが使用されています。Javadoc ツールは Java API リファレンス・マニュアルの基本構造を生成しますが、大抵は文書化が不完全で、開発者のコメントのみに限定されたマニュアルになります。他方で、開発チームを改変する際には、API のライターとエディターをまとめて Java API リファレンスの文書化プロセスから除外する傾向があるようです。開発者たちにはコメントが不完全なままの Java ソース・コード・ファイルを管理する時間しかありません。こうした状況は、API ライターや高品質の API ドキュメントを制作することに関心を持つ人々にとって明らかに深刻な問題を呈しています。

API ライターは、完全に文書化された Java API を生成するために、DITADoclet と DITA Java API ソリューションが提供するツールを利用することができます。完全に文書化された API はいくつかの目的を果たしますが、なかでも最も重要なのは API を利用する人が API 関数を十分に理解し、検索し、参照できるようにすることです。ソフトウェアのユーザーが API の機能をフル活用するためには、API の正確かつ完全な文書化が欠かせません。

DITADoclet がどのように機能するかを理解してもらうため、この記事では Javadoc 標準ドックレット・ソリューションが使用する重要な概念をいくつか紹介します。DITADoclet による自動抽出を効果的に機能させるには、Java ソース・コードが Javadoc の厳格なガイドラインに従って文書化されていなければなりません。そうでないと、DITADoclet でコメントを抽出する際に、コメントが適切に処理されなかったり、最終的な API ドキュメントが不完全なものになってしまったりする可能性があります。

この記事の内容は以下のとおりです。

  • 前提条件
  • DITA Java API 特殊化の概要
  • DITADoclet のインストール
  • Eclipse Javadoc Generation ウィザード (標準ドックレット) を使って Javadoc 文書を作成する方法
  • 以下の手段を使って Java API リファレンス・マニュアルを作成する方法
    • Eclipse Javadoc Generation ウィザード (DITADoclet)
    • コマンド・プロンプト
  • DITADoclet の利点と欠点

DITADoclet をダウンロードするには、「ダウンロード」を参照してください。

DITA についての詳細、DITA ファイルの作成または編集方法、そして DITA をサポートするその他の XML エディターを調べるには、http://dita.xml.org の Web サイトを参照してください。タグ付けの際のエラーを避けるため、XML エディターを使用することを是非ともお薦めします。XML エディターには、Arbortext Editor™、<oXygen/>® XML Editor、XMLBuddy™ (Eclipse プラグイン)、Altova® XMLSpy®、OpenOffice.org などをはじめ、さまざまな種類が揃っています。また、コンテンツ・パブリッシング・システムとして Arbortext Editor を使用することをお薦めします。

対象読者

この記事の対象読者は API ライターです。Java ソフトウェア、Java API リファレンス・マニュアルの構造、Javadoc の生成についての十分な知識があり、API ライターとして Java API リファレンス・マニュアルを改善する方法を詳しく知りたいという読者を対象としています。

API ライターは、開発者が作成したコードを理解して、API ドキュメントとして公開する関連情報を抽出できなければなりません。DITADoclet を使用して DITA Java API ドキュメントを生成するという目標を達成できるかどうかは、Java ソース・コードをどれだけ理解しているかにかかっています。

前提条件

この記事では、Java ソース・コードから直接 Java API リファレンス DITA ファイルを生成するために必要な前提条件と、生成したファイルを Eclipse を使用して変換する方法を説明します。DITADoclet と DITA Java API 特殊化を使用するには、以下の概念を十分に理解していることが前提条件となります。

  • Java API リファレンスの文書化プロセスと Javadoc の生成
  • Eclipse
    • Java IDE およびエディターのパースペクティブとビュー
    • Eclipse の基本概念 (アーキテクチャー、プラグイン、ワークベンチへの接続など)
    • 必要最小限のプラグインの要素 (プロジェクト、Eclipse ビュー、エディターなど)
    • Eclipse Java IDE で単純なプラグインを作成、インストール、実行する方法
  • 基本とする IDE は Eclipse ですが、Eclipse には多数の Java 関連のプラグインがあり、Eclipse をベースに構築された商用 IDE もいくつかあります。
    • Rational® Software Architect。アプリケーションの設計、構成、テスト、プロファイル作成、デプロイメントを視覚的かつ包括的に行える統合開発環境です。
    • Rational Application Developer for WebSphere Software。Eclipse を視覚的開発機能で拡張します。
    • IBM® WebSphere® Studio。よく使用されている強力な IBM の J2EE IDE です。
    • IBM WebSphere Studio Site Developer for Java。Windows および Linux 対応の Java IDE です。
    • Sun Java Studio Creator
    • JBuilder

上記のプラグインをダウンロードするには、「参考文献」を参照してください。DITADoclet を実行するには、Eclipse ビルド・ツールを使用するか、あるいはコマンド・プロンプト・ラインから直接実行することをお薦めします。

DITA Java API 特殊化の概要

DITA について十分な知識がある場合には、このセクションを飛ばして「DITADoclet のインストール」のセクションに進んでください。

DITA は技術文書の一貫性、完全性、そして正確性を確実にするアーキテクチャーですが、DITA API 特殊化とは、Java API ドキュメント・ファイルを生成するための DITA トピック型を 1 つにまとめたパッケージのことです。Java ソース・コードから直接 DITA ファイルを生成するのは DITADoclet です。DITADoclet はコマンド・プロンプトから実行することも、Eclipse を使って実行することもできます。

DITA (Darwin Information Typing Architecture)

ウィキペディアの説明による DITA の歴史概略

  • 2001年3月: IBM が DITA を導入
  • 2002年5月: トピック特殊化にドメイン特殊化を追加
  • 2004年4月: OASIS DITA 技術委員会の結成
  • 2005年2月: SourceForge が DITA Open Toolkit のサポートを開始
  • 2005年6月: OASIS 標準として DITA v1.0 を承認
  • 2005年8月: DITA Open Toolkit v1.1 のリリース
  • 2006年3月: OASIS が DITA.XML.org を発足
  • 2007年8月: ブックマップ特殊化を含め、DITA V1.1 が OASIS により承認

DITA はオープンな OASIS 標準で、技術情報の作成、生成、配布を目的とした XML ベースのアーキテクチャーです。DITA ファイルは任意のテキスト・エディターで編集できますが、XML エディターを使用すれば、DITA DTD およびスキーマに準拠した上でタグの挿入、変更を簡単に行えます。タグ付けの際のエラーをなくすため、XML エディターを使用することを是非ともお薦めします。XML エディターとしては、Arbortext Editor、oXygen、XML Buddy (Eclipse プラグイン)、Altova XML Spy などを使用することができます。

DITA についての詳細、DITA ファイルを作成または編集する方法、そして DITA をサポートするその他の XML エディターを調べるには、「参考文献」に記載されている DITA コミュニティーへのリンクを参照してください。

DITA Open Platform は無料のソフトウェアで、Free Software Foundation が発行する GNU General Public License の条件のもと、再配布および変更することができます。DITA Open Platform は役に立つであろうという期待のもとで配布されていますが、製品の保証はありません。詳細は「参考文献」を参照してください。

DITA API 特殊化

DITA API 特殊化のドキュメントでは、汎用プログラミング言語 (すべてのプログラム言語) そして Java プログラミング言語に対応した DTD 要素による XML ベースの DITA アーキテクチャーについて説明しています。DITA API 特殊化に組み込まれるのは、汎用 API リファレンスおよび Java API リファレンスを文書化するためのトピック型と要素です。それぞれの言語に固有の DITA API 特殊化は、モジュールで構成されます。モジュールとは、特定のタスク (API パッケージやクラスの記述など) を目的に設計されたトピック型のことで、それぞれのモジュールごとにプログラミング言語の特定部分を記述する適切な XML 要素が組み込まれます。

この記事では、DITADoclet を実行して DITA Java API リファレンス・ファイルを生成する方法、そして DITA Java API ソリューションによってリファレンスを文書化する方法を説明します。

DITA 汎用 API 特殊化を使用することによって、Java、Visual Basic、その他のプログラミング言語の API リファレンス・マニュアルを作成および生成することができます。

DITADoclet のインストール

DITADoclet を実行するには、JDK (Java Development Kit) および Eclipse をインストールする必要があります。

JDK をインストールする

  • システム・パスに Java バイナリーが含まれていなかったり、JAVA_HOME 環境変数が定義されていなかったりすると、DITADoclet の実行に失敗するかもしれません。DITADoclet を実行するためには、JDK が不可欠です。
  • 推奨される JDK は、Java 5 JDK です。一般に、Java のインストール・パスは、C:\Program Files\Java\jdk1.5.0_06\ のようになります。システムにインストールされている Java のバージョンを判断するには、コマンド・プロンプトで Java -version と入力してください。
  • 最新の Java バージョンでない場合は、Sun ダウンロード・サイト (「参考文献」にリンクを記載) から JDK、J2RE、または JRE をダウンロードしてください。

Eclipse Classic をインストールする

  • Windows 対応の Eclipse Classic、または IBM Rational Developer あるいは Rational Software Architect Standard Edition をダウンロードして、zip ファイルを任意のディレクトリー (例えば、Windows の C:\eclipse\) に解凍します。それぞれのリンクについては、「参考文献」を参照してください。
  • ここで最も重要な点として、Windows プラットフォームでは必ず Eclipse のインストール・パスにスペースが含まれていないようにしてください。各種ツールのインストールについての詳細は、公式 Eclipse マニュアルを参照してください。Javadoc ツールがインストールされているかどうかを確認するには、コマンド・プロンプトを開いて Javadoc と入力します。エラーが返って来る場合は、Javadoc (jdk1.5.0_xx) がインストールされていませんので、Sun のサイトから jdk1.5.0_xx をダウンロードして Windows パスにディレクトリー C:\Program Files\Java\jdk1.5.0_xx を追加します。

DITADoclet をインストールする

  • DITADoclet Tool の zip ファイルをダウンロードして、任意のディレクトリー (例えば、Windows の C:\DITA\) に解凍します。これによって、\DITA ディレクトリーには DITADoclet.exe と ReadeMe.txt、そしてサブディレクトリー \demo が作成されます。
    • \demo サブディレクトリーには、\src リソース・ディレクトリー、オプション、パッケージが含まれます。
    • \src リソース・ディレクトリーには、サンプルとして使用できる Java ソース・ファイルがあります。これらの Java ソース・ファイル (DITA-OT1.4_src.zip) は、SourceForge Web サイトから直接ダウンロードすることもできます。

org.dita.dost プラグインをインストールする

  1. お使いの Eclipse で使用しているワークスペース・ディレクトリーを見つけます。このディレクトリーは通常、Eclipse をインストールしたディレクトリーに含まれる \workspace という名前のサブディレクトリーです。ショートカットまたはスクリプトを使用して Eclipse を起動している場合には、そのショートカットまたはスクリプトの現行作業ディレクトリーの下にある \workspace サブディレクトリー (例えば、C:\eclipse\workspace) となります。
  2. org.dita.dost zip ファイルをダウンロードして (「ダウンロード」を参照)、Eclipse のワークスペース・ディレクトリー内に解凍します。その結果、org.dita.dost という名前の Java プロジェクトが作成されます。
  3. org.dita.dost という Java プロジェクトを Eclipse ワークスペースにインポートします。

オプションのインストール・ステップ

以降のステップはオプションなので、これらのステップについては詳しく説明しませんが、DITA API ファイルを完成してテストするには .dita ファイルを .xhtml ファイルに変換しなければなりません。DITA Open Toolkit を使用すれば、DITA Java API ファイルを変換したり、DITA API ファイルから出力を生成したりすることができます。変換機能を有効にするには、apiref プラグインと javaapiref プラグインの両方をインストールする必要があります。

  1. オプション: DITA Open Toolkit をダウンロードしてインストールします。
  2. オプション: DITA Java API 特殊化 (apiref-0.8 および avaapiref-0.8) をダウンロードしてインストールします。

標準ドックレット (Eclipse Javadoc Generation ウィザード) を使って Javadoc 文書を作成する方法

DITADoclet の基本的な役割と構造を理解するには、Javadoc ツールについて簡単に復習しておくと役に立ちます。Javadoc ツールのオプションについては、JDK マニュアルで詳しく説明しています。Javadoc ツールを使い慣れていれば、DITADoclet を使用するのも簡単です。Javadoc ツール (または DITADoclet) はソース・ファイルを解析して Javadoc コメントを抽出し、マニュアル・データの内部コレクションを作成します。

以降の手順では、Eclipse 開発環境で標準 Javadoc ドックレットを使って Javadoc を作成する方法を説明します。

  1. このプロセスの説明には、Eclipse プラグインの 1 つ、org.dita.dost を例に用います。
  2. Eclipse の左ペインの「パッケージ・エクスプローラー (Package Explorer)」ビューで、Javadoc を生成する対象の Java ソース・コードを選択します (この例では、Eclipse プラグインの 1 つとして org.dita.dost を使用します)。org.dita.dost を右クリックして、ドロップダウン・リストから「エクスポート (Export)」を選択します。すると「エクスポート (Export)」ウィンドウが開きます。
  3. Java 配下にある Javadoc を選択してから「次へ (Next)」をクリックします。すると、「Javadoc の生成 (Generate Javadoc)」ウィンドウが開きます。
  4. Javadoc コマンド (Javadoc command)」の構成ウィンドウで Javadoc.exe を指定します。通常、Javadoc.exe のパスは C:\Program Files\Java\jdk1.5.0_06\bin\Javadoc.exe のようになっているはずです (図 1 を参照)。
    図 1. javadoc.exe パスの指定
    javadoc.exe パスの指定
  5. 「Javadoc の生成 (Generate Javadoc)」ウィンドウで、Javadoc ファイルにエクスポートするパッケージを選択します。このリストは、Eclipse ワークベンチを選択すると初期化されます。Javadoc ツールの実行中は一度に 1 つのプロジェクトのクラスパスしか使えないので、選択できるプロジェクトは 1 つだけです。
  6. パッケージのメンバーをフィルタリングするには、可視性を選択します (通常は「public (Public)」を選択します)。
    • 選択肢には、-package、-private、-protected、-public の 4 つがあります (図 2 を参照)。
      図 2. メンバーの可視性の選択
      メンバーの可視性の選択
    • 表 1 に、目的の可視性に応じてどのメンバーを選択するかを説明します。メンバー数は、-public を選択すると最小になり、-private を選択すると最大になります。
表 1. メンバーの可視性
オプション文書化するクラス
-publicpublic...
-protectedpublicprotected..
-packagepublicprotected(package).
-privatepublicprotected(package)private
  1. 標準ドックレット (デフォルト) で Javadoc コマンドを起動するように、「標準ドックレットを使用 (Use Standard Doclet)」を選択します。
    • 「宛先 (Destination)」: 標準ドックレットが生成した文書を書き込む宛先を選択します。この宛先は標準ドックレット固有の引数なので、カスタム・ドックレットの使用時には有効になりません。標準ドックレットの書き込み先には、例えばワークスペースのサブディレクトリー、\workspace\doc.dita.dost\output を指定することができます。
  2. 次へ (Next)」をクリックして、追加の Javadoc 生成オプションを指定します。
  3. 「文書タイトル (Document title)」オプションを選択して、index.html ファイルの先頭近くに配置するタイトルを指定します。「文書タイトル (Document title)」オプションが選択されなかったり、タイトルが指定されなかったりした場合は、Javadoc ツールは概要ページに文書タイトルを追加しません。
    図 3. 概要ページのロケーションの指定
    概要ページのロケーションの指定
  4. 次へ (Next)」をクリックして、追加の Javadoc の生成オプションを指定します。
  5. さらに次の画面へ進み、「概要 (Overview)」が選択されている場合は解除します (図 3 を参照)。このオプションが選択されていると、Javadoc は指定されたソース・ファイルから概要文書に使用するテキストを取得し、概要ページ (index.html) にそのテキストを配置することになります。
    図 4. 文書タイトルの指定
    図 4. 文書タイトルの指定

Javadoc ツールで処理するには、他にも Javadoc のオプションを追加しなければならない場合が考えられます。これらのオプションは VM のオプション、つまり Javadoc ツールによる処理を制御するために使用するシステム・オプションの形をとります。例えば、-Xmx512m を設定すると、ヒープには 512 MB が割り当てられます。

  1. JavaDoc プロセスを迅速化するために Javadoc からの情報メッセージが表示されないようにするには、Javadoc コメントの作成を支援するオプションとして -quiet オプションを使用してください (ヒント: 選択できるもう一方のオプションは -verbose です。-verbose オプションを選択すると、コンパイラーと Javadoc は、どのソース・ファイルがコンパイル中であるか、そしてどのクラス・ファイルが文書化されているかをメッセージで出力します)。
    図 5. VM のオプションおよび Javadoc のオプションの指定
    VM のオプションおよび Javadoc のオプションの指定
  2. ドックレットは、プラグイン文書ディレクトリーである \workspace\org.dita.dost\output\ ワークスペース・サブディレクトリーに、プラグイン文書の出力 HTML ファイルを生成します。
  3. 終了 (Finish)」をクリックして Javadoc 文書を生成します。コンソール・ビューに、JavaDoc 生成の進行状況が表示されます。

Javadoc は 2 つの例外を除き、すべての情報とテキストを Java ソース・ファイルから取得します。例外の 1 つは概要テキスト・ファイル、そしてもう 1 つは各パッケージのテキスト・ファイルです。この 2 つのファイルはどちらもオプションで、Javadoc はこの 2 つのオプションに対して、それぞれ index.html、package-summary.html を作成します。標準 Javadoc を使用する場合に生成される概要ファイルとパッケージ・ファイルは、何も情報が含まれない HTML ファイルです。パッケージ文書は、そのパッケージを使用する際に必要な情報を開発者に提供します。パッケージ情報は、パッケージの内容がどのように連動するかを理解する上で役立ちます。この情報には、コードやプロトタイプ、構造チャート図、デザイン・パターン、コーディング標準などが含まれている場合があります。索引ファイルをブラウザーで開くオプションを選択した場合には、Javadoc が生成されると Javadoc ページの index.html がデフォルトの Web ブラウザーに表示されます。

ここまでで Javadoc がどのように Java API リファレンス・ファイルを生成するかを振り返ったので、今度は DITADoclet によって Java API リファレンス・マニュアルの DITA ファイルを生成する方法が Javadoc での生成方法とどの程度似ているのかを調べてみましょう。次のセクションでは、Eclipse Javadoc Generation ウィザード (DITADoclet) を使用して Java API リファレンス・マニュアルを作成する方法を説明します。

DITADoclet (Eclipse Javadoc Generation ウィザード) を使って Java API リファレンス・マニュアルを作成する方法

DITADoclet はソース・ファイルを構文解析して Javadoc コメントを抽出し、Java API ソース・コード・ファイルから直接 DITA ファイルを作成します。この設計で目標とされているのは、API テクニカル・ライターがすでに持っている Eclipse Javadoc Generation ウィザードの知識を利用できるようにして、DITA 文書に固有のごくわずかな違いを学ぶだけで済むようにすることです。

  • DITADoclet が生成する文書の全体的構造は、標準ドックレットによって生成される文書の構造と同じです。
  • DITADoclet は標準ドックレットに用意されているオプションをすべてサポートしますが、考慮するオプションは -sourcepath、-d、-doctitle、-overview、および -public のみです。
  • DITADoclet ではさらに、サポートされる追加オプションとして -contributor、-provider、-debug、および -nocomment も使用することができます。
  • DITADoclet は標準ドックレットとは違って、タグレットを使用してカスタム・ブロック・タグを処理することはありません。

Eclipse 開発環境でカスタマイズされたドックレット、DITADoclet を Javadoc と併せて使用する場合の手順は以下のとおりです。

  1. Eclipse の左ペインで、Javadoc を作成する対象のソース・コード・プラグインとして org.dita.dost を選択します。
  2. 選択したプラグインを右クリックし、ドロップダウン・リストから「エクスポート (Export)」を選択します。すると「エクスポート (Export)」ウィンドウが開きます。
  3. Java 配下にある Javadoc を選択してから「次へ (Next)」をクリックします。すると、「Javadoc の生成 (Generate Javadoc)」ウィンドウが開きます。
    図 6. 「Javadoc の生成 (Generate Javadoc)」ウィンドウが開いた状態の「Javadoc 生成 (Javadoc Generation)」ウィザード (標準ドックレット)
    「Javadoc の生成 (Generate Javadoc)」ウィンドウが開いた状態の「Javadoc 生成 (Javadoc Generation)」ウィザード (標準ドックレット)
  4. Javadoc コマンド (Javadoc command)」フィールドに、DITADoclet.exe のパスを指定します。この実行可能ファイルは、DITADoclet をインストールしたときに、C:\DITA\DITADoclet.exe にインストールされているはずです。
  5. Javadoc の生成 (Generate Javadoc)」ウィンドウで、Javadoc ファイルにエクスポートするパッケージを選択します。このリストは、Eclipse ワークベンチによって初期化されます。Javadoc ツールの実行中は一度に 1 つのプロジェクトのクラスパスしか使えないので、選択できるプロジェクトは 1 つだけです。サンプル・プロジェクトの org.dida.dost を選択してください。
  6. このバージョンの DITA Java API 特殊化がサポートするのは Java 公開要素のみなので、可視性が「public (Public)」のメンバーを作成するように選択します。
  7. 標準ドックレット (デフォルト) で Javadoc コマンドを起動するように、「標準ドックレットを使用 (Use Standard Doclet)」を選択します。
  8. 標準ドックレットが生成する文書の書き込み先を指定します (書き込み先は標準ドックレットに固有の引数なので、カスタム・ドックレットを使用する際には有効になりません)。標準ドックレットによる書き込み先には、例えばワークスペースのサブディレクトリー ..\workspace\doc.dita.dost\topics を指定することができます。
  9. 次へ (Next)」をクリックして「基本オプション (Basic Options)」を表示します。
    図 7. 「Javadoc 生成 (Javadoc Generation)」ウィザード (標準ドックレット) – Javadoc の「基本オプション (Basic Options)」の選択
    「Javadoc 生成 (Javadoc Generation)」ウィザード (標準ドックレット) – Javadoc の「基本オプション (Basic Options)」の選択
  10. 文書タイトル (Document title)」フィールドに、概要ファイルの先頭近くに配置するタイトルを指定します。文書タイトルを省略すると、DITADoclet がデフォルトのタイトル、Building DITA output を追加します。
  11. Javadoc の基本オプションのチェック・ボックスは、図 7 のようにすべて選択解除します。以下に、選択可能なオプションと、DITADoclet がこれらのオプションをどのように処理するかを説明します。
    • 使用ページの生成 (Generate use page): DITADoclet が Use ページを作成しないようにするには、このオプションを選択します。
    • 階層ツリーの生成 (Generate hierarchy tree): このフラグ・オプションの入力状態とは関係なく、DITADoclet は自動的に階層ツリー・ページを作成します。
    • ナビゲーター・バーの生成 (Generate navigation bar): このフラグ・オプションの入力状態とは関係なく、DITADoclet は自動的にすべてのページにナビゲーション・バーを作成します。
    • 索引の生成 (Generate index): このフラグ・オプションの入力状態とは関係なく、DITADoclet は自動的に Index ページを作成します。
    • 索引を文字ごとに分離 (Separate index per letter): DITADoclet が文字ページごとに個別に索引を作成しないようにするには、このオプションを選択します。
  12. これらのタグの記述 (Document these tags)」オプションについても、図 7 のようにチェック・ボックスをすべて選択解除します。
    • @作成者 (@author): このフラグ・オプションの入力状態とは関係なく、DITADoclet は自動的に作成者をメタ・ページに追加します。
    • @バージョン (@version): このフラグ・オプションの入力状態とは関係なく、DITADoclet は自動的にバージョンを .dita ページに追加します。
    • @使用すべきではない (@deprecated): このフラグ・オプションの入力状態とは関係なく、DITADoclet は自動的に非推奨情報を .dita ページに追加します。
    • 使用すべきでないリスト (deprecated list): DITADoclet が使用すべきでないリストのページを作成しないようにするには、このオプションを選択します。
  13. DITADoclet ツールが考慮に入れるのは、「宛先 (Destination)」フィールドの値と「文書タイトル (Document title)」オプションのみであることを忘れないでください。この例では、「宛先 (Destination)」の値は ..\workspace\doc.dita.dost\topics に、「文書タイトル (Document title)」の値は DITA-OT に設定されています。「宛先 (Destination)」フィールドに値が指定されていなければ、DITADoclet ツールはすべての .dita ファイルをソース・コード・フォルダー (\src) 内に生成します。また、「文書タイトル (Document title)」フィールドに値が指定されていない場合には、DITADoclet ツールがデフォルトのタイトル、Building DITA output を追加します。
  14. 次へ (Next)」をクリックします。この時点ではまだ、overview.html ファイルを作成していないので、「概要 (Overview)」チェック・ボックスは選択しないでください (このツールを 2 回目に実行するときに、新しく生成した overview.html ファイルを \workspace\src フォルダーから選択することができます)。
    図 8. 概要ページのパスは指定しないこと
    概要ページのパスは指定しないこと
  15. 「追加の Javadoc オプション (Extra Javadoc options)」では、オプションを任意に指定することができます (空白の入ったパス名は、引用符で囲んでください)。
    図 9. 追加の Javadoc オプション (Extra Javadoc options)
    追加の Javadoc オプション (Extra Javadoc options)
    • -contributor は、作成者のテキストを生成された DITA に含めます。
    • -provider は、プラグイン・プロバイダー名の詳細を指定します。
    • -debug は、警告メッセージを Javadoc コンソールに表示します。
  16. -contributor および -provider オプションは、DITA が生成するすべてのファイルに、作成者の名前、提供者の名前、プロバイダーの名前、生成日などが含まれる prolog セクションを追加します。以下は、その一例です。
    • 作成者に設定された著者、<author type="creator">Lian, Li</author> は、ソース・コードの @author javadoc タグから取得されます。
    • 提供者に設定された著者、<author type="contributor">Mariana Alupului</author> は、-contributor Javadoc オプションから取得されます (図 9 を参照)。
    リスト 1. <prolog> の出力
    <prolog>
       <author type="creator">Lian, Li</author>
       <author type="contributor">Mariana Alupului</author>
       <source href="org/dita/dost/xxx.Java">org/dita/dost/test/xxx.Java</source>
       <publisher>IBM</publisher>
       <copyright type="primary">
         <copyryear year="2008"/>
         <copyrholder>IBM</copyrholder>
       </copyright>
       <critdates>
       <created date="Wed, 17-Dec-2008 12:20:16 EST"/>
       <revised modified="Fri, 19-Dec-2008 15:49:48 EST" status="new"/>
       </critdates>
    </prolog>
  17. 終了 (Finish)」をクリックして DITA API ドキュメントを生成します。

警告の追加表示

DITADoclet は、文書内にエラーや不足している情報があることを見つけるうえで役立つすべての警告を Eclipse コンソールに表示します (図 10 を参照)。これらの警告は、デフォルトでは出力されません。警告を要求するには、-debugオプションを使用します。

図 10. Javadoc コンソールに表示されたサンプル・メッセージおよび警告
Javadoc コンソールに表示されたサンプル・メッセージおよび警告

ログ・ファイルは、一定のサイズになった時点で自動的に保存されるように設定することができますが、この内容を出力するにはコンソールで Ctrl-Break をクリックします。この出力が特に役に立つのは、-debug オプションを実行する場合で、この出力から Eclipse システムでの文書生成中に何が起こっているのかを確認することができます。ログ・ファイルは、情報が不足しているソース・ファイルや、警告が発生したソース・ファイルなどを把握できるように、開発者に送信することもできます。


DITADoclet のナビゲーション・ファイル

DITADoclet はプラグインの出力 DITA (XML) ファイルを生成するだけでなく、org.dita.dost\topics\ フォルダーにナビゲーション・ファイルをいくつか生成します。DITADoclet が作成するナビゲーション・ファイルには以下のものがあります。

  • org.dita.dost.ditamap
  • org.dita.dost.doc.reltable.ditamap
  • org.dita.dost.doc.ditaval
  • org.dita.dost.doc.maplist

org.dita.dost.ditamap

ditamap ファイルは、Java API リファレンスの名前と、パッケージ (または一連のパッケージ) とそのコンポーネントを記述するために必要なすべての要素を提供します。

図 11. DITA 出力 – org.dita.dost.ditamap ファイル
DITA 出力 – org.dita.dost.ditamap ファイル

org.dita.dost.doc.reltable.ditamap

reltable ファイルは、内部クラスおよびインターフェースを管理する関係表を定義します。内部クラスまたはインターフェースがなければ、DITADoclet は reltable を作成しません。

org.dita.dost.doc.ditaval

ditaval DITA 要素のフィルタリングに使用できる属性は、対象読者、プラットフォーム、製品などのプロパティーです。これらの属性 (複数可) の値は、DITA ソース内の要素に指定します。これらのプロパティーを使用して、テキストのオン/オフを切り替えることができます。これはつまり、宣言したプロパティーに応じてテキストを非表示にしたり、表示したりできるということです。ファイルのなかで属性値を使用しないのであれば、ditaval ファイルから属性を完全に除去しても構いません。ファイルのなかで値を使用する一方、今すぐにフラグを設定する必要はないという場合には、ditaval ファイルでアクションを flag から include に変更してください (図 12 を参照)。

図 12. DITA 出力 – org.dita.dost.doc.ditaval ファイルでの Properties タブ
DITA 出力 – org.dita.dost.doc.ditaval ファイルでの Properties タブ

org.dita.dost.doc.maplist

maplist ファイルでは、ditamap と reltable.ditamap ファイルを組み込むことができます。マップ・リストはマスター・ファイルのような役割を果たし、マップのリストを呼び出します。それによって、これらのマップが DITA トピックを呼び出します。

図 13. DITA 出力 – org.dita.dost.doc.maplist ファイル
DITA 出力 – org.dita.dost.doc.maplist ファイル

階層ファイル

DITADoclet は以下の 3 つのファイルを生成します。それぞれ、クラス階層を記述するファイル、クラスとインターフェースのリストを記述するファイル、そしてクラス、インターフェース、コンストラクター、メソッド、フィールドの索引を記述するファイルです。

  • tree.dita
  • allnames.dita
  • allclasses.dita

Java API Reference ページには、上記のビューそれぞれへのリンクが含まれます。

図 14. Java API Reference ページ上の階層および索引ページへのリンク
Java API Reference ページ上の階層および索引ページへのリンク

以下に、この 3 つのファイルそれぞれに含まれる内容を説明します。

tree.dita

tree.dita ファイルに含まれる Class Hierarchy (クラス階層) ページ (図 15) には、(すべてのパッケージの) クラスとインターフェースのリストが記載されます。クラスのリストは、Java.lang.Object を先頭に、継承構造に従って編成されます。

図 15. tree.dita ファイル内の Class Hierarchy
tree.dita ファイル内の Class Hierarchy

allnames.dita

allnames.dita ファイルに含まれる Index (索引) (図 16) には、すべてのクラス、インターフェース、コンストラクター、メソッド、フィールドがアルファベット順にリストアップされます。

図 16. allnames.dita ファイル内の Index (索引)
allnames.dita ファイル内の Index (索引)

allclasses.dita

allclasses.dita ファイルに含まれる Class and Interface Index (クラスおよびインターフェースの索引) (図 17) には、すべてのクラスとインターフェースのアルファベット順のリストが含まれています。

図 17. allclasses.dita ファイル内の Class/Interface Index
allclasses.dita ファイル内の Class/Interface Index

tree.dita、allnames.dita、allclasses.dita ファイルは、いずれも編集する必要はありません。変換機能を実行したときにエラー、あるいは警告が発生した場合にのみ、編集してください。

DITA 出力の補助ファイル

javastyle.fos は DITADoclet によって作成される補助ファイルで、Epic エディターで使用することができます。このファイルはライターに、Java ソース・コードに欠けている情報があることを視覚的に表示し、その欠けている情報を DITA Java API ファイルまたは Java ソース・コード内に直接入力できる箇所を示します。

生成された DITA ファイルを Epic で編集する場合、DITADoclet (fos ファイル) が Java ソース・コードから直接生成した緑色に強調表示されたテキストを利用することができます。緑色で強調表示されるのは欠けているコメントで、文書化の方法として考えられる代案が示されます。図 18 は、DITADoclet で生成された後、Epic エディターで開いた状態の DITA ファイルです。

図 18. DITADoclet で生成された fos ファイルのサンプル出力
DITADoclet で生成された fos ファイルのサンプル出力

DITADoclet は最初に実行されたときに、overview.html ファイル (リスト 2) を作成してワークスペース・サブディレクトリーの /workspace/org.dita.dost/src に保存します。さらに overview-summary.dita ファイル (図 19) も作成し、このファイルは別のサブディレクトリー、/workspace/org.dita.dost/topics に保存します。

リスト 2. overview.html
<html>
 <head>
  <title>Building DITA output</title>
<heading  refname="" type="major" back-to-top="no">Headings</heading>
 </head>
 <body>
  Overview short description added in source code src\overview.html template.
  <h2>Overview Specification</h2>
  Overview specification added in source code src\overview.html template.
 </body>
</html>
図 19. ドラフト・コメントが含まれている summary.dita の概要
ドラフト・コメントが含まれている summary.dita の概要

DITADoclet を 2 回目に実行するときには、すでに概要 (overview.html) が生成されています。そのため今度は、DITADoclet に overview.html ファイルからこのページのテキストを取得するよう指定することができます。すると DITADoclet はすべての情報 (開発者のコメント) を overview-summary.dita ファイルにコピーします。

DITADoclet をもう一度実行すると、出力ファイルは図 20 のようになります。

図 20. ドラフト・コメントが含まれていない overview-summary.dita
ドラフト・コメントが含まれていない overview-summary.dita

overview.html ファイルを編集することも、overview-summary.dita ファイル内で直接編集することもできます。ファイルを文書化するときには、この情報が DITADoclet の再実行時に上書きされないようにしなければなりません。そこで、overview-summary.dita ファイルを右クリックし、「プロパティー」を選択して、「属性」の「読み取り専用」を指定します。

DITADoclet ツールの 1 回目の実行では、package.html ファイルと package-summary.dita ファイルが作成されます。ツールが package.html ファイルを作成するのは、このファイルが Java ソース・コードに含まれていない場合です。package-summary.dita ファイルを対象に生成されたテンプレートについては、図 21 でその一例を見てください (DITADoclet が package-summary.dita の情報を上書きしないように、package-summary.dita ファイルを右クリックして「プロパティー」を選択し、「属性」の「読み取り専用」を指定してください。これによって、ファイルの中身が変更されなくなります)。

図 21. DITADoclet ツールを 1 回目に実行した後の package-summary.dita
DITADoclet ツールを 1 回目に実行した後の package-summary.dita

DITADoclet ツールを 2 回目に実行するときには、package.html ファイルが Java ソース・コードに存在するため、ツールはこのファイルからすべての情報を取得して package-summary.dita ファイルにマイグレーションします。これで、これらのファイル内でパッケージの情報を完成することができます。図 22 は、その一例です。

図 22. DITADoclet ツールを 2 回目に実行した後の package-summary.dita
DITADoclet ツールを 2 回目に実行した後の package-summary.dita

この時点で、パッケージ (ツールの最初の実行時に生成される package.html ファイル) のテンプレートを選択すると、DITADoclet がこのページに対応する開発者のコメントを自動的に取得し、すべての情報をpackage-summary.dita ファイルにコピーすることになります。

文書化されたパッケージをブラウザーで表示した例が、図 23 です。

図 23. ブラウザーに表示された文書

[Short description]
The main package org.dita.dost.log contains the class DITAOTBuildLogger which is responsible to log messages both on the screen and into the log file.
Detailed description:
The messages on the screen present user with the status information, warning, error, and fatal error messages. The messages in the log file present user with more detailed information about the transformation process. By analyzing these messages, user can know what caused the problem and how to solve it.
The logging method is based on Ant's Logger & Listener interface. By default, this logging method is disabled, and all the messages occur on the screen just like previous releases.
Enhanced Ant command:
To start this new logging method, you need to follow the usage below:
  • At an Ant command prompt, specify the logger by appending -logger org.dita.dost.log.DITAOTBuildLogger in the command parameters, for example:
    ant sample.web -logger org.dita.dost.log.DITAOTBuildLogger
  • At a Java command prompt, the logger is specified internally, so you do not need to specify it again.
Important change and future updates:
DITA-OT 1.2 offers new error handling and logging system. If you invoke your transformation with the Java command line where new error handling and logging system is mandatory, you need to set the CLASSPATH Environment Variable for dost.jar. If you invoke your transformation with an ant script, you need to do one more step after the above setting. That is, add a parameter in your command to invoke an ant script. For example, use:
ant
-f ant\sample_xhtml.xml -logger org.dita.dost.log.DITAOTBuildLogger

instead of:
ant -f ant\sample_xhtml.xml

to start a transformation defined in ant script file ant\sample_xhtml.xml.

DITADoclet はすべての出力ファイルを、-d コマンド・オプションで指定されたルート出力ディレクトリーとそのサブディレクトリーに記録します。指定のルート出力ディレクトリーとすべてのサブディレクトリーは、DITADoclet によって自動的に作成されます。図 24 にディレクトリー構造、そして DITADoclet が作成したデフォルト・ファイルの名前を示します。これらのデフォルト・ファイルは、サンプル・パッケージ org.dita.dost を対象に生成されたディレクトリー構造の例を使用して作成されたものです。この図の左側に示されているのは Java ソース・ソースとそのコンポーネント・ファイルで、右側には、この Java ソース・コードのフォルダーから生成された DITA ファイルが示されています。

図 24. ディレクトリー構造とデフォルト・ファイルの名前
ディレクトリー構造とデフォルト・ファイルの名前

DITADoclet ツールは、1 回目の実行ですべての DITA ファイルを作成します。それ以降 DITADoclet ツールを実行すると、1 回目と同様にすべての DITA ファイルが作成され、#0.xxx.dita、#1.xxx.dita といった名前で保存されます。これらのファイルは、#63 まで作成されます。

このように異なるバージョンのファイルを維持しておくと、Java ソース・コードの Javadoc コメントを変更した後に行う文書のデバッグや検証プロセスの際に役立ちます。

DITADoclet とコマンド・プロンプト・ラインを使って Java API リファレンス・マニュアルを作成する方法

Javadoc がどのパラメーターを読み取って使用するのかを知っておくとともに、DITADoclet が読み取って使用するパラメーターを知っておくことが重要です。Javadoc -help を実行するとわかるように、Javadoc ツールのコマンド・ライン・オプションには 2 つのセットがあります。一方は汎用のセットで、任意のドックレットで使用できます。もう一方はオプションのセットで、これは標準ドックレットに固有のものです。後者のセットに含まれるオプションは、カスタム・ドックレットを使用するときには有効になりません。一方、カスタム・ドックレットでも固有のコマンド・プロンプト・ライン・オプションを定義することができます。この記事で詳しく説明しているのは DITADoclet に用意されているオプションだけです。Javadoc ツールのオプションについては JDK マニュアルで詳しく説明しています。

DITADoclet リリース 1.1.3 (「参考文献」にリンクを記載) では、代わりにコマンド・ライン・インターフェースも使用できるので、Eclipse をよく知らないユーザーでも、このツールキットを簡単に使用することができます。

サンプル org.dita.dost での Javadoc の実行手順

  1. Javadoc がパスに組み込まれていることを確認します。通常、Javadoc のパスは C:\Program Files\Java\jdk1.5.0_06\bin のようになります。
  2. @options オプションを使用して、オプションを別個のファイルに配置します (このオプションについて説明したドキュメントは、JDK に付属しています)。
  3. @packages オプションを使用して、パッケージの完全修飾名を別個のファイルに配置します。
  4. DITA ディレクトリー C:\DITA\ から、コマンド Javadoc @options @packages を実行します。
図 25. サンプルを使用したオプションおよびパッケージ
JavadocDITADoclet
C:\\DITA\>Javadoc @options @packages
C:\\DITA\>DITADoclet.exe @options @packages
オプション
-sourcepath demo/src
-d demo/output/org.dita.dost.doc
-overview demo/src/overview-summary.html
-doctitle 'Building DITA output'
-use
-tree
-navbar
-index
-noauthor
-version
-deprecated
-public
オプション
-sourcepath demo/src
-d demo/dita/org.dita.dost.doc
-overview demo/src/overview-summary.html
-doctitle 'Building DITA output'
-provider IBM -contributor "Mariana Alupului"
-public
パッケージ
org.dita.dost.index
org.dita.dost.invoker
org.dita.dost.log
org.dita.dost.module
org.dita.dost.pipeline
org.dita.dost.platform
org.dita.dost.reader
org.dita.dost.util
org.dita.dost.writer
org.dita.dost.exception
パッケージ
org.dita.dost.index
org.dita.dost.invoker
org.dita.dost.log
org.dita.dost.module
org.dita.dost.pipeline
org.dita.dost.platform
org.dita.dost.reader
org.dita.dost.util
org.dita.dost.writer
org.dita.dost.exception

サンプル org.dita.dost での DITADoclet の実行手順

コマンド・プロンプトから DITADoclet を実行する方法は、Javadoc を実行する場合と同じです。

  1. DITADoclet.exe をパスに追加する場合は、@packages オプションを使用してパッケージの完全修飾名を別個のファイルに配置し、@options オプションを使用してオプションを 1 つのファイルに配置すると、C:\DITA\ ディレクトリーからコマンド DITADoclet @options @packages を実行することで追加することができます。
  2. コマンド・ラインにコマンド全体を入力する場合には、以下のようなコマンドになります。

    DITADoclet.exe -sourcepath demo/src -d demo/output/org.dita.dost.doc -overview demo/src/overview-summary.html -doctitle 'Building DITA output' -provider IBM -contributor "Mariana Alupului" org.dita.dost.index org.dita.dost.invoker org.dita.dost.log org.dita.dost.module org.dita.dost.pipeline org.dita.dost.platform org.dita.dost.reader org.dita.dost.util org.dita.dost.writer org.dita.dost.exception org.dita.dost.pipeline org.dita.dost.platform org.dita.dost.reader org.dita.dost.util org.dita.dost.writer org.dita.dost.exception

それぞれのプロジェクトに DITADoclet を使用する方法

  • @options ファイルと @packages ファイルは、ワードパット・エディターで開いて編集することができます。
  • DITADoclet.exe @options @packages コマンドを実行します。

DITA-OT トランスフォーマーを実行して DITA から XHTML ファイルを生成する方法

この記事で紹介した DITADoclet を使うと、DITA ファイル、そしてドキュメント作成のために追加したいくつかの要素をベースに、Java API リファレンス・ヘルプ・マニュアルを生成することができます。DITADoclet では、Eclipse プラットフォームのドキュメントを作成し、さらにその文書を既存の Eclipse ヘルプ・システムの XML および HTML 出力形式で生成することも簡単にできます。いずれ、これ以外の出力形式も追加されることになるはずです。

DITA-OT トランスフォーマーには HTMLHelp (CHM) の生成機能が備わっています。図 26図 27 に、DITA-OT トランスフォーマーで生成したサンプル CHM ファイルの画面を示します。最初の例はドラフト・コメント付きの画面、2 番目の例はドラフト・コメントなしの画面です。

図 26. ドラフト・コメント付きの CHM
ドラフト・コメント付きの CHM
図 27. ドラフト・コメントなしの CHM
ドラフト・コメントなしの CHM

API ライターは、すべてのドラフト・コメントに対処しなければなりません (図 26 を参照)。すべてが文書化された Java API リファレンス・マニュアルには、緑色で強調表示されたドラフト・コメントが一切含まれていないはずです (図 27 を参照)。

API ライターは DITADoclet テスト・ソリューションを使用して、Java ソース・コードに不足している情報を特定できるだけでなく、ソース・コードをオンライン・ヘルプに提供する前にリファレンス・ファイルが完全に文書化されているかどうかをテストすることもできます。

Eclipse 環境では、DITA-OT トランスフォーマーを実行して DITA Java API ファイルから XHTML ファイルを生成することができます。図 28 に、このようにして生成されたファイルの一例を示します。

図 28. Eclipse オンライン・ヘルプ
Eclipse オンライン・ヘルプ

DITADoclet の利点

DITADoclet を使って DITA Java API ドキュメントを生成する上での利点には、以下のものがあります。

検索
メソッドとクラス/インターフェースを効率的な方法で取得できるようになります。Javadoc システムには、目次 (TOC) に対するこのような検索メカニズムはありません。
ナビゲーション
TOC ナビゲーションはJava ソース・コードから直接、自動的に生成されます。
索引
索引はキーワード検索を補完します。索引は API ライターが作成するため、貴重な追加情報を与えることができます。
索引はすべてのパッケージ、クラス、インターフェース、メソッドおよびフィールドをリストアップし、これらの項目をコンテキストに当てはめて (例えば、メソッドまたはフィールドに含まれるクラスを指定するなど)、エントリーを記述するドキュメントにリンクします。
リンク
DITA は、DITA を使わなければ見つけるのが困難なリンク切れを明らかにします。このデモ・プロジェクト (org.dita.dost) の場合、DITA が自動的に 3567 のローカル・リンクが設定された 108 のトピックをチェックします。

DITADoclet の欠点

このツールを使って DITA Java API ファイルを作成する場合、ソース・ファイルにはバージョン 1.4 の Java ファイルしか使用することができません。アノテーション、列挙、Generics なども含めた Java バージョン 1.5 および 1.6 は、DITA API 特殊化と DITADoclet の次のバージョンでサポートされる予定です。

特殊化の貢献者

ここで、DITA API 特殊化の開発に貢献してくださった方々に心から感謝の意を表し、主な方々を紹介したいと思います。

  • 型アーキテクト: Michael Priestley 氏 (STSM (Senior Technical Staff Member) Lead IBM DITA Architect)
  • 文書構造および処理: Erik Hennum 氏 (XML、DITA、XSLT、Perl、Web 技術 (JSP、Java Servlet、JavaScript、CSS)、ユーザー支援 (Eclipse、JavaHelp))
  • サブジェクト・マター・エキスパート: Mariana Alupului 氏
  • 情報開発者: Mariana Alupului 氏、Rob Pierce 氏、Nigel Hopper 氏、Dennis Grace 氏、Ian Hartshorn 氏
  • 情報アーキテクト: Erik Hennum 氏
  • オーサリング・ツール (情報開発ワークベンチ): Robert D Anderson 氏
  • 変換ツール開発およびグローバル化サポート: David Walters 氏
  • Java API パイロット・プロジェクト・リーダー: Mariana Alupului 氏
  • 編集者: Michelle C Carey 氏
  • IDWBWIN ヘルプおよびガイドライン資料: Mariana Alupului 氏
  • ガイドラインおよび標準 (出力のスタイル・ガイドライン): Michelle C Carey 氏

ダウンロード

内容ファイル名サイズ
DITADoclet and DemoDITADoclet.zip3004KB
Eclipse Pluginorg.dita.dost.zip626KB

参考文献

学ぶために

  • DITA に関する以下の developerWorks 記事を読んでください。
  • Eclipse プラットフォーム: Eclipse のニュース、プラグイン、コミュニティーについて最新情報を入手してください。さらに、以下の記事で Eclipse の詳細を調べてください。
    • Eclipse のヘルプ・システムを使ってプロジェクトを文書化する」(Arthur Barr 著、developerWorks、2004年1月): 使いやすく、検索機能を備えたヘルプ・マニュアルを作成してください。
    • 連載「Eclipse V3.4 をマスターする」(Prashant Deva 著、developerWorks、2008年10月から 11月、2009年1月): この 3 回の連載記事から、Eclipse IDE ワークベンチの詳細、JDT、そして JDT テキスト・エディターを使用する際のヒントと要領を学んでください。Eclipse の初心者でも、連載を読み終える頃には上級ユーザーと肩を並べるほどになっているはずです。
  • DITA Open Toolkit: OASIS DITA Technical Committee による DITA DTD およびスキーマ仕様の実装について詳しく学んでください。このツールキットは DITA コンテンツ (マップとトピック) を配布可能な形式に変換します。
  • XML Technical library: 広範な技術に関する記事とヒント、チュートリアル、標準、そして IBM Redbooks については、developerWorks XML ゾーンを参照してください。
  • developerWorks technical events and webcasts: これらのセッションで最新情報を入手してください。
  • developerWorks podcasts: ソフトウェア開発者向けの興味深いインタービューとディスカッションを聞いてください。

製品や技術を入手するために

  • Rational Software Architect: アプリケーションの設計、構成、テスト、プロファイル作成、デプロイメントを視覚的かつ包括的に行える統合開発環境をお試しください。
  • Rational Application Developer for WebSphere Software: 視覚的開発機能で Eclipse を拡張できます。
  • IBM WebSphere Studio: 強力でよく使用されている IBM の J2EE IDE を調べてみてください。
  • IBM WebSphere Studio Site Developer for Java: Windows および Linux 対応の Java IDE です。
  • DITA コミュニティーのサイト: DITA の詳細、DITA ファイルの作成または編集方法、そして DITA をサポートする各種の XML エディターを調べてください。
  • Java EE 5 JDK: この開発キットをダウンロードして、アプリケーション開発を効率化し、より単純なプログラミング・モデルで生産性を最大限に伸ばしてください。
  • Windows 対応 Eclipse Classic: 開発に必要不可欠なツールをダウンロードしてください。
  • IBM Rational Developer: 従来の IBM i アプリケーション開発に対応する完全な開発環境をダウンロードして試してみてください。
  • DITA Toolkit ソース・ファイル (DITA-OT1.4_src.zip): DITA Toolkit のソース・ファイルは、SourceForge Web サイトから直接ダウンロードできます。
  • DITA Open Toolkit: このツールキットをダウンロードして、DITA コンテンツ (マップとトピック) を配布可能な形式に変換してください。
  • GNU General Public License: Free Software Foundation が発行する GNU General Public License の条件の下、無料の DITA Open Platform ソフトウェアを再配布、変更できます。
  • DITA Java API 特殊化 apiref-0.8: このプラグインをダウンロードして使用してください。
  • DITA Java API 特殊化 Javaapiref-0.8: このプラグインをダウンロードして使用してください。
  • IBM 製品評価用試用版ソフトウェア: developerWorks から直接ダウンロードできる試用版ソフトウェアで、次のプロジェクトを構築してください。DB2®、Lotus®、Rational®、Tivoli®、および WebSphere® によるアプリケーション開発ツールおよびミドルウェア製品の試用版が揃っています。

議論するために

コメント

developerWorks: サイン・イン

必須フィールドは(*)で示されます。


IBM ID が必要ですか?
IBM IDをお忘れですか?


パスワードをお忘れですか?
パスワードの変更

「送信する」をクリックすることにより、お客様は developerWorks のご使用条件に同意したことになります。 ご使用条件を読む

 


お客様が developerWorks に初めてサインインすると、お客様のプロフィールが作成されます。会社名を非表示とする選択を行わない限り、プロフィール内の情報(名前、国/地域や会社名)は公開され、投稿するコンテンツと一緒に表示されますが、いつでもこれらの情報を更新できます。

送信されたすべての情報は安全です。

ディスプレイ・ネームを選択してください



developerWorks に初めてサインインするとプロフィールが作成されますので、その際にディスプレイ・ネームを選択する必要があります。ディスプレイ・ネームは、お客様が developerWorks に投稿するコンテンツと一緒に表示されます。

ディスプレイ・ネームは、3文字から31文字の範囲で指定し、かつ developerWorks コミュニティーでユニークである必要があります。また、プライバシー上の理由でお客様の電子メール・アドレスは使用しないでください。

必須フィールドは(*)で示されます。

3文字から31文字の範囲で指定し

「送信する」をクリックすることにより、お客様は developerWorks のご使用条件に同意したことになります。 ご使用条件を読む

 


送信されたすべての情報は安全です。


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=60
Zone=XML, Java technology, Rational, WebSphere
ArticleID=374103
ArticleTitle=DITADoclet と DITA API 特殊化を利用して DITA Java API リファレンス・マニュアルを生成する
publish-date=05082014