Legacy Document

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

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

/ Specifying the Startup Window

<Startup Window>

You can use the <Startup Window> command to specify the type of window that Apple Guide should display when your guide file is first opened.

<Startup Window> windowType, accessScreenOptions

windowType

A value that indicates whether the access window uses the full, single, or simple (presentation) access method.

You can use one of these constants in the windowType parameter:
FULL
SINGLE
PRESENTATION

The value you choose for this parameter determines the options that can be specified with the next parameter.

accessScreenOptions

A value that specifies the access screen options for the specified window type.

Full Access windows have options that you specify using these constants:
HOWDY
TOPICS
INDEX
LOOKFOR

Single List Access windows have options that you specify using these constants:
HOWDY
TOPICS

Simple Access windows (also called presentation windows) have no other options, although you must specify a string containing the presentation window's sequence name. For example:
"SurfWriter Command-Key Shortcuts Sequence"

DESCRIPTION

When a user opens a guide file, Apple Guide displays the access window of the indicated type and with the specified options, as defined by the guide file's <Startup Window> command.

If your guide file defines Topics, Index, and Look For help, use a Full Access window as your startup window. If you want to present the user with introductory or welcoming text (howdy text), then specify the constant HOWDY. If you specify howdy text, the user can dismiss the howdy text by clicking the Topics, Index, or Look For button. If you do not provide howdy text, then you can specify which help (Topics, Index, or Look For) should initially be active (that is, the text initially displayed in the left column) by using the corresponding constant in the second parameter. Often, you'll want the Topics help to be initially active (so that the text specified by <Topic Area> commands appears in the left column).

If your guide file provides only Topics help, use a Single List Access window as your startup window. If you want to present the user with introductory or welcoming text (howdy text), then specify the constant HOWDY.

If your guide file does not provide Topics, Index, or Look For help, then specify the sequence name of your help content. Apple Guide displays this type of help in a Simple Access (presentation) window.

SPECIAL CONSIDERATIONS

The <Startup Window> command should appear once at most in your source files for a specific guide file. If you omit this command, Apple Guide displays a Full Access window with space for howdy text.

EXAMPLES

#specifies a Full Access window, no howdy text, and 
# with Topics initially active
<Startup Window> FULL, TOPICS

#specifies a Single List Access window with howdy text
<Startup Window> SINGLE, HOWDY

#specifies a presentation window and its sequence name
<Startup Window> PRESENTATION, "SurfWriter ShortCuts 
Sequence"

SEE ALSO

The <Howdy> command is described next.