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

<Delete Index>

You can use the <Delete Index> command to specify that an index term defined in a main guide file should not be displayed if the main guide file is mixed in with your Mixin guide file.

<Delete Index> indexTerm

indexTerm

A text string specifying the index term that should not be displayed when the mixin is mixed in with the main guide file.

DESCRIPTION

If a Mixin guide file includes a <Delete Index> command, when Apple Guide mixes in the main guide file with the mixin, the index term specified by the indexTerm parameter will not be shown in the list of index terms when Index is active. If the main guide file is not mixed in with the Mixin guide file, the index term is shown in the list.

SPECIAL CONSIDERATIONS

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

EXAMPLES

#do not show this index term if the main guide file is 
# mixed in with this guide file
<Delete Index> "printer drivers"

SEE ALSO

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