Legacy Document

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

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

/ Creating Sequences

<Panel>

You can use the <Panel> command to associate a panel with a particular sequence.

<Panel> panelName

panelName

A text string specifying the name of a defined panel.

DESCRIPTION

A sequence definition consists of commands that reference one or more panels. Apple Guide displays panels according to the order in which the panels appear in a sequence definition and according to any conditions attached to each panel.

Note that Apple Guide uses the sequence name (or the optional sequence display title) as the panel's display title, not the string in the panelName parameter.

The panelName parameter must reference a named panel, that is, a panel defined with the <Define Panel> and <End Panel> commands. You can also directly place a panel definition within a sequence definition by using the <Define Panel> and <End Panel> commands. If you often reuse panels or want to see a quick synopsis of a sequence, use <Panel> commands in your sequence definitions. If you prefer to keep the definition of a panel with its sequence, define the panel directly within the sequence.

Note that panel definitions do not have to precede their use in a <Panel> command; they must simply appear somewhere within your source files.

EXAMPLES

#sequence with panels referenced by <Panel> commands
<Define Sequence> "How do I create index markers?"
   <Panel> "index intro"   
   <Panel> "index tool"
   <Panel> "create index"
<End Sequence>
#sequence with panels defined within
<Define Sequence> "How do I create index markers?"
   <Define Panel> "creating index markers"
      To create index markers, select the index tool.
      #more text and commands for this panel here
   <End Panel> 
<End Sequence>

SEE ALSO

For information on the <Define Panel> and <End Panel> commands see page 10-52 and page 10-56, respectively.