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

You can use the <Delete Topic Area Header> command to specify that a header associated with a topic area defined in a main guide file should not be displayed if the main guide file is mixed in with your Mixin guide file.

<Delete Topic Area Header> topicArea,  topicAreaHeader

topicArea

A text string specifying the topic area associated with the header.

topicAreaHeader

A text string specifying the header that should not be displayed when the Mixin guide file is mixed in with the main guide file.

DESCRIPTION

If a Mixin guide file includes a <Delete Topic Area Header> command, when Apple Guide mixes in the main guide file with the Mixin guide file, the topic area header specified by the topicAreaHeader parameter will not be displayed. If the main guide file is not mixed in with the Mixin guide file, the topic area header is displayed.

SPECIAL CONSIDERATIONS

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

EXAMPLES

#do not show this header if the main guide file is mixed in
# with this guide file
<Delete Topic Area Header> "Printing", "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.