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 is responsible for creating the header file. See Header Files.

How to Add a Header File (If Author Creates It)

1. Do one of the following, depending on the part of the user interface you are using:
   • Ribbon Select Project > New > Advanced > Header File.
   • Right-Click In the Project Organizer, right-click on the Advanced folder and from the context menu select Add Header File.

   The Add File dialog opens.

2. In the File Type field at the top, make sure Header File is selected.
3. In the Source area, choose to create the new file based on a template or an existing file.
   • New From Template Choose either a factory template file or one of your own custom 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 the factory template provided by Flare, expand the Factory Templates folder and click on a template file. If you want to use your own custom template file, expand the appropriate folder and click on a file. See Templates.
   • New From Existing Choose an existing file of the same type 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 , use the Open File dialog to find a file, and double-click it.
4. (Optional) If you want to place the file into a subfolder previously created in the Content Explorer or Project Organizer, in the Folder field click and select the subfolder. Otherwise, keep the default location. See Creating Subfolders.
5. In the File Name field, type a new name for the header file.
6. (Optional) If you want to apply condition tags to the file, expand the Attributes section at the bottom of the dialog. Next to the Condition Tags field, click and select the conditions you want to apply. Click OK. See Applying Conditions to Content.
7. (Optional) If you want to apply file tags, expand the Attributes section at the bottom of the dialog. Next to the File Tags field, click and select the file tags you want to apply. Click OK. See Associating Tags With Files.
8. Click Add. 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.

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

   Most authors do not enter content into this editor directly. The file is populated automatically when you work in the alias file. See Creating and Assigning Identifiers.

How to Add a Header File (If Developer Creates It)

1. Do one of the following, depending on the part of the user interface you are using:

   • Ribbon Select Project > New > Advanced > Header File.

   • Right-Click In the Project Organizer, right-click on the Advanced folder and from the context menu select Add Header File.

   The Add File dialog opens.

2. In the File Type field at the top, make sure Header File is selected.
3. Select New from existing and click .
4. Find and select the header file that you want to import.
5. Click Open. The Source File field now contains the path to the file that you are importing. Also, the name of the file is displayed in the File Name field.
6. If you want to give the header file a different name than that for the imported file, click in the File name field and replace the text.
7. (Optional) If you want to apply condition tags to the file, expand the Attributes section at the bottom of the dialog. Next to the Condition Tags field, click and select the conditions you want to apply. Click OK. See Applying Conditions to Content.
8. (Optional) If you want to apply file tags, expand the Attributes section at the bottom of the dialog. Next to the File Tags field, click and select the file tags you want to apply. Click OK. See Associating Tags With Files.
9. Click Add. The header file is added.

What’s Noteworthy?

What’s Next?

Adding Alias Files