インストール・パッケージの作成

インストール・パッケージには次のヘルプ・ファイルが入っています。

• 実行時のヘルプ・ファイル

• グラフィック・ファイル

• ヘルプ・ファミリ・ファイル (オプション)

• アプリケーション・デフォルト・ファイル (オプション)

オンライン・ヘルプで使用されている実行時のヘルプ・ファイルとグラフィックは、インストール・パッケージに入っています。ヘルプ・ファミリ・ファイルは、統合されたアプリケーション・ヘルプのオプションです。しかし、アプリケーション・ヘルプをデスクトップのヘルプ・ビューアを使用してブラウズ可能にしたい場合は、ファミリ・ファイルを作成しなければなりません。スタンドアロン・ヘルプ・ボリュームを配布中の場合は、ヘルプ・ファミリ・ファイルを作成しなければなりません。「ヘルプ・ファミリを作成するには」を参照してください。

アプリケーションのヘルプ・ボリュームに実行リンクがある場合、設計者はアプリケーションのデフォルトのリソース・ファイルに実行別名を定義してください。このためには、実行別名でリンクを自動的に実行するヘルプ・システムのデフォルトの実行ポリシーを利用します。しかし、ヘルプ・ボリュームが別の情報ビューアを使用して独立したボリュームとして表示される場合、ヘルプ・システムは実行リンクが選択された時点で確認ダイアログボックスを表示します。

図 13-1 は、アプリケーションとそのヘルプ・ファイルの典型的なインストール・パッケージを示しています。ヘルプ・ファイルは、デフォルトの言語ディレクトリ (C がデフォルト) がある別の help サブディレクトリにグループ化されます。実行時のヘルプ・ファイル、ファミリ・ファイル、およびグラフィック・ファイルは、このディレクトリにあります。

図 13-1 アプリケーション・インストール・パッケージ

アプリケーションが複数の言語でオンライン・ヘルプを提供する場合、各言語を格納するための language サブディレクトリを作成してください (language はユーザの LANG 環境変数に一致します)。たとえば、英語ユーザ・インタフェースとドイツ語ユーザ・インタフェースの両方を提供するアプリケーションは、英語には C、ドイツ語には german というように 2 つのサブディレクトリにそれぞれ対応するオンライン・ヘルプを保存します。

実行時のヘルプ・ファイル

ヘルプタグは単一の実行時のヘルプ・ファイル volume.sdl を作成します。ベース名 volume は volume.htg ファイルのベース名と同じです。ヘルプ・ビューアはマスタ・ヘルプ・ファイルに保存されている情報を使用し、関連付けられたグラフィック・ファイルにもアクセスします。

ヘルプタグ・ソフトウェアによって作成された volume.htg ファイルや追加のファイルを出荷する必要はありません。

グラフィック・ファイル

ヘルプ・ボリュームがグラフィックを使用している場合、イメージ・ファイルは便利なように通常別のディレクトリに保存されます。しかし、volume.htg ファイルと同じ場所に保存するように選択することも可能です。

実行時のヘルプ・ファイルには実際のグラフィック・イメージは入っていません。そのかわり、各グラフィック・ファイルの位置への「参照」が入っています。ヘルプタグを実行すると、dthelptag コンパイラはグラフィック・ファイルの相対パス名をヘルプ・ボリュームに組み込みます。

ヘルプ・ファイルがインストールされると、グラフィック・ファイルは実行時のファイルが作成されたときと同じ相対位置に位置付けられます。そうでない場合、ヘルプ・ボリュームはグラフィック・ファイルを位置付けることはできません。たとえば、グラフィック・ファイルが volume.htg ファイルより 1 つ下のレベルにある graphics という名前のサブディレクトリにある場合、インストール・パッケージはその相対位置を確保しておかなければなりません。グラフィック・ファイルは volume.sdl ファイルより 1 つ下のレベルにある graphics という名前のサブディレクトリに位置付けられなければなりません。

図 13-2 作成ディレクトリとインストール・パッケージの関係

ヘルプ・ファミリ・ファイル

ヘルプ・ファミリ・ファイル (volume.hf) をオプションとして提供できます。ファミリ・ファイルには、ヘルプ・ボリュームについての簡単な記述と著作権情報があります。このファイルは、1 つ以上の関連のあるボリュームを 1 つの製品カテゴリにグループ化するのにも使用されます。

デスクトップ・ブラウザ・ボリュームからヘルプ・ボリュームへのアクセスを可能にしたい場合、インストール・パッケージにファミリ・ファイルを作成しなければなりません。ファミリ・ファイルを作成する方法については、「ヘルプ・ファミリを作成するには」を参照してください。