To provide CSH when Mif2Go generates Help files for your project:
1. Give each target topic
a newlink marker that contains a symbolic ID.
In your FrameMaker document, insert a hypertext newlink
marker in each topic that will be the target of a call
from the application program. The content of the marker is the symbolic
ID for the topic. Insert a separate newlink
marker with a unique symbolic ID for each call from
the application. Put the marker at the start of the text you want displayed.
To insert a newlink marker, see §34.1.2 Using markers to add links and instructions.
2. Create or obtain a map file (possibly except JavaHelp and Oracle Help for Java; see §11.12 Setting up CSH for JavaHelp or Oracle Help).
3. Specify prefixes that identify CSH links
(HTML Help or OmniHelp).
List topic-name prefixes in the configuration file, to identify newlink markers intended for CSH use. If you do not specify
any prefixes, all newlink markers are included.
4. Map the appropriate application-provided
number to each symbolic ID.
For C/C++ applications, usually the developer provides a map file. If
not, for WinHelp or HTML Help you can use a simple syntax described in
the Help provided for those Help systems. Otherwise, for each Help call
in the program, add a line of the following form to the map file:
#define symbolic_ID numeric_ID
You cannot map multiple numeric IDs to the same symbolic ID; each entry in the map file must specify a different symbolic ID. If you need CSH links to the same Help topic from more than one point in the application, include in the topic a separate newlink marker with a unique symbolic ID for each such Help call.
5. Add a map-file entry
to the Help project file (WinHelp or HTML Help).
In the [MAP] section of the Help project file
(MyDoc.hpj
or MyDoc.hhp),
add a line of the following form to identify the map file:
Mif2Go creates a CSH link destination from each newlink marker whose name starts with one of the prefixes you specified in Step 3, or all the newlink markers if you did not specify any prefixes. Make sure the symbolic IDs in the newlink markers are spelled the same way as in the map file.
By default, Mif2Go removes punctuation and spaces from the newlink marker content. If your HTML-based Help system requires CSH IDs that use characters such as periods, set the following option:
; UseRawNewlinks = No (default, remove punctuation, spaces)