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 Topic>

You can use the <Insert Index Topic> command to insert a topic from a Mixin guide file and associate this new topic with an existing topic area in a main guide file.

<Insert Index Topic> topic, seqName, indexTerm [, sortOrder]

topic

A text string specifying a new topic.

seqName

A text string specifying the sequence name associated with the new topic.

indexTerm

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

sortOrder

A value specifying where the new topic should appear in the list of topics for the specified topic area. You can use the constant FIRST or LAST to sort the topic at the beginning or end of existing topics for the specified topic area. You can also specify in this parameter a text string of the topic that should immediately precede the new topic. 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 Topic> 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 topic with it and inserts the topic into the list of topics, according to the sort order specified by the sortOrder parameter.

To define a header for a new topic, use the <Insert Index Header> command.

SPECIAL CONSIDERATIONS

The <Insert Index Topic> 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 Topic> command, you must specify a SYM file in the symName parameter of the <Mixin> command.

EXAMPLES

#in a Mixin guide file, specify a new topic for an 
# existing index term in a main guide file
<Insert Index Topic> "use hexadecimal numbers?", \xAC
               "When should I use hexadecimal numbers?", \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.