ドキュメント出力定義要素

項目

説明

ドキュメント生成に関連する要素

ドキュメント定義パッケージとドキュメント出力定義要素はツールボックスの「ドキュメント」グループに含まれています。

ツールボックスの 「ドキュメント」を選択してください。選択できない場合には、パースペクティブを切り替える必要があります。

ドキュメント定義パッケージでは、独自のタグ付き値があり、テンプレートを指定できます。ドキュメント定義パッケージ用のテンプレートを作成し、適用させます。

ドキュメント定義パッケージやドキュメント出力定義要素をダイアグラム内に配置すると、ダイアグラム内では次のように表示されます。

ドキュメントグループには、以下の内容も含まれます。

• 成果物要素の要素の付属ドキュメントに内容を記入し、生成されるドキュメントの一部とできます。
• チャート要素を利用し、モデルの内容から自動生成するチャートをドキュメントに含めることができます。
• ドキュメント出力と関係マトリックスの設定を保持し、簡単に呼び出すことができる「ドキュメント生成」要素と「マトリックスプロファイル」要素が利用できます。
• ドキュメント定義パッケージとドキュメント出力定義要素を利用し、モデルブラウザのパッケージ構成に依存しない自由な構成のドキュメントを作成できます。

テンプレート

それぞれのドキュメント出力定義要素ごとに、ドキュメントのテンプレートを指定できます。例えば、要求要素が含まれるパッケージを対象とし、テンプレートの内容を要求要素のための内容にできます。

ただし、HTMLドキュメントの生成の場合には、この機能は利用できません。HTMLドキュメントの生成時に指定する形になります。

内容

ドキュメント出力定義要素の内容は、以下のようにして決まります。

• ドキュメント出力定義要素に対して、モデルブラウザからパッケージをドラッグ&ドロップすると、属性として情報が追加されます。このパッケージがドキュメントの出力対象パッケージになります。

• タグ付き値で指定した「検索ルール」に合致する要素が対象になります。なお、ダイアグラムを対象とした検索ルールには対応していません。
  (HTMLドキュメントでは利用できません。)

属性として登録されるパッケージ名の順序を変えることで、ドキュメント内に出力される順序も調整できます。

注意:

• もし、ドキュメント出力定義要素が対象パッケージの指定と検索ルールの指定の両方の情報を持っている場合には、パッケージリストのみが利用され、検索ルールは無視されます。
• ドキュメント定義パッケージではブックマークの機能は利用できません。

ブックマークの機能では、それぞれのブックマークの内容が一意でなければなりません。通常のドキュメントを生成する際には、それぞれのブックマークは一意になります。ドキュメント定義パッケージを利用する場合、いくつかのドキュメントを結合して1つのドキュメントにします。このような場合にはブックマークが重複することになります。