#### 16.4.2 Including contents entries in HTML-based Help

Headings that start topics are automatically included as contents entries in HTML-based Help. A paragraph format is included in contents when you assign any of the following to the format:

[HTMLParaStyles]
ParaFmt = Split

[HTMLParaStyles]
ParaFmt = Contents

[HelpContentsLevels]
ParaFmt = n

Avoid mid-topic links from TOC

It is best to assign the [HTMLParaStyles]Split property to every heading that you want to appear in the contents; see §27.3.1 Designating split points. Contents links to mid-topic locations can be problematic in some Help systems. For example, you cannot include mid-topic links in the TOC for HTML Help projects that are to be merged. In Java Help 1, the viewer cannot find mid-topic links at all.

Splitting on every heading provides faster loading of help topics, because they are shorter.

Include modified titles in the TOC

To use titles as modified by PI markers or by macros:

[MSHtmlHelpOptions] or [JavaHelpOptions] or [OmniHelpOptions]
; UseNavtitleMarkers = No (default, use literal topic titles,
; or Yes (use titles as modified by title marker and macros
UseNavtitleMarkers = Yes

When UseNavtitleMarkers=Yes, DITA2Go includes in the TOC the <navtitle> element, if present, or the result of any macro you have specified for the title. See §14.3.4 Including navigation titles from maps in the TOC.

When UseNavtitleMarkers=No, DITA2Go includes in the TOC the titles present in topics or in <topichead> elements, without modification. So, for example, if you use a macro to add a product name to all the titles, that name does not have to clutter the TOC.

See also:

§16.4.3 Setting contents levels for HTML-based Help

§18.9.5 Configuring contents entries for HTML Help

§19.7 Configuring contents and index for OmniHelp

§20.4.1 Configuring contents entries for JavaHelp or Oracle Help

Previous Topic: 16.4.1 Setting contents levels for WinHelp

Next Topic: 16.4.3 Setting contents levels for HTML-based Help

Parent Topic: 16.4 Configuring contents entries for Help systems

Sibling Topics:

16.4.1 Setting contents levels for WinHelp

16.4.3 Setting contents levels for HTML-based Help

Table of Contents • Index