Help File Modernisation
While migrating help files from the traditional CHM format may not be a core feature of RAD Studio itself, it remains an important task for developers using Delphi and C++Builder. As applications evolve and adapt to modern operating systems, ensuring that your documentation remains accessible and user-friendly is essential. With the changing requirements of Windows help file handling, developers must proactively update their help systems to maintain reliable user support and comply with the latest security standards. This migration improves the user experience and helps your applications remain robust and professional in a competitive market.
There are many tools that can help convert CHM to other formats quickly (a quick search will find many). But we hope this section is informative and helps you move forward.
Why CHM is becoming a liability
- Modern Windows versions apply stricter security rules to CHM files, especially when opened from network locations.
- Users may see scary warnings or blocked content, even when the help file itself is fine.
- These behaviours can generate support tickets and undermine confidence in your application.
The Evolution of Windows Help File Requirements
Historically, CHM files were a popular choice for providing user assistance in Windows applications due to their compact size and the ability to include rich text, images, and navigation. However, as Windows evolved, so did its security and compatibility requirements. Starting with Windows Vista, stricter security protocols were implemented, impacting how CHM files were handled. These changes included restrictions on running CHM files from network locations and heightened security warnings, which could disrupt the user experience.
Modern Help File Solutions
To align with the latest Windows requirements and to enhance user experience, consider migrating to more modern help file formats such as:
- HTML5: Utilizing web-based documentation allows for interactive, responsive, and easily updatable help content. It can be hosted online or included with your application as local web files.
- PDF: A widely accepted format for detailed, print-friendly documentation. PDF files are easy to distribute and can be viewed on almost any device.
- Third-Party Help Systems: Tools like MadCap Flare or Help+Manual offer advanced features for creating and managing help content, including multi-format output, version control, and collaboration capabilities. If your goal is online docs, solutions like mkdocs material or docusaurus are popular opensource options.
Steps for Migration
Before committing to a full migration, take a moment to plan:
- Decide whether your next help system should be local-only, online, or a hybrid.
- Prototype a small subset of your existing CHM content in the new format before committing fully.
- Plan how your application will open and navigate the new help content (URLs, context IDs, search, and so on).
- Evaluate Current Content: Review your existing CHM files to determine what content needs to be updated or restructured.
- Choose a New Format: Decide whether HTML5, PDF, or another format best suits your application’s needs and user preferences.
- Convert Content: Use conversion tools or manually migrate the content to the new format. Ensure that links, images, and navigation elements are preserved and functional.
- Integrate with Application: Update your application to link to the new help files. For web-based help, ensure that your application points to the correct URLs.
- Test: Thoroughly test the new help system to ensure that all content is accessible and displays correctly across different devices and operating systems.
By migrating from CHM to more modern help file formats, you can improve compatibility with current and future Windows versions, enhance security, and provide a better overall user experience.