Legacy Document

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

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

/ Creating Coachmarks

<Coach Mark>

You can use the <Coach Mark> command to associate a coachmark for display with a particular panel.

<Coach Mark> coachMarkName 

coachMarkName

A text string specifying the name of a defined coachmark.

DESCRIPTION

The <Coach Mark> command associates a coachmark with a particular panel. Apple Guide displays this coachmark when it opens the panel.

The coachMarkName parameter must reference a defined coachmark, that is, a coachmark defined with these commands: <Define Menu Coach>, <Define Item Coach>, <Define Object Coach>, <Define Window Coach>, and <Define AppleScript Coach>.

SPECIAL CONSIDERATIONS

If you use the <Coach Mark> command, it must always appear between the
<Define Panel> and <End Panel> commands.

You can associate one coachmark per panel; if more than one <Coach Mark> command appears in a panel definition, Apple Guide uses the last one encountered.

EXAMPLES

<Define Panel> "creating index markers"
   <Coach Mark> "CoachIndexTool"
   To create index markers, select the index tool.
<End Panel>

SEE ALSO

For information on <Define Menu Coach>, <Define Item Coach>, <Define Object Coach>, <Define Window Coach>, and <Define AppleScript Coach> commands, see page 10-105, page 10-108, page 10-111, page 10-113, and page 10-116, respectively.