Note: This blog post supports MadCap Flare version 9 only. For additional support in later versions, please contact Thomas Tregner’s blog for additional information:

http://tregner.com/flare-blog/create-topics-in-bulk-with-a-plug-in/

Thomas Tregner, a software engineer at Blackbaud, is part of the SDK Documentation and Training Team in User Education where he creates some of the guides and reference materials for developers who use Blackbaud SDKs and APIs. Thomas was a featured speaker at MadWorld 2013 and writes a blog on his website, Flare for Programmers, where we found this post about creating Flare topics in bulk with a plug-in. We’ve re-published it here (with Tom’s permission) for you to check out:

Sometimes you just want to create a bunch of blank topics all at once and put all of those topics in a TOC.

batch-topics-1

If you are interested in that sort of thing, you can create a Flare plug-in to add the functionality to MadCap Flare. If you want to play around with the code to create what is shown in the preceding screen shots, here is a sample solution and project: FlarePlugins.zip

If you just want to try it, here is a plug-in DLL: BatchTopics.dll and help for MadCap’s Plug-in API.

Some notes about the plug-in:

  • You can install it like any other plug-in (MadCap’s Plug-in API).
  • You do not need a project open and the plug-in doesn’t currently detect an open project.
  • You specify which project to which to add the topics by selecting the root folder for the project after you click Create.
  • If you do not select a valid root folder, one that contains a Content folder and a Project\TOCs folder, nothing happens.
  • If a topic with the same filename already exists, it is not overwritten and a message is displayed. An entry is still added to BatchToc.fltoc.
  • You can leave the File field blank and the plug-in will name the file based on the Heading field.
  • The plug-in creates a TOC called BatchToc.fltoc. It contains links to the new topics.
  • If BatchToc.floc already exists, it is not overwritten and a message is displayed. Topics are still created. You can always rename the TOC if you want to create a new BatchToc.fltoc with the plug-in.

To read the rest of the post, visit Flare for Programmers.

About The Author

Jennifer White

About Jennifer White

Jennifer White, a Product Evangelist at MadCap Software, has over 15 years of experience in writing, broadcasting, public speaking, marketing and social media management. Jennifer has also served as a social media manager, blogger, on-air host, writer and content provider for CBS Radio and Fox TV.

Last Modified: August 6, 2015

This entry was posted in Guest Post, MadCap Flare, Tips & Tricks and tagged . Bookmark the permalink.

Comments

  • Nita Beck Nita Beck September 14, 2013 at 9:22 AM

    I just got a chance to try out Thomas’s BatchTopics Flare plug-in. *Very slick.* Got it working quickly, and I can see how this plug-in can be a real timesaver.

    What might be a nice enhancement is to also prompt for the heading level, rather than to default to H1. For instance, the majority of my topics have their headings set to H2. After batch-creating topics with this DLL, I then have to change all or most of the H1s to H2s. Just an idea.

    I hope Thomas keeps his great ideas coming!

  • sanjay srikonda August 6, 2015 at 1:46 PM

    No idea how to get this to work in 11.1. I get the following error:
    “Failed to enable plugin: Method not found: ‘B3:PluginAPIKit.ICustomToolstrip B3:PluginAPIKit.INavContext.CreateCustomToolstrip(System.String’.

    With an OK button. Anyone have any ideas?

Have Something to Say?

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