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

アプリケーションとそのヘルプの登録

デスクトップの統合ユーティリティ dtappintegrate は、インストールされたアプリケーション・ファイルと特定のデスクトップ・ディレクトリの間にシンボリック・リンクを作成することにより、アプリケーションとそのヘルプ・ファイルを登録します。アプリケーションの登録により、ヘルプ・システムが使用するディレクトリ検索パスにヘルプ・ファイルを確実に位置付けることができます。

登録により、ヘルプ・システムの重要な 2 つの機能が使用可能になります。

オンライン・ヘルプを登録すると、提供したヘルプにアクセスしやすくなります。設計者とプログラマにとっては、ボリュームの実際の位置を指定しなくても、ボリュームへの参照にはボリューム名だけを使用すればいいのでより簡単です。

1 つ以上のヘルプ・ボリュームがあるヘルプ・ファミリを登録する場合、フロントパネルの [ヘルプ・ビューア] からの一般的なブラウズにヘルプを使用できるようにします。これにより、アプリケーションを使用しないでアプリケーション固有のヘルプにアクセスできます。また、スタンドアロン・ヘルプを記述している場合は、この方法がヘルプにたどりつく唯一の方法です。

スタンドアロン・ヘルプ

アプリケーションのスタンドアロン・ヘルプ・ボリュームやカスタマイズされた環境はヘルプ・システムの開発者用キットを使用して作成できます。ヘルプ・ボリュームをデスクトップ・ブラウザ・ボリュームからアクセス可能にするには、システム管理者は実行時のヘルプ・ファイル、関連付けられたグラフィック、およびファミリ・ファイルを /etc/dt/appconfig/help/language ディレクトリにインストールしてください。

実行時のヘルプ・ファイルとそのグラフィック・ファイルは、ヘルプ・ボリュームが作成されたときと同じ相対位置にインストールされなければなりません。グラフィック・ファイルのインストールをレビューする方法については、「グラフィック・ファイル」を参照してください。

アプリケーションの登録時に発生すること

アプリケーションの登録により、app_root/dt/appconfig/help/language にある実行時のヘルプ・ファイルおよびファミリと、/etc/dt/appconfig/help/language ディレクトリの間にシンボリック・リンクが作成されます。

アプリケーションの登録手順の詳細は、『Solaris 共通デスクトップ環境 上級ユーザ及びシステム管理者ガイド』を参照してください。

ヘルプ・ボリュームの検索方法

ヘルプ・システムはデスクトップ検索パスを使用してヘルプ・ボリュームを位置付けます。ヘルプがアプリケーション内で要求されたり、ヘルプ・ボリュームがコマンド行に指定されたりする場合、ヘルプ・ボリュームは検索パス・ディレクトリのセットをチェックすることにより検索されます。いくつかの環境変数を変更して、ヘルプ・ボリューム のディレクトリ検索パスをコントロールできます。検索パスの指定の詳細は、『Solaris 共通デスクトップ環境 上級ユーザ及びシステム管理者ガイド』を参照してください。