Merged Help

There are various reasons for creating a merged project setup.

  • You are writing content for modular software and you only want the installed help to cover what has been installed. You would write the help for the modules in separate projects. Then you can merge the required combination of projects for each installation.
  • You have a large number of topics overall. By writing parts into different projects, you can see things more clearly.
  • You have more than one author but do not use source control. Merged help enables each author to have part of the total output in a separate project.

Key Points

Generating

The parent project only needs to be generated first when you generate the merge the first time and when you add or remove the projects to be merged.

Child outputs only need to be generated when they change.

Parent/Child Links

If you need parent/child links they still need to be configured manually to avoid breaks in the output but you can now avoid them by having all your content in child projects so that the parent is effectively just a shell. The child projects are defined in the parent TOC and the skin for the parent will be applied to the whole merge. In the child project you need to define a skin so that you can generate an output but it does not need to be customised in the same way as the parent, unless you will also need to generate the child as a standalone output.

In Classic versions to avoid having content in the parent it is necessary to add a script so that the default topic could be a topic from a child project. In Adobe RoboHelp you can select a child project in the preset and that child's default topic will be the default for the merge.

You can of course have content in the parent by including it in the parent TOC. However, it is recommended that if you do, then avoid links in either direction between parent/child topics. If they are essential for some reason, then do test them carefully in the output.

Using Child Projects Standalone

With the exception of Merged CHMs, child outputs cannot be copied to another location and used standalone. Instead duplicate the preset in the child project and change the output path to a location outside the merge output.

How to Merge Projects

How to merge projects is explained in the main part of my site.

Donations

If you find the information and tutorials on my site save you time figuring it out for yourself and help improve what you produce, please consider making a small donation.