ヘルプ・ボリュームの表示

ヘルプ・ビューアはどのヘルプ・ボリュームでも表示できます。ヘルプ・ビューアは、アプリケーション定義リンクを除くすべての型のハイパーリンクをサポートしています (アプリケーション定義リンクはどう解釈すべきかヘルプ・ビューアにはわからないからです)。

アプリケーション用ヘルプを記述していて、そのアプリケーションが使用できる状態であれば、アプリケーションを実行し、ユーザがするようにヘルプを呼び出せば、ヘルプを表示できます。

ヘルプ・ボリュームを表示するには

1. ファイル・マネージャを開き、ディレクトリを volume.sdl ファイルのあるディレクトリに移動します。

2. アイコンをダブルクリックします。

   デフォルトでは、ヘルプ・ビューアを使ってファイルが表示されます。

手動で dthelpview コマンドを実行するには

表示したいボリュームの volume.sdl ファイルが現在のディレクトリにあるか、または登録されている場合は、次のコマンドを実行します。

   dthelpview -helpVolume volume.sdl

または、volume.sdl が他のディレクトリにある (そして登録されていない) 場合は、次のコマンドを実行します。

   dthelpview -helpVolume /full-path/volume.sdl 

上記のどちらのコマンドでも、-helpVolume パラメータは -h に省略できます。

例

ヘルプ・ボリュームを編集する時には、まず、ヘルプタグ・ソフトウェアで処理します。

dthelptag MyVolume

エラーがなかった場合は、次のコマンドで表示できます。

dthelpview -h MyVolume.sdl

関連項目

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

例: 個人用ヘルプ・ディレクトリ

プロジェクト期間中に、自分が開発しているヘルプ・ボリュームにアクセスしたいけれども、システムのすべてのユーザに公開したくはない場合があります。たとえば、作業ディレクトリが /projects/help で、ヘルプ・ボリュームが Myvolume という名前だとします。

まず、ボリュームを登録できるホーム・ディレクトリに個人用ヘルプ・ディレクトリを作成します。

mkdir -p $HOME/.dt/help/C

次に、(ヘルプタグ・ソフトウェアによって作成される) Myvolume.sdl ファイルへのシンボリック・リンクを作成します。

ln -s /projects/help/Myvolume.sdl $HOME/.dt/help/C/Myvolume.sdl

これで、(現在のディレクトリとは無関係に) ボリュームを次のコマンドで表示できます。これは、ホーム・ディレクトリ内の .dt/help/C ディレクトリは、ヘルプ・システムがヘルプ・ボリュームを検索するときに最初に見るからです。

dthelpview -helpVolume Myvolume