You are here: User Interface Elements - How to Use Each One > Adding Synonym Files

Adding Synonym Files

You can make improvements to your output so that, in the future, users are able to find the search results they need. One way to enhance your output is to create synonyms for search phrases. This way, even if a user enters a search term that is not included anywhere in the project, that person will still be able to find the appropriate information.

The first step to creating synonyms for enhanced search is to add a synonym file to the Flare project.

How to add a synonym file

  1. Select Project>Advanced>Add Synonym File.

    The Add Synonyms File dialog opens.

  2. In the Template Folders area, select one of the folders.

    The Templates section to the right displays the synonym file templates contained in the folder you selected.

    Click here to find out what templates are all about.

  3. In the Templates area, select a synonym file template.
  4. In the File name field, type a new name for the synonym file.
  5. Click Add.
  6. In the Copy to Project dialog, click OK.

    The synonym file is added to the Advanced folder in the Project Organizer. The Synonyms Editor opens to the right.

Note: You can create synonyms within the Flare project or within the external Feedback Explorer (which is used with MadCap Feedback). It is not mandatory that you have MadCap Feedback in order to use synonyms in Flare output, but using MadCap Feedback makes it much easier to determine which words require synonyms based on the search results of your users. Using the external Feedback Explorer to create synonyms is appealing because the synonyms become immediately available for users searching in your output (without needing to republish the output). Be aware, however, that creating synonyms in the external Feedback Explorer works for the Feedback output as long as you continue to publish output to the same server. If you create synonyms in the external Feedback Explorer, it is recommended that you also create those synonyms at the source (i.e., within the Flare project), in case you ever publish to a different server. The easiest way to do this is to export the synonym file from the Feedback Explorer to the Project\Advanced folder in the Flare project. See the Feedback Explorer online Help for more information and steps on how to export synonym files. For more information, see About MadCap Feedback and the online Help provided with the external Feedback Explorer.

Note: If you merge projects, synonym files will remain separate in each project. For example, if you create synonyms in Project A but not in project B, only the topics from Project A will use the synonyms when users perform searches in the output.

Note: This feature is available if you are generating DotNet Help, WebHelp, WebHelp Plus, or WebHelp AIR output formats only. It is not available for HTML Help output.

WHAT'S NEXT?

After you add a new synonym file, you can create directional synonyms and synonym groups within it. See Creating Synonyms to Enhance Search Results.

See Also

Downloads (PDF Format):

Flare Quick Guide

Flare Getting Started Guide

Flare What's New Guide

Flare Key Features Guide

Flare Transition From RoboHelp Guide

Flare Transition From FrameMaker Guide

Flare Styles Guide

Flare Printed Output Guide

Flare Shortcuts