Controlled Language Example

Information for Developers

One of the most common uses for the Flare plug-in API is to implement controlled language with Simplified Technical English (STE). This lets you validate the language and terminology used in your Flare content, ensuring the use of standardized vocabulary and style, while improving consistency, eliminating ambiguity, and reducing complexity. This also means you can ensure compliance with corporate terminology and style guide rules.

Two STE solutions that can be integrated with Flare come from Acrolinx (acrolinx.com) and Etteplan (etteplan.com).

Example You use Etteplan HyperSTE, which is one of the leading software solutions for STE. You want to integrate HyperSTE with your Flare project so that you can take advantage of controlled language when you write topics and snippets. You might do the following to set it all up and use it.

register hyperste and enable the plug-in

  1. Install HyperSTE and launch it.

    1. Select HyperSTE for MadCap Flare.

    2. Don't launch the license server.
    3. Click Finish.
  2. Open a Flare project and select File > Options. The Options dialog opens.
  3. Select the Plugins tab.
  4. Click Enable.

  5. Select the HyperSTE ribbon and click Check Document.

  6. When you check a document for the first time, the HyperSTE plugin looks for your associated license. If you don’t have a license already, you’ll need to request one from Etteplan. To request a trial license of HyperSTE, contact ste-support@etteplan.com.
  7. When a license file is returned, save it on your machine.
  8. From the HyperSTE ribbon, click Check Document.
  9. When the licensing UI launches, select I have a license. This launches the HyperSTE configuration wizard.
  10. Click Next and set up HyperSTE, filling out the information as needed.
  11. Browse for the V2C file and click Next.
  12. Select a dictionary file (acquired from Etteplan).

use hyperste to check a content file in flare

  1. Open a project in Flare.
  2. Open the topic you want to validate.
  3. From the HyperSTE ribbon, click Check Document.

  4. Click on highlighted words throughout the topic. Notice the HyperSTE window explaining the terms and usage.

You can also use the other features shown in the HyperSTE ribbon in Flare.