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

ヘルプ・ファミリを作成するには

  1. プロダクトに独自のファイル名を付けます。ヘルプ・ファミリのファイルだと識別できるように拡張子 .hf を使用します。

       
    family.hf 
  2. 次の行をファイルに入力します。

       *.charSet:      character-set
    *.title:        family title
    *.bitmap:       icon file
    *.abstract:     family abstract
    *.volumes:      volume volume volume ... 
    

    character-set は、family title 文字列と family abstract 文字列が使用する文字セットです。サポートされている文字セットのリストについては、「フォント・スキーマの理解」を参照してください。family titlefamily abstract にはヘルプタグ・マークアップを指定できません。このファイルはヘルプタグ・ソフトウェアでは処理されません

    icon file はオプションです。指定する場合、ファイルの位置を指定するのに使用するパスは絶対パス名でなければなりません。アイコンを付けない場合は、ファミリ・ファイルに *.bitmap リソースを指定しないでください。

    volume 名のリストは、そのファミリにどのボリュームが属すのかを識別します。ボリュームは、この行に表示される順番にリストされます。1 つのボリュームが複数のファミリにリストされることもあります。

    いずれかの値が 1 行を超える場合、最後の行以外の各行を ¥ で終わらせます。

    ファイル内で ! (感嘆符) で始まる行はコメント行であり、無視されます。

  3. 最終的なプロダクトを準備するとき、family.hf ファイルと残りのヘルプ・ファイルをインストールしてください。デスクトップ統合スクリプト (dtappintegrate) は、実行されるとファミリ・ファイルへのシンボリック・リンクを作成します。

    dtappintegrate スクリプトの実行方法は、『Solaris 共通デスクトップ環境 上級ユーザ及びシステム管理者ガイド』に説明されています。

次の例は、デスクトップのオンライン・ヘルプ用のファミリ・ファイルです。ファイルの最初にあるコメントで、ファミリとリリース・バージョンが識別できます。

!##############################################
!#                                            #
!#          Desktop  Help Family              #
!#                                            #
!#                 Version 1.0                #
!#                                            #
!##############################################
*.charSet:      ISO-8859-1
*.title:        Desktop Version 1.0
*.bitmap:       /usr/dt/appconfig/help/C/cdelogo.pm
*.abstract:     Overview and Basic Desktop Skills ¥ 
                * File Manager and the Desktop ¥ 
                * Front Panel ¥ 
                * Application Manager ¥ 
                * Style Manager ¥ 
                * Text Editor ¥ 
                * Mailer

*.volumes: Intromgr.sdl Filemgr.sdl FPanel.sdl
           Appmanager.sdl Stylemgr.sdl
           Textedit.sdl Mailer.sdl

実際にデスクトップ・ソフトウェアに指定されているヘルプ・ファミリは、この図のとおりではありません。

関連項目