ヘルプファイルは、アプリケーション機能に関するオンライン情報を提供します。
アプリケーションの構成に関する一般情報をエンドユーザーが必要とする場合、アプリケーションから呼び出すことができるヘルプテキストが必要です。
例えば、入力フィールドコントロールに入力できる特定の情報をエンドユーザーが必要とする場合、入力フィールドコントロールからアクセスできる短文テキストが必要です。
さまざまなヘルプセクションすべての概要をアプリケーションに維持するため、Natural にはヘルプオーガナイザが用意されています。 このオーガナイザを使用すると、次の操作を実行できます。
ヘルプ ID（HELP-ID 属性値）を特定のダイアログエレメントに割り当てる。
このヘルプトピックのヘルプテキストを作成する。このテキストは .rtf ファイルに変換され、ヘルプコンパイラで処理されます。
ヘルプトピックのキーワードを定義する（オプション）。
ヘルプコンパイラマクロをヘルプトピックに割り当てる（オプション）。
オプションとして、内部ドキュメンテーション用のコメントを追加する。
1 つのアプリケーションに複数のヘルプファイルを使用することもできます。 この場合、ダイアログの属性ウィンドウでヘルプファイルを指定する必要があります。 また、同じヘルプファイルを複数のダイアログに使用することもできます。
ヘルプオーガナイザで作成された .rtf ファイルおよび対応するヘルプトピック情報は、.hlp ファイルに変換する必要があります。 これにより、エンドユーザーは Natural アプリケーションからヘルプ情報を取得できるようになります。 .hlp ファイルへの変換は、ヘルプコンパイラで行われます。
Natural のインストール手順では、Microsoft ヘルプコンパイラのバージョンもディスクにインストールされます。 ヘルプコンパイラは、HCn（n は Natural がインストールされているオペレーティングシステムによって異なる）と呼ばれる drive-letter:\Program Files\Software AG\product-acronym\version-number\Natural のサブディレクトリに存在します。
ヘルプコンパイラの使用方法および .rtf ファイルから .hlp ファイルを作成する方法の詳細については、このディレクトリの READn.TXT ファイル（n はオペレーティングシステムによって異なる）を参照してください。
ヘルプオーガナイザで生成された小規模なヘルプファイルの例もあります。
このヘルプファイルの例は BROWHLP.HLP と呼ばれ、ライブラリ SYSEXEVT のリソースディレクトリにあります。 ファイル BROWHLP.RTF、BROWHLP.HPJ、および README.TXT は、次のディレクトリにあります。
drive-letter\Program Files\Software AG\product-acronym\version-number\Natural\Samples\sysexevt\help
ヘルプファイルの例のデモを表示するには
ライブラリ SYSEXEVT に進みます。
このライブラリには、BROWSE1 というダイアログが存在するブラウズアプリケーションが含まれています。
SAG-DEMO-DB データベースを開始します。 これは、ブラウズアプリケーションを実行するための前提条件となります。
ダイアログ BROWSE1 を開始して、アプリケーションを実行します。
アプリケーションのさまざまな要素にフォーカスを置いて F1 キーを押します。
ヘルプオーガナイザのデモを見るには（BROWHLP.RTF の内容を見る）
README.TXT ファイルの手順に従います。
作成するヘルプトピックごとに使用できる一般手順
ヘルプオーガナイザのメインダイアログを起動する。
ダイアログエレメントを選択します。
新しいヘルプトピック ID を生成するか、任意の ID を入力します。 ヘルプトピック ID を自動生成するには、ヘルプ ID を "0"（デフォルト）にする必要があります。 ヘルプトピック ID を入力するには、ダイアログまたはダイアログエレメントの［ヘルプ ID］エントリに値を入力するか、または［オンラインヘルプオーガナイザー］メインダイアログでヘルプトピック ID を入力します。
［オンラインヘルプオーガナイザー］ダイアログに戻ります。
ヘルプトピック ID を割り当てます。
ヘルプテキストやトピックなど、ヘルプトピック ID の外部定義を入力します。
［オンラインヘルプオーガナイザー］ダイアログに戻ります。
トピックリストに移動し、この新しいヘルプトピックが作成するヘルプファイルの一般的な編成に適しているかどうかを確認します。
［オンラインヘルプオーガナイザー］ダイアログに戻ります。
すべてを保存します。
上記のステップは、次のセクションで詳しく説明します。
［オンラインヘルプオーガナイザー］ダイアログを呼び出すには
メニューから、を選択します。
または:
Ctrl + Alt + H キーを押します。
メインダイアログが表示されます。 以下が含まれています。
| エントリ | 説明 |
|---|---|
| テキスト | オンラインヘルプオーガナイザ - pathname（ヘルプトピックテキストから生成される .rtf ファイルの場所）。 |
| ダイアログ中のヘルプ ID | 現在のダイアログの名前。 ダイアログごとにヘルプ ID を編成します。 |
| コントロール名 | ダイアログ内でのすべてのダイアログエレメントのハンドル名。
ここでは、これらのハンドル名を変更できません。 |
| ヘルプ ID | ダイアログまたはダイアログエレメントのヘルプ ID の属性値。 複数のヘルプ ID の値を 1 つのダイアログエレメントに割り当てることができます。 複数のヘルプ ID が存在する場合、ドロップダウンリストボックスをプルダウンして表示することができます。 ヘルプ ID を選択すると、その定義を拡張するか、または任意の新しいヘルプ ID を入力できます。 |
| トピック | ヘルプトピックの名前。 ここでは、この名前を編集できませんが、ヘルプトピックの拡張定義ダイアログボックスで編集できます。 |
| ヘルプテキスト | ヘルプテキスト。 ここでは、このテキストを編集できませんが、ヘルプトピックの拡張定義ダイアログボックスで編集できます。
ヘルプテキストが "{\" で開始し、"}" で終了している場合、RTF フォーマットコマンドを入力できます。 これは "raw mode" を示しています。 raw mode では、特殊な RTF 文字（'{'、'}' および '\'）をリテラル文字として処理するには、先行するバックスラッシュを指定してエスケープする必要があります。 ただし、raw mode であっても、改行（\line）コマンドを明示的に入力する必要はありません。 |
| 操作： | |
| 新規 ID... | ヘルプ ID に "0"（デフォルト）が指定されているダイアログまたはダイアログエレメントに対して、ヘルプ ID を生成できる［ヘルプ ID の生成］ダイアログを呼び出します。 |
| 拡張定義... | ［拡張定義 - (...)］ダイアログを呼び出します。 |
| クリア | 現在選択されているヘルプ ID をゼロにリセットし、ヘルプ ID に関連付けられていたヘルプトピックテキストをクリアします。 |
| トピックリスト | ［グローバルトピックリスト］ダイアログを呼び出します。 |
| OK | 設定を保存し、ダイアログを終了して、必要なヘルプファイルを生成します。 生成されるファイルには、helpfilename.rtf ヘルプトピックファイル、helpfilename.hpj ヘルププロジェクトファイル、helpfilename.cnt コンテンツファイル、helpfilename.hm ヘルプ ID マッピングファイル、および helpfilename.cshelp.cnt コンテンツインクルードファイルがあります。
ヘルププロジェクトファイルおよびコンテンツファイルについては、（テキストエディタなどを使用して）直接加えた変更が失われないようにするため、これらのファイルが存在していない場合にのみ生成されます。 |
| 適用 | ダイアログを終了せずに設定を保存し、ヘルプファイルを生成します（プッシュボタンの場合と同様）。 ヘルプオーガナイザを終了してから再び呼び出さなくても、変更を保存し、ヘルプコンパイラとの間を切り替えることができます。 |
| キャンセル | 設定を保存せずにダイアログを終了します。 |
| ヘルプ | ダイアログにオンラインヘルプを設定します。 |
［オンラインヘルプオーガナイザ］ダイアログは、サイズ変更ができます。 位置と次元がユーザープロファイル（.PRU）内のセッション間に保存されます。
新しいヘルプトピック ID を生成するには
［ヘルプオーガナイザ］メインダイアログから、ダイアログまたはダイアログエレメントを選択し、ボタンを選択します。
［ヘルプ ID の生成］ダイアログが表示されます。
（オプション）次の新しい ID を生成するために Natural で使用される開始値を入力します。
このヘルプ ID は、現在のダイアログに対してのみ有効です。 同じ Natural アプリケーションでヘルプ ID の重複を避けるため、ダイアログのヘルプトピック ID には排他的な数値範囲を定義します。 開始値を使用すると、数値範囲の最初からヘルプ ID を開始することができます。 例えば、ダイアログに 50～60 の範囲を使用するとします。 開始値として「50」を入力すると、最初に生成される ID は 50 になります。
を選択して、ヘルプ ID を生成します。
または:
を選択して、生成せずにダイアログを終了します。
注意:
複数のダイアログ／ダイアログエレメントのヘルプ ID をまとめて生成することもできます。 これには、［オンラインヘルプオーガナイザ］ダイアログで複数のダイアログ／ダイアログエレメントを選択する必要があります。 使用可能な最小の ID から開始して、ID が順番に生成されます。
ヘルプトピック ID の定義を拡張するには
［ヘルプオーガナイザ］メインダイアログから、ヘルプ ID を選択し、ボタンを選択します。
［拡張定義］ダイアログが表示されます。 以下が含まれています。
| エントリ | 説明 |
|---|---|
| テキスト | 拡張定義 - [current HELP-ID] |
| トピック： | ヘルプトピックの見出しをここに入力します。 |
| ヘルプテキスト： | ヘルプトピックのテキストをここに入力します。 |
| キーワード： | ヘルプトピックのキーワードをここに入力します。 キーワードを使用すると、Natural アプリケーションのエンドユーザーが［ヘルプ］ウィンドウでボタンを選択して、トピックを検索できるようになります。 |
| ブラウズ順： | 参照順序をここに入力します。 ヘルプトピックを主題によってグループ化する場合、参照順序は便利です。 参照順序には、オプションの英数字ソートキーを、参照順序名からコロンで区切って含めることもできます（mysequence:sort_key など）。 |
| マクロ： | ヘルプマクロ名をここに入力します。 ヘルプマクロを使用すると、ヘルプをカスタマイズできるようになります。 |
| コメント： | このセクションはヘルププロジェクトの内部ドキュメンテーション用です。 |
| OK | 設定を保存して、ダイアログを終了します。 |
| キャンセル | 設定を保存せずにダイアログを終了します。 |
| ヘルプ | ダイアログにオンラインヘルプを設定します。 |
この情報は、生成される .rtf ファイルの一部であり、ヘルプコンパイラによって解釈されます。
［拡張定義］ダイアログは、サイズ変更ができます。 位置と次元がユーザープロファイル（.PRU）内のセッション間に保存されます。
グローバルトピックリストを編集するには
［ヘルプオーガナイザ］メインダイアログから、ボタンを選択します。
［グローバルトピックリスト］ダイアログが表示されます。 以下が含まれています。
| エントリ | 説明 |
|---|---|
| テキスト | グローバルトピックリスト - [File: selectedfilepath] |
| ブラウズ | テーブルの各行はヘルプトピックを表します。 ヘルプ ID、トピック名、およびそれに関連する拡張定義が表示されます。 |
| 操作： | |
| 元に戻す | 最後の編集操作、特に削除を元に戻します。 |
| 削除 | ヘルプトピックが選択済みの場合、このトピックは削除されます。 |
| 拡張定義... | 選択されたヘルプトピックの［拡張定義］ダイアログを呼び出します。 |
| 移動 | ヘルプトピックエントリの順番を変更できます。 |
| 上へ | 選択されたヘルプトピックを、ヘルプトピックエントリの参照順序内で上に移動します。 |
| 下へ | 選択されたヘルプトピックを、ヘルプトピックエントリの参照順序内で下に移動します。 |
| OK | 設定を保存して、ダイアログを終了します。 |
| キャンセル | 設定を保存せずにダイアログを終了します。 |
| ヘルプ | ダイアログにオンラインヘルプを設定します。 |
このリストには、ヘルプファイルのすべてのトピックが含まれています。 トピックは、常に参照順序で管理されることに注意してください。
［グローバルトピックリスト］ダイアログは、サイズ変更ができます。 位置と次元がユーザープロファイル（.PRU）内のセッション間に保存されます。
