Since producing context-sensitive Help (CSH) is a collaborative process, it is important that you maintain good communication with the developer, and provide the necessary information to that person. You can give this to the developer by emailing it or using a similar method. Alternatively, you can export it from the Flare project to a location where the developer can access it. The advantage of exporting it is that you can select a specific file format, depending on the developer's preference.
[Menu Proxy — Headings — Online — Depth3 ]
Exporting Header Files
If it is decided that you are responsible for creating the header file (i.e., the file containing an .h extension in your project), you must provide a copy of it to the software developer. You can do this by exporting the header file so that the developer has access to it. If you make further changes to the header file, you need to ensure that the developer receives a new copy of it.
How to Export Header Files
- Do one of the following, depending on the part of the user interface you are using:
- Ribbon Select Tools > Export Header File(s).
- Right-Click In the Project Organizer, right-click the Advanced folder and select Export Header File(s).
The Export Header Files dialog opens.
- On the left side of the dialog, select the format(s) that you want to use for exporting the header file(s). Work with your developer to determine the appropriate type of format:
- C/C++ (.h) If this option is selected, a copy of the header file will be created with an .h file extension.
- Visual Basic (.bas) If this option is selected, a copy of the header file will be created with a .bas file extension.
- Java (.properties) If this option is selected, a copy of the header file will be created with a .properties file extension.
- Delphi Pascal (.inc) If this option is selected, a copy of the header file will be created with an .inc file extension.
- On the right side of the dialog, select the header file(s) to be exported.
- Click the Browse button and select the location where the exported file(s) will be sent.
- Click Export.
- (Optional) If the file(s) are not in a shared location where the developer can retrieve them, you need to copy the exported files(s) from that location and send them to the developer.
Information for the Developer
Following is additional information you need to provide to the developer depending on your output type. The developer can use this information to make CSH calls from the software application or website.
- HTML5 CSH Calls for HTML5 Output
- WebHelp or WebHelp Plus CSH Calls for WebHelp and WebHelp Plus
- HTML Help CSH Calls for HTML Help
If you are using a special skin for your CSH, provide the developer with the skin ID as well.
