How to Create Help Files Easily with Easy CHM Creating professional help files is essential for software developers, technical writers, and product managers. A well-structured CHM (Compiled HTML Help) file provides users with offline access to documentation, troubleshooting guides, and FAQs. Easy CHM simplifies this process by automatically converting an existing folder structure of HTML files into a single, searchable help file.
This guide outlines the step-by-step process to build your first CHM file efficiently. 1. Prepare Your Source Content
Before opening the software, organize your documentation on your computer. Easy CHM relies on your local directory structure to build the file.
Create a Root Folder: Name it after your project (e.g., “Software_User_Guide”).
Write HTML Pages: Save your documentation topics as individual .html or .htm files.
Organize Subfolders: Use subfolders for different categories or chapters.
Include Assets: Place images, icons, and CSS stylesheets in an images or assets subfolder within the root directory. 2. Import Your Project into Easy CHM
Once your files are organized, launch Easy CHM to start the compilation process. Click the New button on the main toolbar. Browse and select your root folder in the Directory field. Choose your preferred title and language settings. Click OK to import the files.
Easy CHM automatically generates a Table of Contents (TOC) based on your folder and file hierarchy. 3. Customize the Table of Contents (TOC)
The imported structure might need some adjustments to improve user navigation.
Rename Items: Right-click any file in the TOC pane to change its display title without changing the underlying filename.
Rearrange Topics: Use the Up, Down, Left, and Right arrow buttons on the toolbar to move topics or create sub-chapters.
Add Icons: Assign unique book or page icons to different sections to make the navigation visually distinct. 4. Configure Search and Index Settings
A great help file allows users to find information instantly. Easy CHM handles this with built-in search indexing features.
Generate Index: Click on the Index tab to add keywords that map directly to specific pages.
Enable Full-Text Search: Ensure the full-text search option is checked in the project properties. This allows users to search for any word within the body text of your HTML pages, not just the titles. 5. Compile and Test Your CHM File
With your structure set and search options configured, you are ready to build the final document.
Click the Compile button (represented by a green icon or shortcut).
Specify the output destination and the final filename for your .chm file. Click Save/Compile to start the building process.
Once completed, click View to open your new help file and test the hyperlinks, images, and search functionality.
To help narrow down the next steps for your documentation, let me know:
Do you need help formatting the CSS layout for your HTML pages?
Tell me what you need, and I can provide targeted code snippets or layout advice.
Leave a Reply