Использование HTML-помощи в Delphi XE2: инструкция по настройке A-ссылок

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

В статье рассмотрим, как настроить поддержку HTML-помощи в среде разработки Delphi XE2. Это позволит использовать A-ссылки (A-keywords) для поиска страниц помощи, что особенно удобно для контекстной помощи в программе. Для работы с HTML-помощью в Delphi XE2 предусмотрен модуль HTMLHelpViewer, однако его использование имеет свои особенности.

Шаг 1: Настройка программы

Для начала работы с HTML-помощью необходимо задать свойство Application.HelpFile на путь к файлу .chm, который содержит вашу помощь. Это делается обычно в процедуре OnCreate формы, которая запускается при старте программы.

procedure TMainForm.FormCreate(Sender: TObject);
begin
  Application.HelpFile := 'sample.chm';
end;

Шаг 2: Обработчик события помощи

Для использования A-ссылок необходимо назначить обработчик события Application.OnHelp. В этом обработчике будет обрабатываться запрос на отображение помощи.

function TMainForm.ApplicationHelp(Command: Word;
  Data: THelpEventData; var CallHelp: Boolean): Boolean;
var
  Link: THH_AKLink;
  ALink: string;
begin
  CallHelp := False;
  Result := True;
  case Command of
  HELP_COMMAND:
    begin
      ZeroMemory(@Link, SizeOf(Link));
      Link.cbStruct := SizeOf(Link);
      ALink := PChar(Data); // Используем строку запроса как A-ссылку
      Link.pszKeywords := PChar(AnsiString(ALink));
      Link.fIndexOnFail := True;
      HtmlHelp(GetDesktopWindow, Application.HelpFile, HH_ALINK_LOOKUP,
        DWORD_PTR(@Link));
    end;
  end;
end;

Шаг 3: Использование A-ссылок

Для вызова контекстной помощи с использованием A-ссылки, необходимо установить свойство HelpKeyword для элементов управления, для которых требуется контекстная помощь, и вызвать Application.HelpKeyword с нужной A-ссылкой.

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

При использовании A-ссылок важно учитывать, что некоторые символы, например _, могут не работать. Также необходимо убедиться, что путь к файлу .chm указан верно и файл существует.

Альтернативный подход

Если стандартные средства не работают, можно рассмотреть использование сторонних библиотек, например, порт Eric Granges' Microsoft HTML help API, который называется HTMLhelpAPI.pas. Однако, в современных версиях Delphi, использование сторонних библиотек может быть не обязательно.

Пример использования A-ссылок для перехода на анкор

Для перехода к определенному месту на странице помощи можно использовать анкоры. В файле .ali необходимо указать путь к анкору:

IDH_UsingtheMenus=Overview.htm#UsingtheMenus

В соответствующем .htm файле нужно определить анкор:

<A NAME="UsingtheMenus"></A>
<P><STRONG>Using the Menus and Toolbars</STRONG>

Теперь, используя A-ссылку, можно перейти непосредственно к нужному разделу.

Заключение

Использование HTML-помощи в Delphi XE2 позволяет создавать удобные и эффективные системы помощи в программах. Настройка A-ссылок требует внимательности и понимания некоторых особенностей работы с HTML-помощью, но результат стоит затраченных усилий.

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

Инструкция по настройке A-ссылок для использования HTML-помощи в среде Delphi XE2.

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

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

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