20.12 Setting up CSH for JavaHelp or Oracle Help

For context-sensitive help, you insert symbolic IDs into your DITA files as TopicAlias PI markers, at the appropriate topic start points. DITA2Go puts these IDs in the .jhm map file for you.

By default, DITA2Go removes punctuation and spaces from TopicAlias PI marker content. If you require symbolic IDs for CSH that contain characters such as periods, set the following option:

[HTMLOptions]
; UseRawNewlinks = No (default, remove punctuation, spaces)
;  or Yes (as is)
UseRawNewlinks = Yes

CSH map file: needed?

The way an application calls JavaHelp or Oracle Help determines whether you need a CSH map file; this is up to the application developers. You have to ask the developers how the application calls the Help system:

Non-CSH internal map file

A CSH map file comes from a developer, and relates numeric IDs that are used in the application to symbolic IDs. But JavaHelp and Oracle Help each have an internal map file with extension .jhm, which relates symbolic IDs used in the Help system to locations in the Help files, with different numeric IDs. These two map files and sets of numbers have nothing to do with each other.

See §16.10 Setting up Context Sensitive Help (CSH).

Previous Topic:  20.11 Merging JavaHelp or Oracle Help systems

Next Topic:  21. Generating Eclipse Help

Parent Topic:  20. Generating JavaHelp or Oracle Help

Sibling Topics:

20.1 Deciding which Java Help system to use

20.2 Obtaining tools for a Java-based Help system

20.3 Setting up a JavaHelp or Oracle Help project

20.4 Generating contents and index

20.5 Providing full-text search for JavaHelp / Oracle Help

20.6 Creating and viewing a Java Archive (JAR) file

20.7 Converting a glossary to JavaHelp 2

20.8 Defining windows for JavaHelp or Oracle Help

20.9 Linking to destinations within topics

20.10 Creating ALinks for Oracle Help

20.11 Merging JavaHelp or Oracle Help systems