Through the integration of the Flare API and HyperSTE, the leading quality assurance software for standardized documentation, authors can now validate the language and terminology used in their Flare content.  This ensures use of standardized vocabulary and style– improving consistency, eliminating ambiguity and reducing complexity. Furthermore, authors can ensure compliance with corporate terminology and style guide rules using advanced interactive checker and quality measurement features.

More information on how the HyperSTE plugin can be used can be found in our press release or visit the Tedopres website. To request a trial license of HyperSTE, contact STE@tedopres.com.

To install the plugin and connect it to Flare you’ll first need:

  1. Flare V9.1.
  2. Tedopres HyperSTE 4.0, including a license and dictionary.
  3. A Flare project with topics to validate. 

To Register HyperSTE and Enable the Plugin:

  1. Have MadCap Flare V9.1 installed and registered (or launched once).
  2. Install Tedopres HyperSTE 4.0. and launch it.
    1. Select “HyperSTE for MadCap FlareV9″ (and the other applications that you have a license for or will request one for).HyperSTE - Pick Flare
    2. Don’t launch the license server.
    3. Click “Finish.”
  3. Launch MadCap Flare and open a project.
  4. Go to File | Options.
    FileOptions
  5. In the Options UI , click the Plugins tab and enable the HyperSTE Plugin.
    Options
  6. Go to the HyperSTE ribbon and click “Check Document.”
    FlareSTERibbon
  7. Note:  When you check a document for the first time, the HyperSTE plugin is going to look for your associated license.  If you don’t have a license already, you’ll need to request one from Tedopres. To request a trial license of HyperSTE, contact STE@tedopres.com.
    HASP_License_Needed
  8. When a license file is returned save it on to your machine.
  9. Go to the HyperSTE ribbon again and click “Check Document.”
  10. When the licensing UI launches, select “I have a license.”  This will launch the HyperSTE configuration wizard.
    HASP_License_Needed
  11. Click next and set up HyperSTE, filling out the information as needed. The required dialogs and fields are shown below.
  12. Browse for the V2C file and click next.
    configuration_wizard_2
  13. Select a dictionary file (acquired from Tedopres).
    configuration_wizard_4

To enable the plug-in from within Flare:

  1. Open a project in Flare.
  2. Open the topic you want to validate.
  3. Go to the HyperSTE Ribbon in the Flare ribbon menu.
  4. Select “Check Document.”
  5. Click on highlighted words throughout the topic and notice the HyperSTE window explaining the terms and usage.
    FlareandHyperSTE

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: June 5, 2014

This entry was posted in MadCap Flare and tagged , , , , . Bookmark the permalink.

Comments

  • Bob Bolt May 17, 2013 at 11:55 AM

    Re your statement “If you don’t have a license already, you’ll need to request one from Tedopres.’ Is it free, or is there a cost for this license?

  • Dan Wen July 30, 2013 at 7:18 PM

    Thanks for sharing. Is there an interface in this plug-in for us to manage terminology? Click the Add Word icon in the ribbon?

    • Jose Sermeno Jose Sermeno July 31, 2013 at 2:47 PM

      Hi Dan! Yes, you can add words to the dictionary. This is a set of terminology that can also be customized during your initial setup with the client version of HyperSTE (separate from Flare’s integration).

  • inna yakimenko August 6, 2013 at 2:46 AM

    Please provide some more information concerning the dictionary.
    You menton that to install the plugin and connect it to Flare you’ll first need
    Tedopres HyperSTE 4.0, including a license and dictionary.
    Does it mean that I have to pay for it? What is the cost then?
    If I have Flare 9.1 installed, can I create the dictinary on my own?

    Besides, can the HyperSTE plugin tell that I use a cirtain range of synonims across the doc instead of one word?

    Thank you.

    • Jose Sermeno Jose Sermeno August 6, 2013 at 8:49 AM

      In order to use the HyperSTE plugin for Flare, you’ll need to have HyperSTE 4.0 installed on your machine. You can request a free trial of HyperSTE 4.0 as well as a dictionary from STE@tedopres.com . All questions regarding cost and functionality of HyperSTE 4.0 can be emailed to STE@tedopres.com .

Have Something to Say?

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