文書ファイルの生成

パターン・ライブラリーおよびその内容についての標準情報が含まれた、プロジェクト・ファイルのセットを生成できます。 生成されたファイルは、パターンの適用者により「パターン・エクスプローラー」ビューから開かれ、さらにオンライン・ヘルプのトピック階層の一部として表示されます。

5 つのタイプのファイル (ライブラリー、パターン、パラメーター、説明、および概要) が生成されます。 パターンおよび概要のファイルは、同一の情報を共用します。 ファイル内の静的データには、ライブラリー名、パターン名、パラメーター名、バージョン、作成者、グループ、多重度、簡単な説明、およびパラメーター UML 2,0 タイプなどのプロパティーが含まれています。 それぞれのパターンごと、およびその各パラメーターごとに、説明ファイルをインポートできます。 パターンの説明は説明ファイルに挿入され、パラメーターの説明は、すべてそのパターンのパラメーター・ファイルに挿入されます。

プロジェクト全体に対してファイルのセットを生成するか、または個々のパターンに対して生成するかのオプションがあります。 プロジェクト内の少なくとも 1 つのパターンに対してヘルプを生成する場合、個々のライブラリー・ファイルも自動的に生成されます。 必須ではありませんが、RAS マニフェスト・エディターを使用して、パターン・ライブラリーについての追加情報を追加できます。

これらのファイルを生成しない場合、そのファイルはパターン・プロジェクトに含まれません。 パターンの適用者がそのファイルを表示しようとすると、使用可能な文書がないことを示すメッセージが表示されます。 ファイルに含まれる情報を変更した場合は、再度ヘルプ・ファイルを生成し、ファイルを更新する必要があります。

以下の画面の例には、パターンに固有のトピックを表示している、オンライン「ヘルプ」ウィンドウのセクションが示されています。 パターンのオンライン・ヘルプは、「パターンの適用」トピックの下に表示されます。 この例での、パターンのライブラリー名はサンプルです。


パターンのヘルプ・ファイルの例が開かれたオンライン・ヘルプ・ウィンドウ。

オンライン・ヘルプ・ファイルを生成するには、「パターン・オーサリング (Pattern Authoring)」ビューで、以下のステップのいずれかを実行します。
ライブラリー用に生成された HTML ファイルを含む PatternHelp フォルダーが、\x\PatternFiles フォルダーのワークスペースに追加されます (x にはパターン・プロジェクトの名前が入ります)。 ヘルプが生成された方法に応じて、生成された 3 つの HTML ファイルを含む PatternHelp フォルダーが、\PatternFiles\y フォルダーの 1 つ、またはすべてに追加されます (y はパターンの名前です)。
関連概念
IBM Rational 設計パターン
パターン・コードおよびサポート・ファイル
RAS パターン・アセット
パターン・プロジェクトの内容
関連タスク
簡単な説明のテキストの提供
概要図の追加
文書のインポート
パターン・ライブラリーへの文書の追加
ご利用条件 | フィードバック
(C) Copyright IBM Corporation 2004, 2005. All Rights Reserved.
(C) Copyright IBM Japan 2005