ヘルプ・トピックの構成

設計者はヘルプ情報を論理フレームワークで構成します。例外はありますが、トピックの概略または階層を示す形式がほとんどです。図 1-8 に示すトピックの階層は、メイン・レベル、3 つのセクション、およびそれに従属するトピックから構成されています。[ヘルプ] は階層から成る情報に最適化されていますが、必要に応じて任意の構成にできます。

図 1-8 トピックの階層

ヘルプ・トピック

ヘルプ・トピックは固有の ID で識別される情報の単位です。ヘルプ・システムが提供する一連のタグは、ヘルプ・トピックをマークし、構造的なフレームワークを作成するために使用されます。ヘルプ・ビューアはヘルプ・システムの一部で、ヘルプ・トピックに直接アクセスし表示させることができます。

ヘルプ・ボリューム

ヘルプ・ボリュームは、アプリケーションまたは特定のサブジェクトを記述するトピックの集まりです。アプリケーションのヘルプを開発する場合、一般にはアプリケーションごとに 1 つのヘルプ・ボリュームがあります。ただし、複雑なアプリケーション、または関連するアプリケーションの集まりについては、複数のヘルプ・ボリュームを使用することもあります。

ヘルプ・ファミリ

ソフトウェアは、プロダクト・ファミリとして認識される一連の関連アプリケーションとして使用できます。たとえばオフィスで使用されるアプリケーションにはワードプロセッサ、スプレッドシート、描画プログラムなどがあります。各アプリケーションには独自のヘルプ・ボリュームがあるので、関連するヘルプ・ボリュームをヘルプ・ファミリとしてグループ化するようになっています。ヘルプ・ファミリには単一のヘルプ・ボリュームまたは複数のボリュームが入っています。

ヘルプ・ボリュームをヘルプ・ファミリにまとめるかどうかは任意です。フロントパネルの [ヘルプ・ビューア] などのヘルプ・ブラウザでヘルプをブラウズできるようにする場合にのみ必要です。

ヘルプ・ファミリ・ファイルとその使い方については、「ヘルプ・ファミリを作成するには」を参照してください。

ヘルプ・ブラウザ・ボリューム

デスクトップは、システムにインストールされたヘルプを表示するブラウザ・ボリュームと呼ばれる特殊なヘルプ・ボリュームを提供します。フロントパネルの [ヘルプ・ビューア] をクリックすると、図 1-9 に示すブラウザ・ボリュームが表示されます。

これは、ヘルプ・ファミリ (下線の付いた名前) とヘルプ・ファミリのメンバである任意のボリュームを表示します。

図 1-9 ヘルプ・ブラウザ・ボリューム

ブラウザ・ボリュームにより、アプリケーションを使用せずにアプリケーション固有のヘルプにアクセスできます。またスタンドアロン・ヘルプを書く場合は、ヘルプを使用するための唯一の手段がこのブラウザ・ボリュームを使用する方法です。ヘルプ・ボリュームが 1 つしかない場合は、[ヘルプ・ビューア] でブラウズできるヘルプ・ファミリに属していなければなりません。

「ブラウザ・ボリュームへのヘルプの追加」では、ファミリ・ファイルの作成方法と、ブラウザ・ボリュームからヘルプ・ボリュームにアクセスできるようにするためにユーザが行うべき作業について説明しています。