In modular projects you can create normal links between topics in different modules in almost exactly the same way as between topics within a normal project. You just have to bear in mind that the help file containing the target of the link must be present at runtime (when the help is viewed), otherwise the link will be dead and the user will get an error message.

1.Select the topic in which you want to insert the link:

 Display for a module configured
 for publish time merging

If your child module is configured for runtime merging you cannot edit its topics in the TOC – then you must right-click on the module entry and select Edit Child in the context menu to edit its topics.

2.Proceed as you normally would for inserting a topic hyperlink.

3.In the Hyperlink dialog click on the browse button in the Help File: field and choose the project or published help file containing the topic you want to link to. (It is always preferable to choose a project rather than a compiled help file if possible.)

Never try to create links between different output formats. This will not work!

4.If you choose a project (.hmxz, .hmxp) or HTML Help (.chm) file the topic IDs of the external project or help file will now be displayed in the Topic ID list. Choose the topic (and anchor if applicable) you want to link to and click on OK.

5.Remember that this link depends on the presence of the target help file. If there is any chance that the target file may not be there at runtime don't link to it. Or use conditional text tags to create alternative links for your different help file configurations.

When using runtime merging it is advisable to define a global "window name" for all the projects in the modular help system. This improves the performance of links to your help from your applications. When you define a global help window, all calls to the help system will open in the same CHM help viewer. Without a global window, you will get additional help viewers opening when calls are made first to one module and then to another.

The global help window option is set in Configuration > Publishing Options > Microsoft HTML Help > Help Windows. You need to set the same global window name in all projects in the modular help system, including the master project.

If you use this option the global help window name must begin with $global_, followed by an identifier consisting only of alphabetic characters. You must use the same global name in all the projects.

Examples of valid global window names:

$global_main_mycompany
$global_widgethelp

Important – make sure your window name is unique!

Don't use the standard $global_main name! If you do it is quite possible that some other software on the user's computer will also be using that name and then your help could open in their help window!