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

製品準備チェックリスト

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

設計者の場合

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

次の例は、実行時のファイルの作成の際に推奨するコマンドです。
```
   
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 章「母国語のサポート」を参照してください。

© 2010, Oracle Corporation and/or its affiliates