Allows you to create your own context-sensitive help documents. To use this command, you must first create a view that has a sorted first column containing key values that uniquely identify each help document. @Command([OpenHelpDocument]) searches this sorted view for the specified key value and, if found, displays the associated help document in a separate Help window.

Tip If you use this @command as the formula for the onHelp event for a form, for example, when a user presses <F1> in the context of this form, the custom help document associated with it displays instead of the standard Notes Help database that is usually triggered when a user presses <F1>.

Note This @command is new with Release 5.

Syntax

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

or

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

Parameters

server

Text. The name of the server where the database resides.

Text. Required. The path and file name (in the appropriate format for the operating system) of the database you want to open.

Text. The name of the view you want to open in the database.

Text. Indicates which document you want Notes to scroll to when it opens viewName. The key is a value that appears in the first sorted column of viewName. It can either be a formula or a hard-coded value such as the title of a document.

Keyword. If you supply one of the following keywords instead of server:database values, this @command opens the corresponding Lotus Notes Help files:

[ClientHelp ] opens Lotus Domino Help.

[DesignerHelp] opens Lotus Domino Designer Help.

[AdminHelp] opens Lotus Domino Administration Help.

In the Help database, the column that contains the key must be sorted.

The Help database must be on either a server or in the local data directory. If you do not specify the server name, it defaults to your local data directory.

If you do not specify the database name, it searches within the Help database. For example, in the Notes 6 Client, the search occurs in Lotus Domino 6 Help (HELP6_CLIENT.nsf).

For Web access, this command is useful to create a button to get Help documents.

Note You can also create pages for Help and open them with @Command([OpenPage]).

Example
See Also

@Commands
OpenPage @Command

Glossary