Legacy Document

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

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

/ Defining Topics for Topic Areas and Index Terms

<Topics Instruction>

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

<Topics Instruction> topicsInstruction

topicsInstruction

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

DESCRIPTION

Apple Guide displays, above the list of topics, the phrase defined in the topicsInstruction parameter.

This command is optional. If you omit this command, Apple Guide displays the phrase "2. Click a phrase, then click OK:" above the list of topics when Topics or Index is the active list.

SPECIAL CONSIDERATIONS

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

Note that when Look For is the active list and the user has performed a successful search, Apple Guide displays the phrase "3. Click a phrase, then click OK:" above the list of topics; you can change this text using the <Look For Results Instruction> command.

EXAMPLES

#specify a topics instruction
<Topics Instruction> "2. Click an item, then click OK."

SEE ALSO

For information on specifying the instruction that appears above the list of topic areas, see the description of the <Topic Areas Instruction> command on page 10-124. For information on specifying the instruction that appears above the list of index terms, see the description of the <Index Instruction> command on page 10-127.