> MadBlog > Article

Runtime Merging of CHMs

Published on: July 18, 2012

Table of contents
MadCap Software Logo

In Flare V8.1 you can now automerge CHM files at runtime.  This means once you set up the merged files properly and create a "merge.txt file", you will be able to see the entire merged TOC regardless of the entry point into the merged system. If you add or remove CHMs, they will be merged or removed from the help system automatically.

Note: The children cannot be displayed independently because they are looking for the parents TOC

To set it up:

Parent Project:

  1. The Parent Project has to have merging set up using the TOC to point to the Merged CHMs
  2. Open the TOC Properties of each of the Merged CHMs and go to the Advanced Tab.  Make sure to enable: "When merging, replace node with merged TOC"
  3. Compile the Parent project

Child Projects:

  1. Create a ‘merge.txt’ file using notepad
  2. Add the file name of the parent chm as the first item in the file and then add all possible merged chm names to the file, one per line.
    1. Example of the merge.txt used in this sample:
      Parent.chm
      Colors.chm
      Numbers.chm
      Letters.chm
  3. Put the ‘merge.txt’ file in the same folder as the Flare Project file (.flprj)
  4. Compile each child and copy them to the parent project (or merge them in your desired way)

You should be able to add an remove children now without having to recompile the parent. You will have to reload the parent chm to see the changes.

Attached is a sample parent project that includes children that were built using the steps above. Click here to download it: SampleCHMProject

Posted in: MadCap Flare, Tech Comm, Tips & Tricks


Jose Sermeno

With over 10 years of experience in the software industry, Mr. Sermeno brings a wealth of knowledge and expertise to the product evangelist team, helping introduce new users to everything MadCap Software. In his spare time, Jose is the Project Director for San Diego City Robotics, the San Diego community college systems robotics program, and enjoys working in software design and open source hardware development. Prior to joining MadCap in late 2010, Jose ran a Drupal development shop, and was an application manager for Temple University Health System.

Try for Free

See it in your own workflow. Start a free trial and build your first project today.

lightbulb icon

Have a suggestion for a blog article? Submit it here