アプリケーションの状況依存ヘルプを作成する

操作状況に応じたアプリケーション用のヘルプ文書やヘルプページを作成して、それをユーザーが [F1] キーなどのキー入力や [ヘルプ] ボタンのクリックで開けるようにできます。ヘルプ文書やページをアプリケーションのページ、フォーム、サブフォーム、ビュー、フォルダにそれぞれ関連付けることができます。

ある設計要素に関連付けたヘルプを作成すると、その設計要素にそれまで存在していた状況依存ヘルプは、新たに作成した式に上書きされます。この機能はダイアログボックスやメニュー項目の状況依存ヘルプには適用されません。

Notes® アプリケーションの状況依存ヘルプを作成するときは、ページ、フォーム、サブフォーム、ビュー、フォルダの [HelpRequest] イベントに式を書き込みます。 @コマンド式 @Command([OpenHelpDocument]) を式に使用すると、設計要素がアクティブなときにヘルプを要求すると、ヘルプ文書が開くように指定できます。@helpCommand([OpenPage]) を使用して、文書ではなくページを開くこともできます。

Web サーバーを介してアプリケーションを提供しているときには [HelpRequest] イベントを利用することができませんが、設計要素やプログラムに @Command([OpenHelpDocument]) または @Command([OpenPage]) の式を使用したボタンを作成することができます。ユーザーが [ヘルプ] ボタンをクリックすると、関連ヘルプ文書やページを表示できます。

[HelpRequest] イベントは式を受け入れるため、これらの方法以外でも式言語を使用してヘルプを提供できます。例えば、@If 式を @IsDocBeingEdited と合わせて使用すると、文書が読み込み中か編集中かによって、また、その他のアプリケーション固有の条件に従って、フォームに別のヘルプを提供できます。ダイアログボックスを表示すると、ユーザーが複数のヘルプ文書やページから選択できるようになります。ヘルプの内容を直接フォームやページに配置し、段落ごとに非表示式を設定すると、ユーザーがヘルプを要求した際に [HelpRequest] イベントの式で文書フィールドの値を変えて内容を表示できます。

注: ヘルプ要求に応じて別々のヘルプ文書を開くときは、これらの文書を含むビューが必要です。このビューでは文書が @Command([OpenHelpDocument]) のパラメータとして使用できるキーフィールドを基準にソートされている必要があります。@Command([OpenPage]) は指定のビューまたはキーフィールドがなくても使用できます。

式内で @Command([OpenHelpDocument]) または @Command([OpenPage]) を使用する場合の構文と使用方法については、『Domino Designer プログラミングガイド』を参照してください。