エンティティの使い方

エンティティには文字列やファイルの内容を指定できます。エンティティの宣言は、エンティティ名と特定の文字列やファイル名とを関連付けることによりエンティティを定義します。エンティティの参照は、dthelptag コマンドでヘルプ・ボリュームを処理すると文字列やファイルの内容に置き換えられます。

エンティティは次の作業を実行できます。

• テキストの共通の文字列を参照する。

  テキストを変更したり、繰り返し入力したくないような場合に便利です。テキストを挿入したい場所では、エンティティ名を参照してください。

• 外部ファイルを参照する。

  グラフィック・ファイルにアクセスするにはエンティティが必要です。<figure> 要素と <graphic> 要素にエンティティ名の指定に使用する必須パラメータが入っており、このエンティティ名によりグラフィック・イメージ・ファイルを参照します。

ファイル・エンティティにより、ヘルプタグ・ソースを複数のファイルに分割できます。他のファイルをマスタ・ヘルプタグ・ファイルに取り込んで処理を行うためには、エンティティの参照を使用してください。

エンティティの宣言に関する規則

• エンティティ名は、英字 (A から Z と a から z)、数字 (0 から 9)、マイナス (-) 記号から成り、必ず英字で始まります。

• エンティティ名は大文字でも小文字でも意味は変わりませんが、読みやすいように使い分けてください。

• エンティティ名の長さは、64 文字以内です。

• 各エンティティ名は、単一のボリューム内では固有のものでなければなりません。

テキスト・エンティティを作成するには

1. 次のようにエンティティを宣言します。

      <!entity Entityname  "text"> 

   Entityname はエンティティ名で、text はエンティティへの各参照に代わる文字列です。エンティティの宣言はすべて、ヘルプ・ボリュームの他のマークアップの前にくる必要があるので注意してください。

2. text 文字列を挿入する各位置に、次のようにエンティティの参照を入力します。

      &Entityname;

   & (アンド記号) と ; (セミコロン) の文字は、ヘルプタグ・ソフトウェアがエンティティの参照を適切に認識するために必要です。

例

次の行は「Society of Agricultural Engineers」という文字列が入っている Assoc という名前のテキスト・エンティティを宣言しています。

<!entity Assoc "Society of Agricultural Engineers"> 

次の文には、エンティティへの参照が記述されています。

Welcome to the &Assoc;.

ヘルプ・ボリュームがヘルプタグ・ソフトウェアで処理されると、エンティティの参照はエンティティの値に置き換えられます。そのため、文は次のように表示されます。

Welcome to the Society of Agricultural Engineers.

ファイル・エンティティを作成するには

1. 次のようにエンティティを宣言します。

      <!entity Entityname FILE  "filename"> 

   Entityname はエンティティ名で、filename はファイル名です。キーワード FILE は必須です。

2. 次のようにエンティティを参照します。

   • ファイルがテキスト・ファイルの場合、ファイルの内容を挿入する各位置に次のようにエンティティの参照を入力します。

        &Entityname;

     & (アンド記号) と ; (セミコロン) の文字は、ヘルプタグ・ソフトウェアがエンティティの参照を適切に認識するために必要です。

   • ファイルがグラフィック・ファイルの場合、次のマークアップ行のうちの 1 つにパラメータとしてエンティティ名を入れます。

        <figure entity=Entityname ... > 

     または

        <graphic entity=Entityname ... > 

     または

        <p gentity=Entityname ... > 

     ---

     注 -

     ファイル名にはパスを入れないでください。ヘルプタグ・ソフトウェアを実行するときにファイルが現在のディレクトリにない場合は、適切な検索パスを helptag.opt ファイルに追加してください (詳細は、「実行時のヘルプ・ボリュームを作成するには」を参照してください)。

     ---

例: テキスト・ファイル・エンティティ

file1、file2、および file3 という名前の 3 つのファイルと <metainfo> ...</metainfo> セクションがある 4 番目のファイルに、ヘルプ・ボリュームのテキストを記述したとします。次のようにして 4 つのファイルを volume.htg ファイルに取り込むことができます。

<!entity MetaInformation   FILE  "metainfo">
<!entity MyFirstFile       FILE  "file1">
<!entity MySecondFile      FILE  "file2">
<!entity MyThirdFile       FILE  "file3">

&MetaInformation;

<hometopic>  My Home Title

Welcome to my application's help volume.

&MyFirstFile;
&MySecondFile;
&MyThirdFile;

例: グラフィック・ファイル・エンティティ

単一のヘルプ・ボリュームのホーム・トピックに図があり、図のグラフィック・イメージが picture.tif という名前のファイルに格納されているとします。次の例は、そのイメージが図でどのように使用されるかを示しています。

<!entity MetaInformation  FILE  "metainfo">
<!entity MyPicture        FILE  "picture.tif">

 &MetaInformation;

 <hometopic> A Sample Graphic

 Welcome to my application's help volume

 <figure nonumber entity=MyPicture>
 A Picture
 <¥figure> 

テキスト「A Picture」は、図のタイトルです。

マークアップの出力は次のとおりです。

関連項目

• 「グラフィックの表示」