How to Create a New CHM File

CHM files (Compiled HTML Help) are the standard for software documentation on Windows. Whether you're a developer documenting your application or a technical writer, creating a structured, navigable help file is essential. This guide will walk you through creating a new CHM project using CHM Editor.

Note: Creating CHM files from scratch can be complex with standard tools. CHM Editor simplifies this process with a visual interface and built-in templates.

1. Installation and Setup

First, ensure you have CHM Editor installed. If you haven't already, you can download the trial version to follow along with this tutorial.

Once installed, launch the application. You will be greeted by the start screen.

2. Creating a New Project

To start a new project, navigate to File > New in the top menu, or simply press Ctrl+N.

Project Configuration

The "New Project" dialog allows you to define the identity and style of your documentation:

Project Name: The internal title of your help project.
File Name & Location: Where your project will be saved.
Language: The default language for your help file.
Company Name & Website: Optional metadata that appears in the file properties.
Template: Choose from one of the built-in professional color schemes:
- Simple Blue – A standard, business-friendly look.
- Simple Green – A fresh, modern appearance.
- Simple Orange – A warm, energetic style.

3. Adding Topics

A help file consists of multiple topics organized in a tree structure. To add a new topic, click the Add Topic button (plus icon) in the toolbar.

You have three options for creating a topic:

Create with a new file: Creates a fresh, blank page for you to write content.
Create without a file: Creates a section header (folder) that holds other topics but doesn't have content itself.
Create with an existing file: Imports an HTML file you've already created into your project.

Tip: Don't forget to set a Default Topic. This is the first page users will see when they open your CHM file. Right-click any topic in the tree and select Set as Default.

4. Editing Content

Use the editor pane to format text, insert images, and create links.

Use the Tree View on the left to organize your help topics hierarchy.
Use the Editor pane on the right to visually edit your content.

Pro Tip: You can export your help file to PDF or Word formats later if you need to provide printable documentation.

With your project set up, you are ready to build comprehensive documentation. CHM Editor handles the complex compilation process in the background, letting you focus on writing good content.