TableOfContents Element

Publish

Platform_KC
On Premises

Description

TOC Icon
The Table of Contents object, or TOC for short, represents a table of contents in both the printed and online documentation. Including a Table of Contents object in the contents of a Book object automatically creates a table of contents in the printed content and the Contents tab for Help and Web outputs.

The TableOfContents element represents an Author-it Table Of Contents object, and contains all of its properties.

Attributes

Attribute Name

Optional

Data Type

Values

wordcount

Yes

Integer

>= 0

Parent Element

Objects

Children

Element

Optional

Object

No

PrintAddSuperHeadings

Yes

PrintMedia

Yes

PrintPageNumber

Yes

PrintRightAlign

Yes

PrintShowLevel

Yes

PrintTitle

Yes

HelpMultiBookTargets

Yes

HelpTitle

Yes

HelpWindow

Yes

WebContentsType

Yes

WebFrameType

Yes

WebFrameWidth

Yes

WebHHSitemapTemplate

Yes

WebHHTocTemplate

Yes

WebJHTocTemplate

Yes

WebMedia

Yes

WebOHTocTemplate

Yes

WebTitle

Yes

Sample XML

<TableOfContents>
+ <Object>
<PrintAddSuperHeadings>true</PrintAddSuperHeadings>
<PrintMedia>31</PrintMedia>
<PrintPageNumber>true</PrintPageNumber>
<PrintRightAlign>true</PrintRightAlign>
<PrintShowLevel>3</PrintShowLevel>
<PrintTitle>Contents</PrintTitle>
<HelpMultiBookTargets />
<HelpTitle />
<HelpWindow>35</HelpWindow>
<WebContentsType>1</WebContentsType>
<WebFrameType>3</WebFrameType>
<WebFrameWidth>30</WebFrameWidth>
<WebHHSitemapTemplate>..\Templates\HTML Help\toc.hhc</WebHHSitemapTemplate>
<WebHHTocTemplate>Templates\hh_toc.htm</WebHHTocTemplate>
<WebJHTocTemplate>..\Templates_toc.xml</WebJHTocTemplate>
<WebMedia>31</WebMedia>
<WebOHTocTemplate>..\Templates\JavaHelp\jh_toc.xml</WebOHTocTemplate>
<WebTitle>Contents</WebTitle>
</TableOfContents>