We have a lot of great customers and they like to share their ideas with others. This blog post and batch utility was provided by Thomas Tregner, Enterprise Training Engineer at Blackbaud.  

Thanks for sharing Thomas.

Batch File Utility

At Blackbaud, my team uses MadCap Flare to create SDK documentation for our products. Our main TOC and target pair uses runtime merging of other help outputs to create an encompassing output with many subsystems.

Batch File Utility

There are two advantages to this:

  1. The output can be published to one location. But it can be presented in an encompassing fashion or as discrete subject areas depending on whether the link is to the main output or one of the subsystems.
  2. The subsystems can be generated in parallel and merged at the end. This speeds up the build process. The total build time is the build time for the target with the longest build time plus the time for the encompassing target.

The downsides are:

  1. If there are many cross-references across subject areas, the separately generated subsystems can create output topic replications.
  2. The output requires many targets. There are many batch commands for our automated builds.

Targets Everywhere!

To make the second downside a little easier to handle, I created a utility that creates batch files to build targets. As we add new targets, we remove some of the manual process of updating batch files for builds. Here is the utility and a PDF reference for the utility.

Installation Steps:

  1. Install it using the link below
  2. Run the application
  3. Note: You may get some unhanded exceptions upon running the utility, as far as we can tell it is because the existing paths do not exist on your system.  Once you set up the utility they should go away, until then, just click “Continue
  4. Set the “Root Folder” to a folder that contains several Flare projects
  5. Once this is done you should see all of the available targets from the projects in
  6. The “Flare.app Path” should already be set for V8, if not browse to the install directory for the version that you have
  7. Set the “Locations for BAT Files” to the location that you want the batch files to be located
  8. Save the configuration

Links to the installer, demo video, and PDF:

This utility is provided without warranty or guarantee of results, but comments are still welcome!

Thomas Tregner
Enterprise Training Engineer
Blackbaud, Inc.

Standard disclaimer: This utility is provided “as is,” and you use it at your own risk. MadCap Software makes no warranties as to performance or any other warranties whether expressed or implied.  Under no circumstances shall MadCap Software be liable for direct, indirect, special, incidental, or consequential damages resulting from the use, misuse, or inability to use this utility.

About The Author

Jose Sermeno

About 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.

Last Modified: October 17, 2014

This entry was posted in MadCap Flare, Tech Comm, Tips & Tricks. Bookmark the permalink.

Comments

  • Pingback: Batch Files, madbuild.exe, and commands | Flare for Programmers

  • Clyde July 28, 2014 at 12:05 PM

    Hi. Does the util work for the latest version of Flare?

    • Jose Sermeno Jose Sermeno August 11, 2014 at 12:34 PM

      Hi Clyde! This should work for the newest version of Flare as well. I’ve just tested with v10, and when you remap the app info, batch files are created.

      • David June 7, 2017 at 3:58 AM

        Hello Jose,
        can you update the links:
        Installer
        Demo Video (no audio)
        PDF (explains the fields in the UI)

        • David Ferriot David Ferriot June 13, 2017 at 11:42 AM

          We’re sorry, it appears the links to the blog written by Thomas Tregner, Enterprise Training Engineer at Blackbaud, are no longer available.

Have Something to Say?

Your email address will not be published. Required fields are marked *