Создание и сортировка массива структур для хранения информации о темах в скрипте на Pascal для HelpNDoc

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

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

Шаг 1: Определение структуры

Для начала создадим структуру TMyTopicRecord, которая будет содержать идентификатор темы и контекст помощи:

type
    TMyTopicRecord = record
        idTopic : String;
        idContextHelp : Integer;
    end;

Шаг 2: Сортировка массива структур

Далее, мы определим процедуру GetSortedTopicIDs, которая будет принимать массив строк и его размер, а затем сортировать соответствующий массив структур по полю idContextHelp:

procedure GetSortedTopicIDs(aTopics : array of String; size : Integer);
var
    aMyTopicRecords : array of TMyTopicRecord;
    temp : TMyTopicRecord;
    iTopic, i, j : Integer;
begin
    // Инициализация массива
    SetLength(aMyTopicRecords, size);

    // Заполнение массива данными
    for iTopic := 0 to size - 1 do
    begin
        aMyTopicRecords[iTopic].idTopic := aTopics[iTopic];
        aMyTopicRecords[iTopic].idContextHelp := HndTopics.GetTopicHelpContext(aTopics[iTopic]);
    end;

    // Сортировка массива по полю idContextHelp
    for i := size - 1 downto 1 do
        for j := 2 to i do
            if (aMyTopicRecords[j - 1].idContextHelp > aMyTopicRecords[j].idContextHelp) then
            begin
                temp := aMyTopicRecords[j - 1];
                aMyTopicRecords[j - 1] := aMyTopicRecords[j];
                aMyTopicRecords[j] := temp;
            end;

    // Восстановление исходного массива строк
    for iTopic := 0 to size - 1 do
        aTopics[iTopic] := aMyTopicRecords[iTopic].idTopic;
end;

Шаг 3: Использование процедуры сортировки

Процедура GetSortedTopicIDs может быть вызвана внутри другого скрипта или функции, например, в функции GetKeywordsAsHtml, которая отвечает за генерацию HTML-разметки для ключевых слов:

function GetKeywordsAsHtml(): string;
var
    aKeywordList: THndKeywordsInfoArray;
    aAssociatedTopics: array of string;
    // ... другие переменные ...
begin
    // ... код для инициализации ...
    for nCurKeyword := 0 to length(aKeywordList) - 1 do
    begin
        // ... код для обработки текущего ключевого слова ...
        aAssociatedTopics := HndTopicsKeywords.GetTopicsAssociatedWithKeyword(sCurrentKeyword);
        nCountAssociatedTopics := Length(aAssociatedTopics);
        if nCountAssociatedTopics > 0 then
        begin
            GetSortedTopicIDs(aAssociatedTopics, nCountAssociatedTopics);
            // ... дальнейшая обработка ...
        end;
    end;
    // ... завершение функции ...
end;

Шаг 4: Устранение обнаруженных ошибок

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

procedure GetSortedTopicIDs(var aTopics : array of String; iNumTopics : Integer);
var
    iTopic : Integer;
    aList: TStringList;
begin
    aList := TStringList.Create;
    for iTopic := 0 to iNumTopics - 1 do
        aList.Add(Format('%0.3d %s', [HndTopics.GetTopicHelpContext(aTopics[iTopic]), aTopics[iTopic]]));
    aList.Sort;
    for iTopic := 0 to iNumTopics - 1 do
        aTopics[iTopic] := Copy(aList[iTopic], 5, Length(aList[iTopic]) - 4);
    aList.Free;
end;

Этот подход позволяет упорядочить массив тематических идентификаторов, что необходимо для корректного отображения информации в документации.

Заключение

Мы рассмотрели процесс создания и сортировки массива структур для хранения информации о темах в скриптах на Pascal для HelpNDoc. Использование структур и процедур сортировки позволяет разработчикам эффективно управлять данными в рамках документации. При возникновении ошибок важно тщательно проанализировать код и, при необходимости, рассмотреть альтернативные подходы, такие как использование TStringList для сортировки строк.

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

В данном тексте описан процесс создания и сортировки структур для хранения информации о темах в скриптах на Pascal, предназначенных для использования в HelpNDoc, с целью упорядочивания данных для документации.

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

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

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