Legacy Document

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

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

/ Working With Mixin Guide Files

<Insert Index Header>

You can use the <Insert Index Header> command to insert a header from a Mixin guide file and associate this new header with an existing index term in a main guide file.

<Insert Index Header> header, indexTerm [, sortOrder]

header

A text string specifying a new header.

indexTerm

A text string specifying the index term in a main guide file. Apple Guide associates the new header with the specified index term.

sortOrder

A value specifying where the new header should appear in the list of headers for the specified index term. You can use the constant FIRST or LAST to sort the header at the beginning or end of existing headers for the specified index term. You can also specify in this parameter a text string of the header that should immediately precede the new header. This parameter is optional. If you omit it, Apple Guide uses LAST as the default.

DESCRIPTION

When Guide Maker compiles a source file for a Mixin guide file and encounters an <Insert Index Header> command, it looks for an index term specified by the indexTerm parameter in the main guide file. If it finds the index term, it associates the new header with it and inserts the header into the list of headers, according to the sort order specified by the sortOrder parameter.

To define the topics for a new header, use the <Insert Index Topic> command.

SPECIAL CONSIDERATIONS

The <Insert Index Header> command can be used only in the source file for a Mixin guide file that also includes the <Mixin> command. To use the <Insert Index Header> command, you must specify a SYM file in the symName parameter of the <Mixin> command.

EXAMPLES

#in a Mixin guide file, specify a new header for an 
# existing index term in a main guide file
<Insert Index Header> "When should I", \xAC
                     "Math operations", FIRST

SEE ALSO

For information on the <Mixin> command, see page 10-19. For information on the <Index>, <Header>, and <Topic> commands, see page 10-128, page 10-135, and page 10-137, respectively.