付録 A: カスタムヘルプファイルを割り当てる

4Dでは各データベースにカスタムヘルプファイルを関連付けることができます。

4Dが提供するヘルプシステムは各4D動作環境 (スタンドアロンデータベースまたはクライアントサーバー、インタープリターまたはコンパイル、4D Volume Desktop統合) で互換性があります。

4Dは2つのヘルプファイルフォーマット、CHMとHTMLをサポートします。これらのフォーマットは業界標準に対応します。

さらにこのヘルプファイルの特定の節をデータベースのフォームに割り当てることができます。

以下のいずれかのフォーマットを利用できます:

• コンパイルされたHTMLフォーマット (“.CHM”拡張子): これはWindows標準のヘルプフォーマットです。CHMファイルはOSに統合されたMicrosoft® HTML Help Executable (HH.EXE) アプリケーションで開かれます。これらのファイルはWindows XPとWindows Vista互換です。
  Microsoft® は無料で HTML Help Workshop アプリケーションを提供しています。このアプリケーションを使用してコンパイルされた .CHM ファイルを生成できます。
• HTMLフォーマット (“.HTM”拡張子): このフォーマットを使用すればすべてのプラットフォームで利用できるヘルプファイルを作成できます。ヘルプはWebブラウザーに表示されます。

ヘルプファイルを生成したら、それをデータベースに関連付け、ユーザーの要求に応じて開かれるようにします (データベースからヘルプを呼び出す参照)。ヘルプファイルをデータベースに関連付けるには:

• ヘルプファイル名はデータベースのストラクチャー名と同じにします。拡張子はフォーマットに応じて“.CHM”または“.HTM”とします。
• ヘルプファイルはストラクチャーファイルと同階層か、データベースストラクチャーファイルと同階層のResourcesフォルダー内に配置します。

4D Server: クライアントマシンからヘルプファイルにアクセスできるようにするには、ヘルプファイルをResourcesフォルダーに配置します。そうすれば自動でファイルがクライアントに転送されます。

プラグインもヘルプファイルを持つことができ、この場合ヘルプファイルをシングルユーザーでもクライアント/サーバーでもPlugInsフォルダーに配置しなければなりません。プラグインのヘルプファイルはプラグインと同じ名前で、拡張子が.CHMまたは.HTMでなければなりません。 フォルダー形式で提供されるプラグインのヘルプファイルは以下の場所に配置します:
- プラグインのプログラムファイルと同じ場所、つまり /Contents/MacOS や /Contents/Windows
- またはプラグインの /Contents/Resources フォルダー

コンポーネントにカスタムヘルプファイルを含めることもできます。詳細はコンポーネントのオンラインヘルプを参照してください。

コンテキストヘルプの作成は、各フォームにセクション番号を指定することで行います。フォームからヘルプを呼び出した場合、対応するページが表示されます。ユーザーがヘルプを呼び出した場合、フォームと同じIDのヘルプトピックが表示されます。

コンテキストヘルプは以下の形式で作成できます:

• WindowsではCHMフォーマット
• WindowsとMac OS両方で使用する場合HTML

フォームへのID番号の割り当てはフォームプロパティで行います。詳細はヘルプを参照してください。

フォームにID番号を割り当てたら、ヘルプファイルに同じ番号を割り当てます。この作業は使用するフォーマットにより異なります:

• CHMファイルの場合、HTML Help Workshop アプリケーションのドキュメントを参照してください。
• HTMLファイルの場合、<a>タグを使用して節を宣言し、番号を割り当てます。
  

  <a name="section">

  
  例えば:
  

   <a name="21">

  
  その節へのURLは以下の形式になります:
  

  <a href="#section">...</a>

  
  例えば:
  

  <a href="#21">...</a>

フォームに指定された節番号が0の場合、またはファイルに対応する箇所が存在しない場合、4Dは最初のページを表示します。

4Dからはデータベースヘルプファイルを以下2つの方法で呼び出せます:

• ヘルプメニューからデータベース名ヘルプを選択する。この場合ヘルプの最初のページが表示されます。
• アプリケーションモードでフォームが表示されているときにF1 キーを押す。この場合、ヘルプトピック番号が指定されていれば、対応するページが表示されます。そうでない場合最初のページが表示されます。

注: Mac OSではF1キーの動作をカスタマイズ可能です。アプリケーションモードでユーザーがF1キーを押したとき:

• “データベース名.HTM”ファイルがデータベースストラクチャーと同階層にある場合、4Dがヘルプを管理する標準のメカニズムが使用されます。ヘルプファイルがデフォルトブラウザーウィンドウで開かれます。
• そうでない場合、4Dは何も行わず、開発者がイベントを処理できます。つまり完全にカスタマイズされたヘルプシステムを実装することができます。