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

第 13 章インストール・パッケージの準備

この章では、アプリケーションのインストール・パッケージにあるヘルプ・ファイルについて説明します。また、アプリケーションがデスクトップに登録されるときにヘルプ・ファイルが処理される方法についても説明しています。

概要

最後の製品を準備する段階になったら、すべてのヘルプ・ファイルが適切に作成され、インストールされていることを確認しなければなりません。製品パッケージには、実行時のヘルプ・ファイル (volume.sdl) とそのグラフィック・ファイルの両方が入っています。さらに、フロントパネルのヘルプ・ビューアを使用してボリュームの表示を可能にするヘルプ・ファミリ・ファイルを作成できます。

オンライン・ヘルプの配布

オンライン・ヘルプは、アプリケーションに完全に統合されるか、スタンドアロン・ヘルプ・ボリュームとして提供されます。完全に統合されたヘルプにより、[ヘルプ] メニューか [ヘルプ] キーを使用してアプリケーションからヘルプ情報に直接アクセスできます。スタンドアロン・ボリュームは一方で、デスクトップのヘルプ・ビューアを使用してしか表示できません。

システム管理者は、アプリケーションが統合されたヘルプを提供しない場合や、カスタマイズされた環境で補足的なヘルプ・ボリュームが作成されない場合に、スタンドアロン・ヘルプ・ボリュームをデスクトップに追加するように選択できます。デスクトップにスタンドアロン・ボリュームをインストールする手順については、「スタンドアロン・ヘルプ」を参照してください。

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

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

実行時のヘルプ・ファイル
グラフィック・ファイル
ヘルプ・ファミリ・ファイル (オプション)
アプリケーション・デフォルト・ファイル (オプション)

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

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

図 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 つの製品カテゴリにグループ化するのにも使用されます。

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

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

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

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

他のボリュームへのハイパーリンク

1 つのヘルプ・ボリュームにあるハイパーリンクは、ボリューム名とボリュームにある ID だけを使用して別のヘルプ・ボリュームを参照できます。転送先ボリュームが登録されている場合、リンクはボリュームをファイル・システムのどこに保存するかを指定する必要はありません。
ヘルプ・ファミリのブラウズ

「ヘルプ・ファミリ」も登録する場合、ヘルプ・ボリュームはヘルプ・ビューアを使用してブラウズ可能になります。

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

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

スタンドアロン・ヘルプ

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

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

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

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

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

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

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

製品準備チェックリスト

次のチェックリストは、製品が適切に準備されていることを確認するのに役立ちます。もちろん、ユーザが行うように製品をテストするのが一番いい方法です。

設計者の場合

最後のバージョンの実行時のヘルプ・ファイルが作成された。

次の例は、実行時のファイルの作成の際に推奨するコマンドです。
```
   
dthelptag -clean volumedthelptag volume nomemo onerror=stop
```
-clean オプションは、上記の dthelptag コマンドからファイルを削除します。nomemo オプションは、記述者のメモが表示されないようにします。onerror=stop オプションは、パーサ・エラーが発生した場合に処理を停止します。パーサ・エラーが発生したヘルプ・ボリュームを配布してはなりません。

すべてのハイパーリンクをテストした。

各ハイパーリンクは適切なトピックを表示し、正しいアクションを実行します。

実行別名が実行リンクに定義された。

実行別名は、アプリケーションのアプリケーション・デフォルト・ファイルにあるリソースとして定義されます。実行別名は実行されるシェル・コマンドと名前とを関連付けます。ヘルプ・ボリュームで実行リンクを使用した場合は、アプリケーション開発者がこれらのリソースをアプリケーション・デフォルト・ファイルに追加するように調整してください。詳細は、「実行別名」を参照してください。

すべてのグラフィックが受け入れ可能である。

グラフィックは、カラー、グレースケール、およびモノクロ・ディスプレイでテストされました。

製品のインテグレータの場合

実行時のファイルがインストールされた。

すべてのグラフィックが適切な位置にインストールされた。

各グラフィック・ファイルは、ヘルプタグ・ソフトウェアが実行されたときに .htg ファイルとは相対的な位置にあった .sdl ファイルに対しても、同じ相対的な位置にインストールされなければなりません。

ヘルプ・ボリュームが登録された。

dtappintegrate スクリプトが、インストール・ディレクトリから登録ディレクトリにシンボリック・リンクを作成するために実行されました。

製品のファミリ・ファイルがインストールおよび登録された。

ファミリ・ファイルは他のヘルプ・ファイルと共にインストールされます。dtappintegrate を実行すると、ファミリ・ファイルのシンボリック・リンクを作成します。ヘルプ・ボリュームのためにファミリ・ファイルを登録するのは任意です。しかし、ファミリ・ファイルを登録しないと、ヘルプ・ボリュームはフロントパネルの [ヘルプ・ビューア] からはアクセスできません。

プログラマの場合

アプリケーションは、次の必須リソースに対して正しい値を設定している。
```
   

App-class*helpVolume:        volume
App-class*helpOnHelpVolume:  help-on-help-volume 
```
helpVolume リソースは、アプリケーションのためのヘルプ・ボリュームを識別します。helpOnHelpVolume は、ヘルプ・システムの使用に関するヘルプがあるヘルプ・ボリュームを識別します。

実行別名は、アプリケーションのデフォルトのリソース・ファイルにある。

設計者は、アプリケーションのリソースとして実行別名を定義します。実行別名は、実行するシェル・コマンドと名前とを関連付けます。実行リンクがヘルプ・ボリュームで使用されていた場合は、追加の必要があるリソースを識別していることを設計者が確認するようにしてください。詳細は、「実行別名」を参照してください。

アプリケーションが次のオプションのリソースに対して希望する値を設定している。
```
   
App-class*DtHelpDialogWidget*onHelpDialog*rows:     rows
App-class*DtHelpDialogWidget*onHelpDialog*columns:  columns
App-class*DtHelpDialogWidget*definitionBox*rows:    rows
App-class*DtHelpDialogWidget*definitionBox*columns: columns 
```
onHelpDialog リソースは、「ヘルプの使い方」を表示するのに使用される簡易ヘルプ・ダイアログのサイズをコントロールします。definitionBox リソースは、定義リンクに使用される簡易ヘルプ・ダイアログのサイズをコントロールします。

アプリケーションは、デフォルトのフォント・リソースを使用するか、アプリケーションのデフォルトのリソース・ファイルにフォント・リソースを定義している。

ほとんどの場合、アプリケーションはデフォルトのフォント・リソースを使用できます。しかし、カスタム・フォントが使用される場合、デフォルトのリソース・ファイルに定義されていなければなりません。サンプルのフォント・スキーマが /usr/dt/dthelp/fontschemes ディレクトリに用意されています。フォント・スキーマの詳細は、第 14 章「母国語のサポート」を参照してください。

第 13 章 インストール・パッケージの準備

概要