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

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

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

       <!entity Entityname FILE  "filename"> 

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

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

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

         &Entityname;

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

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

         <figure entity=Entityname ... > 

      または

         <graphic entity=Entityname ... > 

      または

         <p gentity=Entityname ... > 

      注 -

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


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

file1file2、および 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」は、図のタイトルです。

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

Graphic

関連項目