Работа с ключевыми словами в HelpNDoc: создание, редактирование и атрибуты

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

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

Проблема пользователя

Пользователь столкнулся с проблемой создания ключевых слов в HelpNDoc с помощью API в редакторе сценариев. Без передачи параметров в функцию HndKeywords.CreateKeyword создается новое ключевое слово с базовыми атрибутами. Однако, пользователю необходимо настроить текст ключевого слова, атрибут href и объект data-related для полноценной работы.

Описание решения

Для решения этой проблемы необходимо использовать дополнительные функции API HelpNDoc. После создания ключевого слова с помощью функции HndKeywords.CreateKeyword, можно получить его идентификатор для дальнейшего редактирования. Используя функцию SetKeywordCaption, можно изменить текст ключевого слова. Для настройки атрибутов href и data-related нет прямых функций, но можно использовать функцию AssociateTopicWithKeyword, которая позволяет связать ключевое слово с определенной темой, что косвенно может влиять на атрибуты.

Подробное руководство

1. Создание нового ключевого слова:

var new_keyword := HndKeywords.CreateKeyword;

1. Получение идентификатора созданного ключевого слова:

var aKeywordList := HndKeywords.GetKeywordList();
var newlyaddedkeyword_array_id := Length(aKeywordList) - 1;
var newlyaddedkeyword_id := aKeywordList[newlyaddedkeyword_array_id].Id;

1. Редактирование текста ключевого слова:

var edit_keyword_caption := HndKeywords.SetKeywordCaption(newlyaddedkeyword_id, "Измененный текст ключевого слова");

1. Связывание ключевого слова с темами:

var topic_array := HndTopics.GetTopicList;
var topic_id := topic_array[4].ID; // Например, пятый элемент списка тем
var keyword_topic_link := HndTopicsKeywords.AssociateTopicWithKeyword(topic_id, newlyaddedkeyword_id);

Связывание ключевого слова с темами позволяет косвенно настроить атрибуты href и data-related, так как при связывании с определенной темой HelpNDoc автоматически может обновлять эти атрибуты в соответствии с настройками тем.

Альтернативный ответ и дополнительные замечания

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

Подтвержденный ответ и рекомендации

Подтвержденный ответ указывает на то, что для редактирования названия ключевого слова после его создания необходимо использовать функцию SetKeywordCaption, которая требует идентификатор ключевого слова. Для добавления информации data-related можно использовать функцию AssociateTopicWithKeyword, передавая ей идентификаторы связанных тем и ключевого слова.

Рекомендуется также обратиться к официальной документации HelpNDoc по API для ключевых слов, чтобы получить более полное понимание возможностей и правил работы с ключевыми словами: HndKeywords - Свойства и методы для ключевых слов.

Заключение

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

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

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

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

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

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