HELPINDEX System Option: Windows

Specifies one or more index files for the SAS Help and Documentation.

Valid in: configuration file, SAS invocation
Category: Environment Control: Help
PROC OPTIONS GROUP= HELP
Default: /help/common.hlp/index.txt, /help/common.hlp/keywords.htm, common.hhk
Windows specifics: HTML-HELP-index-pathname
Syntax
Syntax Description
Details
See Also

Syntax

-HELPINDEX <(> "index-pathname-1" < " index-pathname-2" " index-pathname-n")>

Syntax Description

index-pathname

specifies the partial pathname for the index that is to be used by SAS Help and Documentation. index-pathname must be a valid Windows pathname. Pathname must be enclosed in quotation marks. When you specify more than one pathname, separate the pathnames with a space and enclose the list of pathnames in parentheses.

The index-pathname can be any or all of the following:

/help/applet-index-filename

specifies the partial pathname of the index file that is to be used by the SAS Help and Documentation Java applet under a UNIX environment. applet-index-filename must have a file extension of .txt, and it must reside in a path that is specified by the HELPLOC system option. The default is /help/common.hlp/index.txt.

See the default index file for the format that is required for an index file.

/help/accessible-index-filename

specifies the partial pathname of an accessible index file that is to be used by SAS Help and Documentation under UNIX, OpenVMS, or z/OS environments. An accessible index file is an HTML file that can be used by web browsers. accessible-index-filename must have a file extension of .htm and it must reside in a path that is specified by the HELPLOC system option. The default pathname is /help/common.hlp/keywords.htm.

See the default index file for the format that is required for an index file.

HTML-Help-index-pathname

specifies the pathname of the Microsoft HTML Help index that is to be used by SAS Help and Documentation under Windows environments. The default pathname is common.hhk. For information about creating an index for Microsoft HTML Help, see your Microsoft HTML Help documentation.

Details

Use the HELPINDEX option if you have a customized index that you want to use instead of the index that SAS supplies. If you use one configuration file to start SAS under more than one operating environment, you can specify all of the partial pathnames in the HELPINDEX option. The order of the pathnames is not important, although only one pathname of each type can be specified.
When the HELPINDEX option specifies a pathname for UNIX, OpenVMS, or z/OS operating environments, SAS determines the complete path by replacing /help/ in the partial pathname with the pathname that is specified in the HELPLOC option. If the HELPLOC option contains more than one pathname, each path is searched for the specified index.
For example, when the value of HELPINDEX is /help/common.hlp/myindex.htm and the value of HELPLOC is /u/myhome/myhelp, the complete path to the index is /u/myhome/myhelp/common.hlp/myindex.htm.

See Also

HELPLOC System Option: Windows
Copyright © SAS Institute Inc. All Rights Reserved.