Navigation: Compiling a Help Project >

Compiling a Help Project

Send comments on this topic.



HelpSmith allows you to compile your help project and generate documentation in different formats, such as HTML Help (CHM), Web Help, Printed Manual, Adobe PDF, Microsoft Word, ePub eBook, and Markdown.


Compile a Help Project

1.On the Project tab, in the Project group, click Compile.

2.In the Compile Project dialog, specify the parameters, such as the documentation format that you want to create, output filename, and build tags.

3.Click Compile.


The Compile Project Dialog


Output Format

Specifies the documentation format that you want to create.


Output Filename

Specifies the destination filename or folder for the generated help file or document.


Determine the path automatically

If selected, the output filename will be automatically determined depending on the selected output format and the help project location.


Project Options

Allows you to edit settings of the help project before the compilation.


Compile topics with status "Complete" only

If selected, the topics with the status different from "Complete" will be excluded from the compiled documentation.


Open compiled documentation upon successful compilation

If selected, the generated help system or document will be opened in the associated application.


Build Tags

Specifies the build tags that will be applied to the current compilation.


Task Manager

Switches to the batch compilation mode that allows you to compile your help project into multiple output formats with a single click.



Starts the process of help project compilation into the selected output format.



Related Topics

Batch Compilation Tasks

Compilation Log

Copyright © 2007-2024