リソースのドキュメンテーション

リソースの表示に加え、ビルドするアプリケーションをドキュメント化しなければならない場合があります。 WebSphere® Integration Developer は、 ご使用のモジュール、メディエーション・モジュール、およびライブラリーにリソースのドキュメンテーションを生成するためのツールを提供します。

ドキュメンテーションの生成はウィザードを呼び出すことによって開始します。 1 つ以上のモジュールおよびライブラリーから複数のリソースを選択することによって、 ドキュメンテーションの内容をカスタマイズできます。 これで、すべての情報が 1 つのレポート (PDF ファイル) に書き込まれるようにすることができます。 出力用のレイアウトおよびフォントの指定も可能です。 ドキュメンテーションを生成する方法についての詳しい説明は、関連タスクを参照してください。

リソース・ドキュメンテーション

ドキュメンテーション生成プログラムは、 リソースについて以下の情報を作成します。

他のリソースは、ドキュメンテーション生成プログラムによって文書化されることはありません。

参照されるファイル

ドキュメンテーション生成プログラムは、 選択されたリソースおよび それらのリソースが参照するリソースのドキュメンテーションも作成できます。 例えば、「ドキュメンテーションの生成」ウィザードで、 ビジネス・プロセスと「参照ファイルの組み込み」オプションを選択できます。 この結果、生成された PDF レポートには、 プロセスが参照するリソース (プロセスのアクティビティーによって呼び出されるインターフェースなど) の情報も含まれます。

ドキュメンテーション構造

生成された PDF レポートの構成は次のとおりです。

  • タイトル・ページ

    レポートのタイトル、作成者名、およびレポートの日付が示されます。

  • 目次

    レポート中のセクションとページ番号がリストされます。

  • リソースのドキュメンテーション・セクション

    リソースのプロパティーをリストします。 モジュールとライブラリーを除き、 すべてのリソースには「エディター」ビューで開かれるリソースのピクチャーもあります。

  • 相互参照

    文書化された各リソースについて、 文書化されたリソースをどのリソースが使用するか (プロバイダー・リスト)、 およびどこで使用されるか (受信側リスト) をリストします。

  • 付録: ドキュメンテーション生成設定

    「ドキュメンテーションの生成」ウィザードで指定され、 PDF レポートに使用されたドキュメンテーション生成の設定をリストします。

ドキュメンテーション・レイアウトおよびスタイル

生成された PDF レポートのレイアウトとスタイルは、 「ドキュメンテーションの生成」ウィザードを使用してカスタマイズできます。 レイアウトとスタイルの設定を変更した場合、その変更は保管され、再度変更されるまで、 それ以降のすべてのドキュメンテーション生成で使用されます。

以下のレイアウト設定を変更することができます。

  • 用紙サイズ

    生成されるドキュメンテーションの用紙サイズを定義します。

    デフォルト値: レター

  • 目次レベル

    レポートの目次にリストするトピックの最大レベルを定義します。

    デフォルト値: 7

  • フォント
    出力用のフォント・ファミリー、フォント・サイズ、およびフォント・スタイルを定義します。 デフォルトのフォント設定は以下のとおりです。
    • プレーン・テキスト

      • さまざまな成果物の説明およびドキュメンテーションに使用されます。 プレーン・テキストのフォント・ファミリーはタイトル・ページ、ヘッダー、およびフッターにも使用されます。
      • デフォルト・フォント・ファミリー: Helvetica
      • デフォルト・フォント・サイズ: 10
      • デフォルト・フォント・スタイル: 標準
    • 章タイトル

      • 番号つき見出し、目次のヘッダー、および付録のヘッダーに使用されます。
      • デフォルト・フォント・ファミリー: Helvetica
      • デフォルト・フォント・サイズ: 14
      • デフォルト・フォント・スタイル: 太字
    • ソース・コード・テキスト

      • Java™ などのソース・コードのドキュメンテーションに使用されます。
      • デフォルト・フォント・ファミリー: Courier
      • デフォルト・フォント・サイズ: 10
      • デフォルト・フォント・スタイル: 標準
    • キャプション・テキスト

      • 画像のキャプションに使用されます。
      • デフォルト・フォント・ファミリー: Helvetica
      • デフォルト・フォント・サイズ: 10
      • デフォルト・フォント・スタイル: 太字
    • 定義テキスト

      • キー値ペアのドキュメンテーションに使用されます。
      • デフォルト・フォント・ファミリー: Helvetica
      • デフォルト・フォント・サイズ: 10
      • デフォルト・フォント・スタイル: 標準
    • ヘッダー・テキスト

      • 番号付けされていない見出しに使用されます。
      • デフォルト・フォント・ファミリー: Helvetica
      • デフォルト・フォント・サイズ: 11
      • デフォルト・フォント・スタイル: 太字
    • 目次

      • 目次に使用されます。
      • デフォルト・フォント・ファミリー: Helvetica
      • デフォルト・フォント・サイズ: 9
      • デフォルト・フォント・スタイル: 標準

設定を保管するマスター・ファイル

マスター・ファイルは、 生成されるドキュメンテーションに含まれる内容 (フォント・スタイルではなく) を定義するリソース・プロファイルです。 「ドキュメンテーションの生成」ウィザードを使用するとき、 リソースの選択を保管するためのマスター・ファイルを作成します。 そうすれば、次回、ウィザードを使用して同じレポートを生成するときには、 マスター・ファイルを選ぶだけで済みます。

新規フォントの登録

ドキュメンテーション生成プログラムには、 ドキュメンテーションで使用できる 3 つのデフォルト・フォントが備わっています。 このフォントは、Helvetica、Courier、および Times であり、 各フォントが標準、斜体、太字、太字斜体のフォント・スタイルを持っています。

True Type フォント・ファイル (.ttf) または True Type コレクション・ファイル (.ttc) を登録することによって、 新しいフォントを追加することができます。 フォントの登録は「ドキュメンテーションの生成」ウィザードから行います。 フォントが登録されると、除去されるまですべてのレポートで使用できます。 デフォルト・フォントは除去できません。 「ドキュメンテーションの生成」ウィザードの操作方法に関する説明は、 関連タスクの『ドキュメンテーションの生成』を参照してください。

注: 「ドキュメンテーション生成」ウィザードでは、 2 バイト文字セットのフォント名を含む登録済みフォント名がローマ字のみで表示されます。

トレース・ファイル

ドキュメンテーション生成プログラムは、 トレース・ファイルにドキュメンテーション生成トレース・メッセージを書き込むことができます。 注: ドキュメンテーション生成プログラムに問題がない場合は、このトレース機能をオンにしないでください。トレース機能はシステムのパフォーマンスに影響を与え、また、多くのディスク・スペースを取ることがあるためです。 トレースは「設定」ウィンドウで設定し、出力はメタデータ・ディレクトリー (ワークスペース名¥.metadata¥.plugins¥com.ibm.wbit.reporting.infrastructure¥trace¥) 内のテキスト・ファイルに書き込まれます。 ログ・エントリーは追加されても、削除することはできません。

関連概念
モジュールおよびライブラリー
モジュールとライブラリーの依存関係
ビジネス・インテグレーションのケイパビリティーおよびロール
ビジネス・インテグレーションの虎の巻
関連タスク
ビジネス・サービスに関するモジュールの作成
メディエーション・モジュールの作成
デフォルト名前空間の変更
ツール・ケイパビリティーを使用可能にする
モジュールおよびライブラリーへの依存関係の追加
ライブラリーの作成
ドキュメンテーションの生成

関連情報

チュートリアル: モジュールおよびライブラリーの操作

Feedback
(C) Copyright IBM Corporation 2005, 2006. All Rights Reserved.
(C) Copyright IBM Japan 2006