汎用トピックの構造

DITAのすべてのトピックは、トピック・タイプに関わらず、汎用トピック(topic要素)で定義された共通の基本構造を有します。

すべてのトピックは、汎用トピックで定義された以下の5つの要素から成ります。

  1. タイトル(title要素)
  2. ショート・デスクリプション(shortdesc要素)
  3. プロローグ(prolog要素)
  4. 本文(body要素)
  5. 関連リンク(related-links要素)

汎用トピックの構造を下図に示します。



汎用トピックの構造

トピックを構成する要素のうち、タイトルだけが必須の要素です。しかし、すべてのトピックに、最低限、タイトルとショート・デスクリプションを書くべきです。単にトピックに階層を設けるだけの場合は、タイトルのみのトピックを設けるのではなく、マップにtopichead要素を挿入します。

プロローグには、索引語やトピックのメタ情報を指定します。索引語やメタ情報が不要な場合は、プロローグを省略しても構いません。また、あるトピックで説明すべき内容を、ショート・デスクリプションだけで記述できる場合は、トピックの本文を省略しても構いません。

関連リンク

トピック間にリンクを張るには、関連リンクの代わりに関連テーブル(reltable要素)を使用することを推奨します。関連リンクを使ってトピック間にリンクを張ると、トピック間に依存関係ができ、トピックの再利用性が低下します。一方、関連テーブルを使ってトピック間にリンクを張った場合は、トピックの独立性が保たれます。関連テーブルを使うもう一つのメリットは、トピック間のリンク情報をマップで一元管理することができ、リンクの維持管理が容易になる点です。

トピックのネスト

ある汎用トピックの中に、別の汎用トピックを書くことができます。このような構造を「トピックのネスト」と呼びます。トピックのネストを使うと、トピックの独立性が損なわれるため、極力、使用を控えるべきです。トピック間に親子関係を持たせるには、トピックのネストを使う代わりに、マップでトピックの階層構造を定義します。なお、ブック指向で書かれた文書をDITAに変換する際は、トピックのネストを使うと便利な場合があります。