Создание CHM-файла из HTML и связанных изображений в Delphi

Delphi , Файловая система , Help файлы

Вопрос о создании CHM-файлов из набора HTML-документов с использованием связанных изображений в среде разработки Delphi является актуальным для многих разработчиков, работающих с технологиями Windows Help. CHM (Compiled HTML Help) файлы – это компилированные архивы, содержащие HTML-страницы, которые используются для создания электронных руководств и документации.

Проблема

Разработчики, использующие Delphi для создания приложений, часто сталкиваются с необходимостью создания CHM-файлов для встроенной помощи в свои программы. Однако процесс создания таких файлов может показаться сложным без понимания основного механизма.

Решение

Для создания CHM-файла из HTML и связанных изображений в Delphi, необходимо выполнить несколько шагов:

1. Создание списка файлов для включения в CHM.
2. Генерация файлов HHC, HHP и HHK с необходимым содержимым.
3. Вызов командной строки hhc.exe с параметром HHP.

Пример реализации

В качестве примера можно использовать компонент DelphiCodeToDoc CHM Generator. В частности, следует ознакомиться с содержимым файлов uDocGenCHM_Tools.pas и uDocGeneratorChm.pas, которые находятся в репозитории проекта. Эти файлы содержат необходимый код для создания CHM-файлов и могут быть использованы в качестве основы для собственной реализации.

Пример кода на Object Pascal

// Примерный код для создания HHP файла
procedure TForm1.CreateHHPFile(const aFileList: TStringList);
var
  HHPContent: string;
  HHKContent: TStringList;
  HHKPath: string;
begin
  // Инициализация содержимого HHP
  HHPContent := '; HTML Help Project File\n' +
                '[$INCLUDE:0;.\index.hhi]\n' +
                'BrowseName = "Название руководства"\n' +
                'Default Window = index.toc.html\n' +
                'Compiled file = MyApp.chm\n' +
                'Compression = yes\n' +
                'ContentsFile = MyApp.hhm\n' +
                'Default History = yes\n' +
                'Display Database Info = no\n' +
                'Display Table of Contents = yes\n' +
                'Display Index Tab = yes\n' +
                'Display Search Bar = yes\n' +
                'Display Favorites Bar = no\n' +
                'Default Tab = Contents\n' +
                'Title = "Руководство пользователя"\n' +
                'Version = #noarp#\n' +
                'Expandtoc2 = no\n' +
                'Default Window Readme = Help\\Readme.htm\n' +
                'MultiTopic = yes\n' +
                'Application=myapp.exe\n' +
                'Icon = myapp.exe, 1\n' +
                'NoNLS = 1\n';

  // Создание HHK файлов
  HHKContent := TStringList.Create;
  HHKPath := '.\index.hhi';
  with HHKContent do
  begin
    Add('[$OVERVIEW:.tableofcontents.default$]' + #10#10);
    Add('ID = OverviewDefault' + #10);
    Add('Name = ' + 'Содержание' + #10);
    Add('ResourceName = 4' + #10);
    Add('TopicTitle = 0' + #10);
    Add('FileType = 1' + #10);
    Add('FileName = index.toc.html' + #10#10);
    // Здесь должен быть код для добавления всех HTML-файлов и ссылок на изображения
    // ...
  end;

  // Сохранение HHP и HHK файлов
  with aFileList do
  begin
    AddObject('.\index.hhp', HHPContent);
    AddObject(HHKPath, HHKContent);
  end;

  // Остальные действия...
end;

Этот примерный код показывает, как можно начать работу с созданием HHP файла, который является основой для CHM файла. Дополнительно потребуется создать содержимое HHK файлов, которое описывает структуру и содержание документации.

Использование командной строки hhc.exe

После создания всех необходимых файлов (HHP, HHK и т.д.), необходимо использовать утилиту hhc.exe для компиляции их в CHM файл. Это можно сделать, вызвав команду из Delphi через System.Shell.Run или аналогичный механизм.

Важные замечания

• Необходимо убедиться, что все пути к файлам и изображениям корректны и что они будут доступны после компиляции в CHM.
• При использовании внешних библиотек и компонентов важно учитывать лицензионные условия.

Альтернативные решения

Существуют и другие подходы к созданию CHM-файлов, включая использование сторонних инструментов и библиотек, таких как Free Pascal, который включает CHM read/write библиотеку. Однако, основываясь на предоставленной информации, можно сделать вывод, что разработка собственного решения с использованием Delphi вполне возможна и может быть полезной для специфических нужд разработчика.

Заключение

– это задача, которая требует внимания к деталям и понимания процессов работы с HTML Help Workshop. Использование примеров кода и готовых решений может значительно упростить этот процесс.

Примечание: В статье использован примерный код и описание процесса для демонстрации, полный код и подробные инструкции можно найти в указанном репозитории.

Создано по материалам из источника по ссылке.

Создание CHM-файла из HTML-документов и связанных с ними изображений в среде разработки Delphi включает в себя компиляцию HTML-страниц и ресурсов в единый архив для использования в качестве встроенной помощи в программах на Windows.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: Help файлы ::