親子関係にある要素やパッケージの出力

ドキュメントでは子要素は2通りの方法で出力できます。:

子要素の情報を親要素とは別のフォーマットで記述します。もう一つは親要素と同じフォーマットで子要素の情報を出力します。
親要素と同じフォーマットで子要素の情報を出力します。

後者の方法では、結果としてプレースホルダとなる(実際の中身のない)セクションを配置します。中身のないセクションを作成すると、再帰的に処理するようになります。

利用手順:

リボン

生成・入出力 > ドキュメント > テンプレートエディタ > 構成
生成・入出力 > ドキュメント > テンプレートエディタ > 内容

その他

モデルブラウザ内のリソースタブ | ドキュメントテンプレート | ユーザーテンプレート | テンプレート : 対象のテンプレートを右クリック | 開く > 構成
モデルブラウザ内のリソースタブ | ドキュメントテンプレート | ユーザーテンプレート | テンプレート : 対象のテンプレートを右クリック | 開く > 内容

項目

説明

別のフォーマットにする場合の例

最初の例では子要素を親要素とは別の形式で出力する例です。この例では、子要素は「子要素」セクションの中に書かれている形式で出力されます。

同じフォーマットにする場合の例

2つ目の例は「子要素」のセクションには内容がありません。この例では、要素の子になっている要素も、親と同じ要素セクションの内容の形式で出力されます。

これは、「子要素」セクションが空になっているからです。空の「子要素」セクションをプレースホルダーとして配置することで、親要素も子要素も同じ形式で出力することを明示します。子要素のセクションを配置しない場合には、子要素の内容は出力されません。

子要素と、関連する親要素

子要素のセクション	プレースホルダーとして指定されたときに利用する親要素
パッケージ->子パッケージ	パッケージ
パッケージ->要素->子要素	パッケージ->要素
パッケージ->要素->ダイアグラム	パッケージ->ダイアグラム
パッケージ->ダイアグラム->要素	パッケージ->要素
パッケージ->ダイアグラム->接続	パッケージ->要素->接続

注意:

原則的には、再帰的に処理を行うようにするために子セクションの内容は空にしておきます。その理由の一つとして、子セクションの中にはさらにセクションを含むことができないことが挙げられます。例えば、要素::子要素のセクションには、シナリオや属性のセクションを入れることはできません。つまり、シナリオや属性など、セクションとして出力を定義する内容は、この方法ではドキュメントには出力できないことになります。

子セクションの内容を独自に定義する例として、親セクションと異なる内容にしたい場合があります。

参照: