エンティティ名を文字列または外部ファイルに指定します。
<!entity entityname "string">
または
<!entity entityname FILE "filename">
エンティティ名は 64 字以下の英字、数字、ハイフンで指定できます。大文字小文字の区別はエンティティ名については重要ではありませんが、設計者が読みやすいように使い分けることが多いです。先頭の文字は英字で始めなければなりません。<!entity> 宣言の中の < (左三角括弧)、! (感嘆符)、entity の間には、スペースを入れないでください。
エンティティの宣言は、常に他のマークアップまたはヘルプ・ボリュームのテキストより前に入れなければなりません。
定義したエンティティを表示させるときは、次の形式を使用するエンティティの参照を挿入します。
&entityname;
エンティティの参照は & (アンド記号) の後にエンティティ名 (エンティティの宣言で定義) が続き、最後に ; (セミコロン) が付きます。
エンティティは、次の 4 つの理由により定義します。
エンティティ名で指定されたテキストは一度しか表れないため、テキストを変更するときは 1 箇所変更するだけで済みます。ヘルプタグがファイルを再処理するとき、エンティティの参照はすべて自動的に変更されます。
テキストが何度も表示される場合でも、略式のエンティティの参照を入力すればよいので、長く複雑なテキスト文字列を繰り返し入力するという無駄な労力 (あるいは入力ミス) を省くことができます。完全なテキスト文字列を入力するのは一度だけで済みます。
<figure> 要素および <graphic> 要素にファイル名は適用できません。図を含むファイル名は、エンティティの宣言で指定してください。
ヘルプ・テキストを複数のファイルに入れると便利ですが、ヘルプタグは 1 つのソース・ファイルしか受け入れません。実際のヘルプ・テキストを含むファイルを参照するエンティティの宣言とエンティティの参照を含むファイルを 1 つ作成することによってこの矛盾を是正できます。
volume.htg ソース・ファイルには次のようなエンティティの宣言およびエンティティの参照が含まれているので、実際のテキストが指定したファイルに挿入されます。
<!entity topic1 FILE "topic1"> <!entity topic2 FILE "topic2"> <!entity topic3 FILE "topic3"> &topic1; &topic2; &topic3;
次のエンティティの宣言にある「Architectural Analysis of Aircraft Precision Components」という語は、マークアップ・ファイルのエンティティの参照では &apc; と表示されます。
<!entity apc "Architectural Analysis of Aircraft Precision Components">
次のような図に対するエンティティの宣言は、ソース・ファイルの先頭に置かれます。
<!entity CloseUpFig FILE "figname.tif">
図は次のマークアップの場所に挿入されます。
<figure entity=CloseUpFig> Close Up View <¥figure>