Compiling Documentation
Previous Topic  Next Topic 

This screen has the following options:

Printable Document

One of the main features of Fast-Help is that it is completely integrated, so you don't need an external word processor. This has its pros and cons, but this option will create a manual, based on all the options you've entered in the Documentation Options screen, and save it to the "Documentation" folder of your Project. It will use the file name you have on this screen and add the extension, ".fhd" (Fast-Help Document). You can re-open it later using "Project | Display | Printable Document".

When you click [OK] Fast-Help will prepare your Printable Document, complete with Table of Contents and Index, if you've chosen those options in Documentation Options. Once complete your Printable Document will appear on-screen and you can browse around it and print it.

MS Word RTF Document

Using the same settings as the Printable Document above, this option produces an rtf file that can be loaded and edited in MS Word. This gives you the flexibility of extending the options available within Fast-Help so that you can use this as a basis for a more complex document. Please remember that if you make amendments within MS Word, to save the file as a different name, as Fast-Help will overwrite it the next time you select this compile option. The ".rtf" extension is automatically added to the file name for you.

Fast-Help uses MS Word fields to handle the page numbers for the Table of Contents and the Index. MS Word unfortunately does not update these fields automatically, so the first time you display your rtf file after compile, you can update the fields by either selecting Print Preview, or by pressing Ctrl+A then F9.

Start Headings on New Page

When checked a Heading will appear on its own on a new page.

Start Topics on a New Page

When checked the Topic and all the related help text will begin on a new page.

First Topic after Heading starts on new page

This option is unchecked by default, and when it is, the first Topic after a heading is added below the heading, so that the heading is not just on it's own on a page.

Include Page Numbers

When checked, page numbers will be added. The next two choices determine where that will be, in the Header or in the Footer of each page.

Optimize Compile Time

When checked, this option will speed up compiles the first time, by up to 3 times. But subsequent compiles will be up to 4 times quicker.

Store Images Externally

When this option is checked your images are not embedded in your rtf document. This means your document loads quicker and uses less memory because it links to the images in your Images folder. But, if you need to distribute your document to others then turn this option off so that all images are embedded in the document. This will increase the size of your document but this will allow others to see your images.

Convert any PNG images to JPG images

In MS Word, PNG files are not handled well and bloat the size of the document dramatically. This option will convert any PNG files to JPGs which MS Word handles a lot better.

Convert BMPs to JPGs

This option is only important if you use BMPs in your Project. MS Word can run out of memory when processing large projects with lots of BMPs. Checking this option, will convert those BMPs to JPGs and avoid the out of memory problem.

Save Style Names

This option applies to rtf files only. If this option is checked, then Fast-Help will attempt to save a style sheet within your rtf document, listing all the style names from the Style Gallery.

Print Editable Headings

Although strictly speaking, Editable Headings are a feature of WinHelp and HtmlHelp, and no other compile format, if you want the help text of your editable headings to be printed, then check this option.