Legacy Document

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

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

/ Specifying Default Settings

<Define Prompt Set>

You can use the <Define Prompt Set> command to specify a set of prompts that can appear as navigation prompts on panels.

<Define Prompt Set> promptSetName, promptFirstPanel, 
                   promptMiddlePanel, promptLastPanel, 
                   promptForPanelsWithControls

promptSetName

A string specifying the name of this navigation prompt set. This name must be unique from all other navigation prompt sets that you define.

promptFirstPanel

A string specifying the text for use as the navigation prompt of the first panel in a sequence.

promptMiddlePanel

A string specifying the text for use as the navigation prompt of the middle panel in a sequence.

promptLastPanel

A string specifying the text for use as the navigation prompt of the last panel in a sequence.

promptForPanelsWithControls

A string specifying the text for use as the navigation prompt of panels containing any of these controls: checkboxes, radio buttons, or standard buttons.

DESCRIPTION

The <Define Prompt Set> command defines a set of navigation prompts. You can use this prompt set in panels and can control on which panels the prompts appear by using these commands:

• <Default Prompt Set>, to associate the prompt set with all panels in all sequences
• <Sequence Prompt Set>, to associate the prompt set with all panels in a specific sequence
• <Panel Prompt>, to associate the prompt set with only one specific panel in a sequence

If you provide a <Default Prompt Set> command that specifies a prompt set (other than NONE), Guide Maker allocates space for prompts on all panels and uses the specified prompt strings for each panel by default. You can override the default on a sequence or panel-by-panel basis.

If a sequence definition includes a <Sequence Prompt Set> command that specifies a prompt set (other than NONE), Guide Maker allocates space for prompts on all panels in that sequence by default, and uses the specified prompt strings for each panel in the sequence.

If a panel definition includes a <Panel Prompt> command that specifies a prompt set (other than NONE), Guide Maker allocates space for prompts on that panel and uses the specified prompt strings for that panel.

To specify that Guide Maker should not allocate space for panels, specify NONE as a parameter to the <Default Prompt Set>, <Sequence Prompt Set>, or <Panel Prompt> commands. If you want Guide Maker to allocate space for a prompt on a panel but do not want to provide text in the prompt string, specify the prompt string with at least one blank character, for example, " "; do not specify an empty string.

EXAMPLES

<Define Prompt Set>  "special prompts", \xAC
"Click the right arrow to continue.", \xAC
"Click the left arrow to go back or the right arrow to continue.",\xAC
"That's all, you're done!", \xAC
" "

<Define Panel> "Example Panel 1"
   #this panel doesn't use a prompt set
   <Panel Prompt> NONE 
<End Panel>

<Define Panel> "Example Panel 2"
<End Panel>
<Define Sequence> "Example Sequence 2"
   #this sequence uses the prompt set 
   # defined by "special prompts"
   <Sequence Prompt Set> "special prompts"
   <Panel> "Example Panel 1" #overrides sequence prompt set
   <Panel> "Example Panel 2" #uses sequence prompt set
<End Sequence>

SEE ALSO

For a description of the <Default Prompt Set>, <Sequence Prompt Set>, and <Panel Prompt> commands, see page 10-35, page 10-42, and page 10-55, respectively.