Creating a help file

Then you test the help file to make sure everything appears the way you want it. Skip to main content. This browser is no longer supported. Download Microsoft Edge More info. Contents Exit focus mode. Write or import your content and produce more than 8 documentation formats including help files, web sites, user manuals, documents, Markdown, eBooks…. Benefit from a thoroughly thought-out, clean and simple user interface to speed-up the complex task of help and documentation authoring.

HelpNDoc projects can be exported to help files, web sites, documents and eBooks. It supports batch export , conditional generation as well as advanced customization options. Create stunning online help and manuals compatibles with all devices and screen sizes. Android and iPhone specific templates are also included and can be edited to customize any part of the generated HTML documentation.

Generate printer-ready PDF documents with compression, encryption, font embedding…. Be confident that your documentation will be experienced as you designed it thanks to the Portable Document Format PDF which precisely defines how it will be displayed and printed.

Add optional security via PDF encryption and password protection to only reach the targeted audience. Produce electronic books compatible with any electronic reader, including the Amazon Kindle. Compile standard Windows compiled help files in the CHM format without the steep learning curve. Fortunately, HelpNDoc encapsulates this outdated compiler in a straightforward user interface so that you can concentrate on writing the best possible user manual. The Microsoft Word DocX file format is one of the most used and versatile document format for editing purposes.

HelpNDoc can convert the whole documentation to a single DocX document optionally RTF document which can be opened by any Word processing application available on the market. Generate self-contained help files for multiple systems using the Qt Help Framework. Add a Hyperlink Hyperlinks are an important part of any help system allowing the user to go between related topics within the same help system as well as to go to a linked website or email address.

Create the Keyword Index The alphabetical Index of keywords allows the user of the help file to quickly find a specific term and one or more help topics which are associated with it. To add a new keyword: On the View tab, click Keyword to open the Keyword tool. In the Keywords pane, type a new keyword. To edit the list of topics linked with a specific keyword: In the Keywords pane, right-click on the keyword you want to edit.

In the popup menu, click Properties. In the Keyword Properties dialog, check the topics that you want to be associated with the selected keyword. Click OK. Customize Help File Settings On this step, you should customize the common parameters of your help system such as title, copyright, the default help topic that you want to show when your help file is opened, language and encoding options, output directories, and other options.

Help Project Options. To compile your help project: On the Project tab, in the Project group, click Compile. In the Compilation Options dialog, select the output format you need. Help Project Compilation.