#### 18.11.1 Inserting CSH destinations in your document

To insert CSH destinations in your DITA document, use PI markers.

Markers provide the only way to insert mid-topic CSH destinations.

To provide a CSH destination with a marker:

1. Place a TopicAlias PI marker in the text of your document where you want to display context-sensitive help. Markers can be anywhere in the text; a good place is in the topic, after the root and before the title. Each PI marker must be within the material you want presented to the user.
2. Make the content of the PI marker a symbolic ID: a unique name with a prefix you specify in the configuration file; see §18.11.4 Creating an alias file for CSH links.

Mid-topic destinations

Even if you insert the PI marker somewhere in the middle of a topic, clicking the associated button in the application takes the user to the beginning of the topic. However, you can provide mid-topic destinations by setting the following option in the configuration file:

    [MSHtmlHelpOptions]
    ; UseAliasAName= No (default),
    ;  or Yes (to allow midtopic jumps for CSH)
    UseAliasAName=Yes

First CSH link is to start of topic

When UseAliasAName=Yes, every CSH link except the very first goes directly to a mid-topic destination. Because of a defect in HTML Help, the CSH link for the first symbolic ID in your document always takes the user to the beginning of the topic that contains the relevant marker. If this is not acceptable, you can provide a dummy first entry by inserting a TopicAlias PI marker containing a dummy symbolic ID at the start of your DITA document. Also arrange for a dummy link to this destination; see §18.11.3 Specifying and generating a map file for CSH links.

See §18.11.5 Understanding alias-file entries.

Previous Topic: 18.11 Setting up CSH for HTML Help

Next Topic: 18.11.2 Determining whether you need map and alias files

Parent Topic: 18.11 Setting up CSH for HTML Help

Sibling Topics:

18.11.2 Determining whether you need map and alias files

18.11.3 Specifying and generating a map file for CSH links

18.11.4 Creating an alias file for CSH links

18.11.5 Understanding alias-file entries

18.11.6 Producing a list of aliases and associated topic titles

Table of Contents • Index