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

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

<Delete Index Header> indexTerm, indexHeader

indexTerm

A text string specifying the index term associated with the header.

indexHeader

A text string specifying the header 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 Header> command, when Apple Guide mixes in the main guide file with the mixin, the header specified by the indexHeader parameter will not be shown in the list of headers for the specified index term. If the main guide file is not mixed in with the Mixin guide file, the header is shown in the list.

SPECIAL CONSIDERATIONS

The <Delete 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 <Delete Index Header> 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 Header> "printer drivers", "How do I"

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.