ヘルプ・ボリュームのコンポーネント

ヘルプ・ボリュームには、ホーム・トピック、トピック、サブトピック、エンティティの宣言、メタ情報、および用語集のおもに 6 種類のコンポーネントがあります。

ホーム・トピック

ホーム・トピックは、トピック階層の中でトップレベルにあるトピックです。最初のトピック、つまりヘルプ・ボリュームの先頭になります。その他のトピックはすべてサブトピックになります。トピック階層を複数のレベルの階層で構成することも可能です。しかし、階層内で迷わないようにするために、階層をできる限り浅くしておくべきです。

トピックとサブトピック

トピックとサブトピックは、ホーム・トピックの下に階層を形成します。通常、ホーム・トピックに続く第 1 レベルのトピックは、<chapter> 要素を使用して章に分割されます。章の内では、トピックはセクションに分割されます。<s1> セクションのサブトピックは <s2> と入力され、<s2> のサブトピックは <s3> のように入力されていきます。

章かセクションのどちらかの要素をホーム・トピックの後に続けることができます。階層を <chapter> と <s1> のどちらで始めてもその違いは表示からはわかりません。図 2-1 では、3 つの章がある単純な階層を示しています。各章には第 1 レベルのセクションがいくつかあります。3 番目の章には第 2 レベルのセクションが 2 つ追加されています。

図 2-1 ヘルプ・ボリュームのトピック構成

エンティティ

設計者定義のエンティティには、文字列またはファイル名を指定します。エンティティ宣言は、エンティティ名とエンティティが表す文字列またはファイルを定義します。

エンティティは次の場合に有効です。

• テキストの共通の文字列を参照する

  テキストが変更されたり、繰り返し入力したくないような場合に便利です。テキストを挿入したい場所では、エンティティ名を参照してください。

• 外部ファイルを参照する

  グラフィック・ファイルにアクセスするにはエンティティが必要です。<figure> 要素と <graphic> 要素にエンティティ名を指定する必須パラメータが入っており、このエンティティ名によりグラフィック・イメージ・ファイルを参照します。

ヘルプ・ボリューム内の他のマークアップの前にすべてのエンティティの宣言を入力しなければなりません。定義済みのエンティティを入れるには、エンティティの参照を使用します。エンティティの参照は、ヘルプ・ボリューム内であればどこでも使用できます。ヘルプタグ・ソフトウェアでヘルプ・ボリュームを処理する場合、各エンティティの参照は、そのエンティティが指すテキストまたはファイルで置換されます。「エンティティの使い方」では、エンティティの定義方法と使い方について説明しています。

メタ情報

メタ情報はユーザの情報についての情報です。ボリュームのタイトル、著作権に関する記述、および要約などの情報が含まれています。要約は、ボリュームの内容についての簡単な説明です。

ヘルプ・システムは、メタ情報を使用して、ヘルプ・ボリュームのタイトルとその著作権情報を表示します。要約の記述は、フロントパネルのデスクトップ・ヘルプ・ビューアによって表示されます。ヘルプ・ボリュームを表示できる他のアプリケーションもまたこの情報を使用できます。

メタ情報には、通常のトピック階層の一部ではないヘルプ・トピックも含むことができます。メタ情報セクションにある非階層トピックには、リンクでアクセスします。

「メタ情報トピックの作成」は、メタ情報セクションの作成方法を示しています。

用語集

用語集には、ヘルプ・ボリュームで使用されている用語に対する定義が入っています。用語が <term> 要素を使用して入力される場合、自動的に定義リンクになり、選択されるとその用語に関する用語エントリを表示します。