21.4.1 Choosing contents and index methods for Eclipse Help

To direct DITA2Go to generate only contents, or both contents and index, for Eclipse Help:

[EclipseHelpOptions]
; ListType (for filter to create) = Contents (default)
;  or Both (with index, for Eclipse 3.2+)
ListType = Contents

When ListType=Contents (the default), DITA2Go creates only toc.xml.

When ListType=Both, DITA2Go creates both toc.xml and index.xml.

Contents file toc.xml is required for Eclipse Help. Index file index.xml is supported only in Eclipse version 3.2 and later versions.

You can choose how DITA2Go generates data files needed for Eclipse Help contents and index; however, most likely you will never have a reason to change the default setting:

[EclipseHelpOptions]
; RefFileType = Full (default) or Body. 
RefFileType = Full

RefFileType values have the following effects:

Full

Default. DITA2Go creates a toc.xml (and an index.xml file, if ListType=Both) for each original DITA file.

Body

DITA2Go creates DCL .bhc (and .bhk, if ListType=Both) files that are merged later to produce toc.xml and index.xml.

Only Eclipse version 3.2 and later versions support index.xml.

See also:

§16.3.1 Modifying contents or index production for HTML-based Help.

§21.4.3 Configuring contents properties for Eclipse Help

§21.4.4 Configuring index properties for Eclipse Help

Previous Topic:  21.4 Configuring contents and index for Eclipse Help

Next Topic:  21.4.2 Supplying path information for contents and index links

Parent Topic:  21.4 Configuring contents and index for Eclipse Help

Sibling Topics:

21.4.2 Supplying path information for contents and index links

21.4.3 Configuring contents properties for Eclipse Help

21.4.4 Configuring index properties for Eclipse Help