OpenHelpDocument @コマンド (式言語)

独自の状況依存のヘルプ文書を作成できるようにします。このコマンドを使用するにはまず、キー値を含む最初のソート列を表示するビューを作成しなければなりません。このキー値で各ヘルプ文書を一意に識別します。@Command([OpenHelpDocument]) は、ソートされたビューで指定されたキー値を検索し、キー値が一致した場合は対応するヘルプ文書を個別の [ヘルプ] ウィンドウに表示します。

ヒント: この @コマンドをフォームの onHelp イベントの式として使用すると、例えばユーザーがこのフォームのコンテキストで <F1> キーを押した場合に、通常起動される標準の IBM Notes ヘルプデータベースの代わりに、対応するカスタムヘルプ文書が表示されます。
注: この @コマンドは Release 5 で新しく追加されました。

構文

@Command( [OpenHelpDocument]; server : database; viewname; key )

または

@Command( [OpenHelpDocument]; [ HelpDatabase ]; viewname; key )

パラメータ

server

文字列。データベースが置かれたサーバーの名前です。

database

文字列。必須。文字列。必須です。開きたいデータベースのパスとファイル名 (オペレーティングシステムでの適切な形式) です。

viewName

文字列。データベース内の開きたいビューの名前です。

key

文字列。viewName を開くときに、IBM Notes がスクロールして選択する文書を指定します。key は viewName のソートされた最初の列に示される値です。式か、文書のタイトルなどのハードコーディングされた値となります。

[HelpDatabase]

キーワード。server:database 値の代わりに、次のキーワードのいずれかを指定すると、この @コマンドは対応する Notes ヘルプファイルを開きます。

[ClientHelp ] は Domino ヘルプを開きます。

[DesignerHelp] は、Domino Designer ヘルプを開きます。

[AdminHelp] Domino システム管理ヘルプを開きます。

使用法

ヘルプデータベースで、キーを含む列がソートされなければなりません。

ヘルプデータベースはサーバー上かローカルデータディレクトリに存在しなければいけません。サーバー名を省略すると、デフォルトでローカルデータディレクトリになります。

データベース名を省略すると、ヘルプデータベース内で検索されます。例えば、Notes 6 Client では、『Domino 6 ヘルプ』(HELP6_CLIENT.nsf) 内が検索されます。

このコマンドは、Web からのアクセスの場合にヘルプ文書を得るためのボタンの作成に役立ちます。

注: ヘルプ用のページを作成して @Command([OpenPage]) を使用して開くこともできます。

例

  1. 次の式を、ヘルプのラベルを持つビューアクションに追加すると、ユーザーの起動時に特定のヘルプ文書が開きます。customerView の値を含む文書が [ヘルプ] ウィンドウの [about] フィールドに表示されます。myHelpDocs ビューは、非表示ビューで、データベースのカスタムヘルプ文書がすべて含まれます。このビューの最初の列は、[about] フィールドの値を含むソート列です。この式はサーバー、データベースまたはキーワードを指定しないため、OpenHelpDocument は現在のデータベースで指定されたヘルプ文書を検索します。
    @Command([OpenHelpDocument];"";"myHelpDocs";"customerView")
  2. 次の式を、フォーム上のヘルプのラベルが付いたホットスポットボタンに追加すると、カスタムヘルプ文書を表示する [ヘルプ] ウィンドウが表示されます。orderForm の値を含む文書が [Topic] フィールドに表示されます。[Keys] ビューは、非表示ビューで、データベースのカスタムヘルプ文書がすべて含まれます。このビューの最初の列は、[topic] フィールドの値を含むソート列です。この式はサーバー、データベースまたはキーワードを指定しないため、OpenHelpDocument は現在のデータベースで指定されたヘルプ文書を検索します。
    @Command([OpenHelpDocument];"";"Keys";"orderForm")
  3. この式を [Help] ホットスポットボタンに追加すると、『Domino Designer ヘルプ』データベースの式言語ヘルプトピックが個別の [ヘルプ] ウィンドウに表示されます。
    @Command([OpenHelpDocument];[DesignerHelp];"(Help)";"FormulaLanguage")