6.8 ファンクション・ヘルプ・テキスト

ヘルプ・テキストとは、アプリケーションが(ヘルプキーまたは同等の要求を使用して)ヘルプを要求した場合に、ユーザーに表示される情報のことです。ファンクション用のヘルプ・テキストはLANSAリポジトリに保管されます。このヘルプ・テキストは、ファンクションが実行されると、ファンクション・レベルのコンテキスト依存ヘルプ・テキストとして自動的に使用できます。「プロセス・ヘルプ・テキスト」にアクセスすることもできます。ヘルプ・テキストは、区画に指定された各言語で入力することができます。

ヘルプ・テキストには、一般に以下の特性があります。

書き方は自由です。ヘルプ・テキストの内容や形式には、通常制限はありません。
ヘルプが要求された際に、そのヘルプはユーザーが行っていた操作に直接関連します。通常、ユーザーが使用しているプロセスまたはファンクションについての詳細が説明されます。
ヘルプ・テキストには特殊な「ヘルプ・テキストの拡張&代替値」を含めることもできます。

LANSAは、アプリケーション内のヘルプ・プロセスの処理を自動的にコントロールします。LANSAは、必要なヘルプのタイプ(フィールド、コンポーネント、プロセス、またはファンクション)を自動的に判定して、(存在する場合は)関連するヘルプ・テキストを自動的に表示します。

LANSAは、プロセスまたはファンクションに関連した自由形式のヘルプ・テキストを自動的には作成しません。LANSAは、リポジトリとリポジトリに含まれた規則からフィールドに関連するヘルプ・テキストを動的に正しい言語で作成することができます。この自動のフィールド・レベルのヘルプ・テキスト機能をグローバル、またはフィールドごとにオフにすることができます。さらに、ユーザー独自のテキストをその前に表示させることもできます。