Open topic with navigation

Adding Header Files

Aside from planning the context-sensitive Help (CSH), the first step in this process is to add the header file to the Flare project. Exactly how you do this depends on whether you or the software developer are responsible for creating the header file. For more information see About Header Files.

How to add a header file (if you are responsible for creating it)

1. Select Project>Advanced>Add Header File.

   The Add Header File dialog opens.

2. In the Source area select one of the following:

   • New from template This lets you choose either a factory template file or one of your own customized template files as a starting point. The new file will take on all of the settings contained in the template. If you want to use a factory template provided by Flare, expand the Factory Templates folder and click on a template file. If you want to use your own customized template file, expand the appropriate folder and click on a file. Click here to find out what templates are all about.

     Note: In some dialogs and wizards you can click the Manage Templates button if you want to open the Template Manager. This lets you manage any of your template files (e.g., add new templates, enter descriptions for templates). See Managing Templates.

   • New from existing This lets you choose an existing file of the same type—that you've already created and stored somewhere—as a starting point for your new file. As with template files, your new file will take on all of the settings contained in the file you select. To use this option, click the browse button , use the Open File dialog to find a file, and double-click it.
3. In the File Name field, type a new name for the header file.

4. Click Add.

5. Click OK.

   The header file is added to the Advanced folder in the Project Organizer. The Text Editor opens to the right, with the page for the new header file (including an initial identifier) shown.

6. You can close the Text Editor by clicking the x at the top-right corner of the tab.

   You will not be entering content to this editor directly. It will be added automatically when you work in the alias file. See Creating and Assigning Identifiers.

How to add a header file (if the developer is responsible for creating it)

• Follow the steps for importing a header file.

Note: Whether you add a header file from inside Flare or "import" one from outside the program, you need to make sure that it uses the following format on each line: #define IdentifierName IdentifierValue. Make sure that there are no spaces between the words in the "IdentifierName." For example, use "#define MyDialog 17" or "#define My_Dialog 17," rather than "#define My Dialog 17."

Note: If you are importing FrameMaker documents and you create topic alias markers in the source files, this file will be created automatically when you perform the import. See Creating Topic Alias Markers in FrameMaker for Context-Sensitive Help.

WHAT'S NEXT?

After you add a header file, you need to add an alias file.

See Also

Open topic with navigation