ヘルプ・ソース・ファイル

オンライン・ヘルプは通常のテキスト・ファイルで記述されます。ヘルプタグ・ソフトウェアでこれらのファイルを処理またはコンパイルし、ヘルプ・システムによって読み込むことができる実行時のヘルプ・ファイルを作成します。

volume.htg ファイルの作成

ヘルプタグには、volume.htg または volume.ctg という名前のプライマリ・コントロール・ファイルが必要です。volume には選択したボリューム名が入ります。ファイル拡張子によって、コントロール・ファイルが簡易マークアップ (.htg) か正規マークアップ (.ctg) のどちらを参照するかを指定します。

ボリューム名が固有のもので、意味があるものか確認してください。ボリューム名が一般的すぎる場合は、他のユーザが作成した別のボリュームと重複してしまう可能性があります。アプリケーションのヘルプを記述する場合、アプリケーションのクラス名を使用することをお勧めします。たとえば、アイコン・エディタのクラス名は Dticon なので、そのヘルプ・ボリューム名は Dticon.htg と名付けます。

複数のソース・ファイル

volume.htg ファイルには、エンティティの宣言とヘルプ・ボリュームを作成するファイルへのエンティティの参照が記述されています。ヘルプタグは入力として単一の volume.htg ファイルを必要としますが、作業を複数のソース・ファイルに分割できます。追加のファイルは、ファイル・エンティティを使用して volume.htg ファイルにまとめられます。ファイル・エンティティは、他のファイルへのポインタのようなものです。そのファイルは実際には、volume.htg ファイル内でエンティティの名前が表示されたところであればどこでも挿入されます。参照されるファイルもまた、別のファイルを参照するエンティティを含むことができます。(エンティティはテキスト文字列を参照する場合にも使用できます。)

例

ヘルプ・ボリュームには 6 つの章があり、各章は独立したファイルであるとします。ファイルには、HomeTopic、Metainfo、TOC、Tasks、Reference、および Glossary があります。ヘルプ・ボリュームの volume.htg ファイルには、6 つのファイルそれぞれに対するファイル・エントリと、ファイルの処理をヘルプタグ・ソフトウェアに指示するエンティティ参照リストが含まれています。

<!entity HomeTopic              FILE "HomeTopic">
<!entity MetaInformation        FILE "Metainfo">
<!entity TableOfContents        FILE "TOC">
<!entity Tasks                  FILE "Tasks">
<!entity Reference              FILE "Reference">
<!entity Glossary               FILE "Glossary">

&HomeTopic;
&MetaInformation;
&TableOfContents;
&Tasks;
&Reference;
&Glossary;

実行中のヘルプタグの詳細は、「実行時のヘルプ・ボリュームを作成するには」で説明しています。