共通デスクトップ環境 プログラマーズ・ガイド (ヘルプ・システム編)

ヘルプへのアクセス方法

ユーザを正しく認識するのと同時に、ユーザがどのようにヘルプにアクセスするのかを理解することが重要です。

アプリケーションのヘルプ

アプリケーションのヘルプを記述する場合は、ブラウズできるトピックと、コンテキスト・ヘルプとしてアプリケーションから使用できるトピックをそれぞれ決めることが必要です。トピックをナビゲートできる場合は、トピック・ツリーまたはハイパーリンクを使用してトピックをブラウズできます。排他的なコンテキスト・ヘルプに指定されているトピックは、アプリケーションの特定のコンテキストからしかトピックを表示できないため、ブラウズできません。

アプリケーションのヘルプボリュームを登録するかどうかも決める必要があります。登録されたヘルプ・ボリュームは他のアプリケーション (ヘルプ・ビューアなど) によっても表示でき、より広範囲な情報へのアクセスが可能になります。ヘルプ・ボリュームにあるトピックへの別のヘルプ・ボリュームからのハイパーリンクが含まれている場合は、そのヘルプ・ボリュームを登録してください。

アプリケーションのインストールと登録の詳細は、「アプリケーションとそのヘルプの登録」を参照してください。

スタンドアロン・ヘルプ・ボリューム

スタンドアロン・ヘルプ・ボリューム (アプリケーションに対応付けられていないヘルプ・ボリューム) を記述する場合は、別の方法で実行できます。

まず、記述したすべてのトピックをユーザが使用できるようパスを設定しなければなりません。つまり、すべてのトピックが、少なくとも 1 つのハイパーリンクによってブラウズできなければなりません。また、ヘルプに対応付けられているアプリケーションがないため、ヘルプ・ボリュームの表示はヘルプ・ビューアに依存しなければなりません。