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

ブラウザ・ボリュームへのヘルプの追加

デスクトップは、ブラウザ・ボリュームと呼ばれる特別なヘルプ・ボリュームを提供しています。ブラウザ・ボリュームにはシステムで使用可能なヘルプ・ボリュームがリストされます。ブラウザ・ボリュームは、フロントパネルで [ヘルプ・ビューア] コントロールをクリックすると表示されます。

ブラウザ・ボリュームから各種のヘルプ・ボリュームを直接表示できます。これにより、アプリケーションを起動しなくてもアプリケーション固有のヘルプにアクセスできます。また、スタンドアロン・ヘルプを記述している場合は、ユーザがそのヘルプを得られる唯一の方法です。

図 4-1 ヘルプ・ファミリを表示するブラウザ・ヘルプ・ボリューム

ヘルプ・ボリュームをブラウザ・ボリュームで使用できるようにするには、ヘルプ・ファミリ・ファイルを作成します。アプリケーションがデスクトップに登録されてファミリ・ファイルができると、ヘルプ・ボリュームがブラウザ・ボリュームの中に取り込まれます。

ブラウザ・ボリューム

デスクトップ・ユーティリティはブラウザ・ボリュームを作成および更新します。ユーザが初めてフロントパネルの [ヘルプ・ビューア] をクリックすると、このユーティリティが自動的に実行されます。このユーティリティは、ヘルプ検索パス・ディレクトリにあるヘルプ・ボリュームとヘルプ・ファミリ・ファイルを識別します。このユーティリティは、browser.hv というファイルをユーザの HomeDirectory/.dt/help/$DTUSERSESSION ディレクトリに作成します。一度作成された後は、ボリュームは変更があった場合にのみ更新されます。

ブラウザ・ボリュームを手動で更新するには、「ブラウザ・ヘルプ・ボリュームの作成 (dthelpgen)」を参照してください。

ブラウザ・ボリュームにリストされているヘルプ・ボリュームはどれでも、ボリューム・タイトルを選択すれば表示できます。異なるボリュームから表示やナビゲートができるので、ブラウザ・ヘルプ・ウィンドウには [トップレベル] というボタンがあります。1 つまたは複数のボリュームを表示した後に、このボタンを使ってブラウザ・リストに戻ることができます。

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

デスクトップ・ユーティリティは、どのヘルプ・ボリュームがブラウザ・ボリュームに集められているか識別するために、ヘルプ・ファミリ・ファイルを調べます。図 4-1 は、ブラウザ・ボリュームにリストされている「Common Desktop Environment (共通デスクトップ環境)」と「Overview and Basic Desktop Skills (概要とデスクトップの基本スキル)」という 2 つのヘルプ・ファミリを示します。各ファミリ・ファイルは、1 つまたは複数の関連するヘルプ・ボリュームから成ります。たとえば、「Common Desktop Environment (共通デスクトップ環境)」ファミリには、デスクトップを説明する異なったボリュームが含まれています。

アプリケーションとそのヘルプ・ファイルをデスクトップにインストールする方法の詳細は、『Solaris 共通デスクトップ環境上級ユーザ及びシステム管理者ガイド』を参照してください。

ヘルプ・ファミリを作成するには

プロダクトに独自のファイル名を付けます。ヘルプ・ファミリのファイルだと識別できるように拡張子 .hf を使用します。
```
   
family.hf 
```

次の行をファイルに入力します。
```
   *.charSet:      character-set
*.title:        family title
*.bitmap:       icon file
*.abstract:     family abstract
*.volumes:      volume volume volume ... 
```
character-set は、family title 文字列と family abstract 文字列が使用する文字セットです。サポートされている文字セットのリストについては、「フォント・スキーマの理解」を参照してください。family title と family abstract にはヘルプタグ・マークアップを指定できません。このファイルはヘルプタグ・ソフトウェアでは処理されません。

icon file はオプションです。指定する場合、ファイルの位置を指定するのに使用するパスは絶対パス名でなければなりません。アイコンを付けない場合は、ファミリ・ファイルに *.bitmap リソースを指定しないでください。

volume 名のリストは、そのファミリにどのボリュームが属すのかを識別します。ボリュームは、この行に表示される順番にリストされます。1 つのボリュームが複数のファミリにリストされることもあります。

いずれかの値が 1 行を超える場合、最後の行以外の各行を ¥ で終わらせます。

ファイル内で ! (感嘆符) で始まる行はコメント行であり、無視されます。

最終的なプロダクトを準備するとき、family.hf ファイルと残りのヘルプ・ファイルをインストールしてください。デスクトップ統合スクリプト (dtappintegrate) は、実行されるとファミリ・ファイルへのシンボリック・リンクを作成します。

dtappintegrate スクリプトの実行方法は、『Solaris 共通デスクトップ環境上級ユーザ及びシステム管理者ガイド』に説明されています。

例

次の例は、デスクトップのオンライン・ヘルプ用のファミリ・ファイルです。ファイルの最初にあるコメントで、ファミリとリリース・バージョンが識別できます。

!##############################################
!#                                            #
!#          Desktop  Help Family              #
!#                                            #
!#                 Version 1.0                #
!#                                            #
!##############################################
*.charSet:      ISO-8859-1
*.title:        Desktop Version 1.0
*.bitmap:       /usr/dt/appconfig/help/C/cdelogo.pm
*.abstract:     Overview and Basic Desktop Skills ¥ 
                * File Manager and the Desktop ¥ 
                * Front Panel ¥ 
                * Application Manager ¥ 
                * Style Manager ¥ 
                * Text Editor ¥ 
                * Mailer

*.volumes: Intromgr.sdl Filemgr.sdl FPanel.sdl
           Appmanager.sdl Stylemgr.sdl
           Textedit.sdl Mailer.sdl

実際にデスクトップ・ソフトウェアに指定されているヘルプ・ファミリは、この図のとおりではありません。

ブラウザ・ボリュームを表示するには

デスクトップのフロントパネルから [ヘルプ・ビューア] コントロールを選択します。

ヘルプ・ウィンドウをスクロールして、システムで使用可能なヘルプ・ファミリを表示します。

ヘルプ・ファミリ・タイトルを選択してボリュームを表示します。

注 -

ヘルプ・システムに関するヘルプ情報を参照するには、[デスクトップの紹介] を選択してから [ヘルプの使い方] を選択してください。

手動でブラウザ・ボリュームを表示するには

次のように dthelpview コマンドを実行します。

   dthelpview -helpvolume browser