Legacy Document

Inside Macintosh: Apple Guide Complete / Part 4 - Scripting Guide Files

Chapter 10 - Guide Script Command Reference / Guide Script Command Descriptions

/ Defining Index Terms

<Index Instruction>

You can use the <Index Instruction> command to specify a phrase that appears above the list of index terms in the Full Access window when Index is the active list.

<Index Instruction> indexInstruction

indexInstruction

A text string that specifies a phrase to display above the list of index terms.

DESCRIPTION

Apple Guide displays, above the list of index terms, the phrase defined in the indexInstruction parameter.

This command is optional. If you omit this command, Apple Guide displays the phrase, "1. Click an index entry:" above the list of index terms.

To define a phrase that Apple Guide displays above the right column, use the <Topics Instruction> command. You use this command to specify a phrase that appears above the list of topics regardless of whether Topics, Index, or Look For is active.

SPECIAL CONSIDERATIONS

The <Index Instruction> command should appear once at most in your source files for a specific guide file.

EXAMPLES

#specify an index instruction
<Index Instruction> "1. Click an index term:"

SEE ALSO

For information on the <Topics Instruction> command, see page 10-134.