TOC File

Example:

<toc version="1.0">
  <tocitem image="img.toplevelfolder" target="intro"
           text="Introduction to Aviation">
  <tocitem text="Airplane Structure">
      <tocitem target="empennage" text="Empennage"/>
      <tocitem target="fuselage" text="Fuselage"/>
  </tocitem>
</toc>

Tag

Attribute

Required

Description

<toc>

 

Yes

Top-level element, encompassing the entire TOC file. Nested within are <tocitem> elements, which define individual TOC entries.

 

version

No

Version of JavaHelp for which the TOC file is created.

<tocitem>

 

Yes

Specifies an individual TOC entry.

 

target

No

Map ID of a help topic. If you use this attribute, the TOC entry becomes a link to the specified help topic. Omit this attribute for a TOC entry that is just a heading, not a link.

 

text

Yes

Text of the TOC entry, as it appears in the TOC.

 

image

No

Map ID of an icon that is displayed along with the text of the TOC entry.

Get Creating Effective JavaHelp now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.