How to Use NorthBright CHM Tool to Create Professional CHM Files

NorthBright CHM Tool: Complete Guide for Windows Help Authoring

What NorthBright CHM Tool is

NorthBright CHM Tool is a Windows-focused help-authoring utility for creating, editing, and compiling CHM (Compiled HTML Help) files. It packages HTML content, images, and navigation (table of contents, index, and full-text search) into a single .chm file that Windows Help Viewer can open.

Why use it

• Simplicity: Streamlines CHM creation without requiring deep HTML or project-file knowledge.
• Integration: Works with common HTML/CSS and image assets produced by many documentation workflows.
• Output: Produces compact, distributable CHM files suitable for offline help, installers, and internal documentation.

System requirements

• Windows 10 or later (32-bit or 64-bit recommended)
• .NET Framework 4.7 or later (if the app depends on .NET)
• Sufficient disk space for project assets and compiled output

Key features

• Project manager: Create and manage CHM projects with source folders, resource lists, and output settings.
• WYSIWYG editor + HTML mode: Edit topics directly or switch to raw HTML for fine control.
• Table of Contents (TOC) editor: Drag-and-drop ordering and nesting of topics.
• Index builder: Add keywords and map them to topics.
• Search indexing: Generate a full-text search index included in the CHM.
• Styles and templates: Reusable CSS and HTML templates for consistent look-and-feel.
• Image and resource handling: Embed images, scripts, and other assets into the compiled file.
• Batch compilation: Compile multiple projects or outputs in sequence.
• Command-line support: Automate builds in CI or scripted workflows.
• Previewer: Inspect output before compilation using a built-in CHM viewer.

Typical workflow (step-by-step)

1. Create new project: Choose output filename, project folder, and default language.
2. Import content: Add existing HTML files or create new topics in the editor.
3. Organize TOC: Use the TOC editor to structure chapters and subtopics.
4. Add index keywords: Assign keywords to topics for the CHM index.
5. Apply template and styles: Set global templates/CSS to ensure consistent formatting.
6. Configure build options: Set default topic, window size, and search options.
7. Preview: Use the previewer to check navigation and layout.
8. Compile: Build the CHM and fix any missing resource warnings.
9. Test on target environment: Open the CHM on a clean Windows VM to ensure it displays correctly.
10. Automate (optional): Use command-line compilation for CI/CD integration.

Best practices

• Use relative links: Keep links relative to the project root to avoid broken links after compilation.
• Optimize images: Reduce image sizes and use web-friendly formats (PNG, JPEG, SVG where supported).
• Modular topics: Prefer smaller focused topics rather than very long pages for easier navigation.
• Consistent templates: Centralize CSS and header/footer templates to simplify maintenance.
• Index deliberately: Add concise index keywords that users are likely to search for.
• Test search/indexing: Verify full-text search finds expected phrases; adjust indexing if needed.
• Version control: Keep source HTML, CSS, and project files under version control (Git).
• Accessibility: Use semantic HTML (headings, lists, alt text) to improve readability and compatibility.

Automation and CI tips

• Use the tool’s command-line interface to compile during release builds.
• Place build artifacts (final .chm) into your CI pipeline’s release directory.
• Run headless HTML validation (linting) before compilation to catch broken links or invalid markup.

Troubleshooting common issues

• Missing images after compile: Check that images are referenced with relative paths and included in project resources.
• Broken links: Run a link checker on source HTML before compiling.
• Index/search not working: Ensure topics are properly indexed and that the full-text index was generated during build.
• Encoding problems: Save HTML files with UTF-8 charset and include proper meta tags.
• CHM blocked by Windows: Unblock downloaded CHM files (right-click → Properties → Unblock) or sign installer packages.

Alternatives and when to consider them

• Use Sphinx or MkDocs if you prefer documentation-as-code with HTML/ReadTheDocs hosting.
• Use commercial help-authoring tools (e.g., Adobe RoboHelp) for advanced multi-channel outputs (WebHelp, PDF, mobile).
• Consider Markdown-to-CHM converters if your source is Markdown-first.

Quick checklist before release

• All topics reviewed and up-to-date
• TOC and index validated
• Images optimized and included
• Default topic set correctly
• Tested on target Windows environment
• Build automated for the next release

Conclusion

NorthBright CHM Tool is a practical option for authors needing compact, offline Windows help files. With organized content, consistent templates, and an automated build, you can maintain professional CHM documentation for software and internal guides.