Решение проблемы вставки бинарного потока в HTML-раздел с помощью Pascal-скрипта в HelpNDoc

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

В данной статье рассмотрим проблему, с которой сталкиваются пользователи HelpNDoc при попытке вставки бинарного потока в HTML-раздел документации. Проблема заключается в том, что пользователи хотят сохранить бинарный поток в память для последующей вставки в текущую позицию существующей темы. В качестве примера рассмотрим использование бинарного потока в TMemoryStream, который уже был сохранен на жесткий диск в бинарном формате.

Описание проблемы

Пользователь столкнулся с задачей сохранения Snippet в TMemoryStream для последующей вставки в HTML-раздел текущей темы. Несмотря на то, что Snippet был сохранен в бинарном формате на жесткий диск, прямой способ вставки потока в существующую тему отсутствует, и есть необходимость сохранения потока в формате HTML или текста.

Пример кода для HelpNDoc Pascal-Engine

Для демонстрации проблемы приведем пример кода, который пытается обработать Snippet в рамках Pascal-скрипта HelpNDoc:

function getCustomHintBoxCode(content: String): String;
var _idx: Integer;
var _arr: THndLibraryItemsInfoArray;
var _inf: THndLibraryItemsInfo;
var _tmp, _str: String;
...
begin
  _arr := HndLibraryItems.GetItemList([7]); // 7 = Snippets
  ...
  // Здесь код обрабатывает список Snippetов и сохраняет их содержимое на диск
  ...
end;

Подтвержденное решение

Пользователь нашел решение проблемы, используя несколько шагов:

1. Добавление новой переменной в библиотеку элементов с названием "hintbox_1".
2. Установка заполнителя строки как "pophtml".
3. Добавление нового перечисления для переменных с типами HintBox.
4. Создание файлов 001.html в поддиректории ".\helpers".
5. Изменение шаблона Pascal "topics.pas.htm" для соответствия нуждам пользователя.
6. Компиляция проекта и замена текста файла 001.html в текущей позиции темы.

Пользователь предоставил вспомогательную функцию, которая позволяет получить содержимое переменной, определенной в шаблоне, и вставить его в текущую позицию во время компиляции проекта:

function getCustomHintBoxCode(content: String): String;
var _idx, _len: Integer;
var _txt, _tmp, _str: String;
var _arr: THndLibraryItemsInfoArray;
var _inf: THndLibraryItemsInfo;
var _lst: TStringList;
...
begin
  ...
  // Здесь код обращается к содержимому переменной HintBox и вставляет его содержимое в HTML-раздел
  ...
end;

Комментарий пользователя

Пользователь выразил надежду, что предоставленный код окажется полезным для других пользователей HelpNDoc. Он также предложил сотрудничество по вопросам скриптинга в HelpNDoc и предоставил свои контактные данные для связи.

Заключение

В данной статье был рассмотрен пример решения проблемы, с которой сталкиваются разработчики при использовании HelpNDoc для создания документации с использованием Pascal-скриптов. Представленный подход позволяет более гибко работать с вставкой содержимого в HTML-разделы документации, используя бинарные потоки.

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

Проблема заключается в необходимости вставки бинарного потока в HTML-раздел документации в HelpNDoc с использованием Pascal-скрипта для сохранения содержимого Snippetов в формате, подходящем для вставки в веб-страницы.

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

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

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