Legacy Document

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

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

/ Defining Topics for Topic Areas and Index Terms

<Header>

You can use the <Header> command to specify a phrase that appears in the right column (the help topics column) in the Full Access window when Topics or Index is the active list and the user selects the header's associated topic area or index term. You can also use the <Header> command for a Single List Access window.

<Header> headerPhrase 

headerPhrase

A text string that specifies a header to display in the list of topics. Apple Guide displays headers in bold.

DESCRIPTION

Apple Guide displays, in the list of topics, the phrase defined in the headerPhrase parameter. When the user clicks the Topics button, Apple Guide displays the phrases defined by <Topic Area> commands. When the user clicks the Index button, Apple Guide displays in the index terms area the phrases defined by <Index> commands. When the user selects a particular topic area or index term, Apple Guide displays any headers (and topics) associated with the selected topic area or index term. You associate a header with a particular topic area by following either a <Topic Area> or an <Index> command with a <Header> command.

The text specified in the headerPhrase parameter is typically a general header that groups several related topics or that provides a question prefix for several related topics, such as "How do I" or "Why can't I".

Headers are not required. However, if you do define a header for a topic area or index term, all topics for that topic area or index term must be grouped by headers. Alternatively, a topic area or index term can have all single topics associated with it.

Apple Guide places an animated triangle next to any header. When the user clicks the triangle, Apple Guide animates it and expands or compacts the topics under the header.

SPECIAL CONSIDERATIONS

If you define a header for a topic area or index term, all topics for that topic area or index term must be grouped by headers.

EXAMPLES

#specify a topic area 
<Topic Area> "Fonts"
   #specify header and topics for this topic area
   <Header> "How do I"
      <Topic> "change the font of a word?", "SeqFont1"
      <Topic> "change the font of a paragraph?", "SeqFont2"
      <Topic> "change the font of a document?", "SeqFont3"
      <Topic> "change the default font?", "SeqFont4"
   <Header> "Definitions"
      <Topic> "fonts", "DefnsFontsSequence"
#specify a topic area 
<Topic Area> "Index markers"
   #specify header and topics for this topic area
   <Header> "How do I"
      <Topic> "create an index marker?", "CreateIndexMarkerSeq"
      <Topic> "select an index marker?", "SelectIndexMarkerSeq"
      <Topic> "remove an index marker?", "RemoveIndexMarkerSeq"
      <Topic> "generate an index?", "GenerateIndexSequence"

SEE ALSO

For information on the <Index> command, see page 10-128.