HELPREGISTER

HELPREGISTER

Registers help files to display in the main SAS window Help menu

Default: none

Valid in: configuration file, SAS invocation

Windows specifics: all

Syntax
Details
Examples
	Example 1: HTML Help Files
	Example 2: CHM Help Files
	Example 3: HLP WinHelp Files

Syntax

-HELPREGISTER "menu string"path <"help string"> <topic><CHM | HLP | HTML>

"menu string": is the text string that appears in the Help menu.
path: specifies the directory path and filename in which the help file is located. Path must be a valid Windows path. The path may be truncated with !sasroot or helploc://.
help string: is the text that appears in the status line when a user places the mouse over the menu string.
topic: is the topic within the help file that displays when you select menu string from the SAS System help menu. For HTML files, the topic is the anchor (preceded with #) within the document. For CHM files, the topic is the page within the CHM file. For HLP files, topic is the keyword in the file for which WinHelp searches.
CHM: specifies an HtmlHelp CHM file on the local system or network.
HLP: specifies a WinHelp file on the local system or network.
HTML: specifies an HTML file on the local file system or network, or a valid URL.

Details

Use the HELPREGISTER system option to use a help file you would like available from the main SAS window Help menu. All strings containing spaces must be enclosed in double quotation marks. Optional arguments may be omitted by replacing them with a single period (.) or emply double quotation marks ("") . If no further argument is necessary, no place-holder is required.

Examples

Example 1: HTML Help Files

sas -helpregister "SAS Institute Inc" www.sas.com "
    SAS's homepage on the web . html

sas -helpregister "Local HTML Doc" c:\mypage.htm 
    "My own help" "#middle"

Example 2: CHM Help Files

sas -helpregister "My CHM file" \\server\share\HelpStuff.chm . 
    "InternalFile.htm"

sas -helpregister "SAS Windows Companion" helploc://host.chm . 
    "\host.hlp\chostfutil.htm"

Example 3: HLP WinHelp Files

sas -helpregister "A WinHelp File" c:\somefile.hlp 
    "simply an .hlp file"

sas -helpregister "WinHelp with a Topic" c:\somefile.hlp . 
    "My Topic"

Chapter Contents
Previous
Next
Top of Page

Default:	none
Valid in:	configuration file, SAS invocation
Windows specifics:	all