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

ヘルプ・ボリュームの例

次のマークアップは、入力に使用されるヘルプ・ボリュームとタグの重要な要素の例を示しています。この例では簡易マークアップを使用しますが、このマークアップは SGML 構造の中間タグを省略し、必須の終了タグの数を最小にします。インデントは、要素の階層関係を強調表示するために使用されます。したがって、記述するヘルプ・ファイルをインデントする必要はありません。

All entity declarations go here (before any other markup).
<helpvolume>
      <metainfo>
          <title>  Volume Title
          <copyright>
          Copyright topic goes here ...
          <abstract>
           The abstract describing your help volume goes here.
               There may be other meta information topics.
            .
            .
            .
      <¥metainfo> 

      <hometopic>  Home Topic Title
                   Help volume introduction goes here ...
           <s1>  Title of First Topic Goes Here
                   Body of the first topic goes here ...
           <s1>  Title of Second Topic
                   Body of the second topic goes here ...
                   <s2>  Title of Suptopic
                          Body of the subtopic goes here ...
             .
             .
             .
 
     <glossary>
      The body of the glossary, which contains term definitions, goes here ...
 <¥helpvolume>