文書ファイルの生成

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

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

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

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

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


サンプルのパターンのヘルプ・ファイルが開いている状態のオンライン・ヘルプ・ウィンドウ。

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