Omni Systems, Inc.

  

Mif2Go User's Guide, Version 55

  

Valid HTML 4.01!

 

Made with Mif2Go

11 Generating JavaHelp or Oracle Help > 11.12 Setting up CSH for JavaHelp or Oracle Help


11.12 Setting up CSH for JavaHelp or Oracle Help

For context-sensitive help, you insert symbolic IDs into your FrameMaker files as hypertext newlink markers (see §34.1.2 Using markers to add links and instructions), at the appropriate topic start points. Mif2Go puts these IDs in the .jhm map file for you.

By default, Mif2Go removes punctuation and spaces from newlink 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:

If the developers use numbers, you need a CSH map file, and the developers will supply it. The map file lists a symbolic ID for each numeric ID.

If the developers use names, you do not need a CSH map file; however, the developers must tell you what symbolic IDs they are using, or you must tell them what symbolic IDs to use.

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 §7.10 Setting up Context Sensitive Help (CSH).

 



11 Generating JavaHelp or Oracle Help > 11.12 Setting up CSH for JavaHelp or Oracle Help