パターン・ライブラリーへの文書の追加

パターン・ライブラリーは、静的データ・ファイル内のメンバー・パターンについての情報を維持します。 使用するパターンの適用者のために、このライブラリーのマニフェスト・ファイルに文書を追加することができます。

パターンの適用者が「パターン・エクスプローラー」ビューで「パターンの文書の表示 (Show Pattern Documentation)」 メニュー項目をクリックすると、ライブラリー情報の小さなサブセットがオンライン・ヘルプに表示されます。 このライブラリー情報に簡単な説明を追加することができます。

ライブラリーのマニフェスト・ファイルは、ファイル拡張子 .rmd を含む、ライブラリーと同じ名前を持っています。

ライブラリーに簡単な説明を追加するには、以下のようにします。

  1. 「パッケージ・エクスプローラー」ビューで、パターン・プロジェクト内の PatternFiles ノードを見つけて、展開します。
    パターン・プロジェクトの展開された PatternFiles フォルダー。
  2. ライブラリー・マニフェスト・ファイルをダブルクリックして、RAS Manifest Editor 内で開きます。
  3. アセット・ページ上で、「簡単な説明」 フィールドのデフォルトのテキストを削除して、ライブラリーにする情報を入力します。
  4. 「ファイル」 > 「すべて保存 (Save All)」とクリックして、変更点を保存します。
  5. 「パターン・オーサリング」ビューで、プロジェクト・ライブラリーを右クリックし、「ヘルプ・ファイルの生成」をクリックして、マニフェストの情報をプロジェクト・ファイルに追加します。
  6. 「パッケージ・エクスプローラー」ビューで、PatternFiles の下で PatternHelp ノードを展開し、ライブラリーの HTML ファイルをダブルクリックします。 ファイルに対して行った変更点を表示できます。
注: RAS Manifest Editor を使用して追加のライブラリー・マニフェスト・プロパティーを変更できますが、注意が必要です。 パターン・プロジェクトは、パターン・プラグインを構築してインポートするために、ライブラリーとパターン・マニフェスト・ファイルの整合性に依存します。
関連概念
IBM Rational 設計パターン
パターン・コードとサポート・ファイル
Reusable Asset Specification (RAS) パターン・アセット
パターン・プロジェクトの内容
関連タスク
簡単な説明テキストの提供
概要図の追加
文書ファイルの生成
文書のインポート
ご利用条件 | フィードバック
(C) Copyright IBM Corporation 2004, 2005. All Rights Reserved. (C) Copyright IBM Japan 2005