Index Element

Publish

Platform_KC
On Premises

Description

The Index element represents an Author-it Index object, and contains all of its properties.

Index Icon
An Index object represents an index in both the printed and online outputs. The index object contains a hierarchical outline list in which the Index Entry objects are arranged to form the structure of the index. When published, the index is based on all headings in the content, any cross-references, and any Index Entry objects that contain objects found in the book being published.

Attributes

Attribute Name

Optional

Data Type

Values

wordcount

Yes

Integer

>= 0

Parent Element

Objects

Children

Element

Optional

Object

No

IndexNodes

Yes

PrintFromEntries

Yes

PrintFromHeadings

Yes

PrintFromLinks

Yes

PrintIndexType

Yes

PrintMedia

Yes

PrintRightAlign

Yes

PrintTitle

Yes

HelpFromEntries

Yes

HelpFromHeadings

Yes

HelpFromLinks

Yes

HelpMultiBookTargets

Yes

WebFromEntries

Yes

WebFromHeadings

Yes

WebFromLinks

Yes

WebHHIndexTemplate

Yes

WebHHSitemapTemplate

Yes

WebIndexType

Yes

WebJHIndexTemplate

Yes

WebMedia

Yes

WebOHIndexTemplate

Yes

WebTitle

Yes

Sample XML

<Index>
+ <Object>
- <IndexNodes>
<Node id="1041" />
- <Node id="470">
- <ChildNodes>
<Node id="471" />
<Node id="472" />
</ChildNodes>
</Node>
<Node id="927" />
<Node id="812" />
</IndexNodes>
<PrintFromEntries inherited="true">true</PrintFromEntries>
<PrintFromHeadings inherited="true">true</PrintFromHeadings>
<PrintFromLinks inherited="true">true</PrintFromLinks>
<PrintIndexType inherited="true">1</PrintIndexType>
<PrintMedia inherited="true">34</PrintMedia>
<PrintRightAlign inherited="true">false</PrintRightAlign>
<PrintTitle inherited="true">Index</PrintTitle>
<HelpFromEntries inherited="true">true</HelpFromEntries>
<HelpFromHeadings inherited="true">true</HelpFromHeadings>
<HelpFromLinks inherited="true">true</HelpFromLinks>
<HelpMultiBookTargets />
<WebFromEntries inherited="true">true</WebFromEntries>
<WebFromHeadings inherited="true">true</WebFromHeadings>
<WebFromLinks inherited="true">true</WebFromLinks>
<WebHHIndexTemplate />
<WebHHSitemapTemplate>Templates\Index.hhk</WebHHSitemapTemplate>
<WebIndexType inherited="true">1</WebIndexType>
<WebJHIndexTemplate inherited="true">Templates\jh_index.xml</WebJHIndexTemplate>
<WebMedia inherited="true">34</WebMedia>
<WebOHIndexTemplate inherited="true">Templates\jh_index.xml</WebOHIndexTemplate>
<WebTitle inherited="true">Index</WebTitle>
</Index>