Generating Microsoft HTML output in RoboHelp helps you create in-app Help for Windows desktop apps.
The main components of HTML Help include the following:
- Compressed HTML: A collection of all files in the project in a single CHM file that occupies less disk space and is faster to load. You can ship this compiled file with an application or distribute it to users as a stand-alone online document.
- HTML Help viewer: Displays compiled HTML Help (CHM file). It uses components of the Internet Explorer browser while displaying content in its proprietary window interface.
- Layout engine: Microsoft Internet Explorer 6 and later supply the required components for HTML Help support.
- HTML Help ActiveX control: Supports navigation features, such as the Table of Contents, index, and link controls (related topics and keyword links). It also supports HTML Help controls: WinHelp topic links, startup screens, and close window controls.
The first step in generating the output of a RoboHelp project is to create an output preset and then configure the various settings of the output preset. You can use the following settings to configure a Microsoft HTML output preset:
Use the following options to specify basic output settings, such as title, output path, language of UI strings, and more.
Title Specify the title for the generated output.
You can use variables in the title. To do so, type Ctrl + 1 and select a variable from the drop-down list, and then press Enter. Note that if you have provided a variable set in the Content tab > Variable Set field, during output generation, the value of the selected variable is picked from the variable set.
Output Path Specify a location for the output. To select a location, click .
Ensure that the output path is NOT located inside the project folder. If the output path is inside the project folder, the output generation fails. Also the folder you select should NOT have any content that you need. RoboHelp deletes the contents of the folder before generating the output.
CHM file Specify the CHM filename with extension .chm.
Language Use the drop-down list to specify a language for the tab titles in the output. Specify this setting if you want to change the specified language in project settings.
Post Generation Script To run your custom script after output generation, select the script .js file from the drop-down list.
Use the following options to specify content-related output settings, such as the settings for Table of Contents, index, glossary, and condition expression.
Table Of Contents Use the drop-down list to select a Table of Contents to be included in the output. This drop-down list displays the Tables of Contents available in your project. The first Table of Contents in this drop-down list is selected by default.
The set of files and their references present in the selected Table of Contents appear in the generated output.
Default Topic Click to select the topic that displays in the Topic panel when you open the output. By default, the first topic in the Table of Contents selected for this output is the default topic.
Include Index Select this setting to include the index in the output.
Glossary Use the drop-down list to select the glossary to be included in the output. The glossary helps your users to easily access relevant terms in your project, with the corresponding definitions.
Condition Expression Use the drop-down list to specify the condition expression for your output. This setting allows you to easily include or exclude content depending on the desired type of output or userbase. Click to edit the selected condition expression. You can also select None in the drop-down list to not specify a condition expression.
Variable Set Use the drop-down list to specify the variable set to use in this output. In the drop-down list, you can select <Default Variable Set> to use the project's default variable set. Variable sets help you implement output-specific use of variables. For example, you can have different variable sets for generating output for customers and internal users.
After you've configured an output preset, you can access it in the Quick Generate dialog box of the authoring window or in the Output Presets panel of the publishing window.
You can publish your output to FTP, SFTP, or File System. To be able to publish your output, first configure a publish profile for the appropriate server type. For more information, see Configure a publish profile for FTP, SFTP, or File System.
After you save the publish profile, RoboHelp displays the profile in the Publish tab. To publish your output, select the appropriate publish profiles and click .
By default, only modified files are published using the chosen publish profiles since the last publish.
To publish all files, select Republish All and click . To view the publish log, in the Output Presets panel, against the appropriate output preset, choose > View Publish Log.
Click the Generate Preset icon in the Output Presets panel.
You can then view a progress bar next to the selected output preset in the Output Presets panel. Once the output generation is complete, a Success dialog box is visible in the lower-right corner of the screen.
After the output generation is complete, click in the Output Presets panel to view the output.
Alternatively, you can generate the output in the authoring window. Click Quick Generate on the toolbar, select the desired output preset, and click Generate.
You can then view a progress bar in the Quick Generate dialog box. After the output generation is complete, click next to the output preset to view the output. In case the output generation failed, click next to the selected output preset to view the error log.