Building Output

Whew, we've now built a basic help project. It's time to build it into an HTML Help file. To do this fire up the Build Help Wizard from the toolbar.

Note:
If the Html Help 1.0 option isn't enabled, the Help Compiler is not installed. Please see the Requirements topic for information on where to download the compiler and install it.

This page lets you choose what to create when generating your help output.

Create Html Files
This option specifies whether the HTML files get generated from your project. It's useful to turn this option off if you need to only generate a CHM file or if you've changed some project options like icons that don't affect the HTML output.

Build Html Help 1.0 file
This is the standard Help Format for Windows applications. If you're building end user documentation for your application you will want to create a CHM file which you can easily plug into most Windows based development environments such as .NET WinForms, VB6, Visual FoxPro, Delphi and so on. CHM is the most common Help format and we suggest you use it except for special situations.

Don't build Help file
Sometimes you just want to generate the HTML files - for example when you prepare the files to be sent up to your Web site via FTP.

Custom Icon File
You can also specify a custom icon file if you would like to use custom icons. Be aware that this is an advanced feature and requires that you configure your topic types for custom icon usage and that you ship a separate icon file in the Windows directory. For more information see the Using custom icons in your Help file.

Select the topics to generate

The second screen of the Wizard is designed to allow you to optionally choose the topic trees that are used to generate the final help file. Sometimes you might want to generate documentation just for your end users so it might make sense to not generate the developer documentation into the final help file.

The dialog allows you to select and unselect top level topics that are to be included in your final help file or HTML output. By default all topics are selected - if you want to exclude certain topic trees from inclusion simply uncheck the checkbox for this topic. When you uncheck a topic this topic and all child topics are removed from the help file resulting in smaller size.

Click Next to get to the final confirmation page of the Wizard, then Finish and let 'er rip! Help Builder now goes through the process of generating hte HTML based content and then proceeds to build a CHM Html Help file. When it's done it brings up a finished compilation form:

Note:
If there are errors during compilation these errors will be displayed in the text area. The Html Help Compiler will frequently display some topic compilation errors that are non-fatal even though the error messages appear rather serious. In most cases, those errors are mere warnings and your help file will actually have compiled. To check Run the HTML Help File.

From here you can preview the help file, view the Web view of the project, upload your project to an FTP site, open Html Help Workshop or copy the CHM file to another location on your disk.

HTML Output

Help Builder generates plain HTML output for a fully self-contained static Web site, that you can copy straight to a Web server.Here's what the generated site looks like:

Uploading the Web Site via FTP

To deploy these Web ready files you have a number of options:

  • Upload via the built-in FTP
  • Zip and package and unpack on a Web site
  • Manually copy files

To upload files to a Web Site using the build in FTP client you can use the FTP Upload option:

To make this work you'll need an FTP folder that you can upload to.

Note: There's no support for FTPS or SFTP for encrypted FTP at this time.

CHM Help File Output

If you generate and HTML Help (CHM) file here's what it looks like:

Note: Help Builder projects are also fully compatible with HTML Help Workshop and the generated files can be open in that tool and customize the final look and feel of the CHM file.

Copy and Package

You can also copy the Help Project, which copies the actual project file along with all the related image and template resources to a new location.

Alternately you can also zip the entire content of a project including its generated HTML files into a Zip file. You can take this Zip file and copy it to a Web server and unpack it in a folder of your choice to host your documentation site.

See also

Step By Step Guide | Generating Microsoft Word Output

© West Wind Techologies, 2018 • Updated: 04/10/18
Comment or report problem with topic