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

ソース・ディレクトリの作成

  1. ヘルプ・ファイルを作成および処理する helpfiles という名前のディレクトリを作成します。

  2. 作成したばかりのディレクトリに Commands という名前のテキスト・ファイルを作成します。

    この例では、すべての情報は単一のファイルに格納されます。通常、ヘルプを記述しているシステムやアプリケーションについて完全に説明するためには複数のファイルを使用します。

    Commands ファイルには、テキストと要素のタグが入っています。< と > (三角括弧) の内側にある要素のタグは、情報の構造を示します。

  3. Commands ファイルに次のマークアップ・テキストを入力します。

      <hometopic>  Command Summary
                             <idx|commands|
    
     Your &product; is capable of the following operations:
    <list bullet>
      * <xref ChannelChange>
      * <xref VolumeUp>
      * <xref VolumeDown>
      * <xref VolumeMute>
     <¥list>
    
     Choose one of the hyperlinks (underlined phrases)
     to find out how to perform that operation.
    
     <s1 id=ChannelChange>  Changing the Channel
                             <idx|channel, changing|
     Speak the command:
     <ex> channel<¥ex>
     followed by a number from one to ninety nine.
     <s1 id=VolumeUp>  Turning Up the Volume
                             <idx|volume, changing|
     Speak the command:
     <ex> volume up<¥ex>
    
     For additional volume, speak the command:
     <ex> more<¥ex>
    
     (See also <xref VolumeDown> )
    
     <s1 id=VolumeDown> Turning Down the Volume
                             <idx|volume, changing|
     Speak the command:
     <ex> volume down<¥ex>
    
     To further reduce the volume, speak the command:
     <ex> more<¥ex>
    
     (See also <xref VolumeUp>  and <xref VolumeMute> )
    
     <s1 id=VolumeMute> Turning Off the Sound
                             <idx|volume, changing|
                             <idx|sound, on/off|
     Speak the command:
     <ex> sound off<¥ex>
    
     To restore the sound, speak the command:
     <ex> sound on<¥ex>
    
     (See also <xref VolumeDown>  and <xref VolumeUp> )
  4. 情報にタイトルを付け、著作権情報と、オンライン・ヘルプに関する他の情報を提供するテキスト・ファイルを作成します。

    この例では、Commands ファイルと同じディレクトリにある Metainfo という名前のファイルに次のテキストが格納されます。

    <metainfo>
          <title> Using the &product;
          <copyright>
          &copy; 1995 Voice Activation Company.  All rights reserved.
          <abstract> Help for Using the &product;.
     <¥metainfo>