Как определить ключевые слова в helpndoc с помощью API в редакторе скриптов

Question

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

      HndKeywords.CreateKeyword;

Выход:_keywords.json

      [{ "id": "B3BF561185624A4685FB01E93FE5ED87", "parent" : "#", "text": "New keyword", "a_attr": {"href": "#", "data-related": "[]"} }]

Answer 1

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

       function SetKeywordCaption(const aKeywordId: string; const sNewCaption: string): string;
function AssociateTopicWithKeyword(const aTopicId: string; const  aKeywordId:string): Boolean;

Чтобы отредактировать заголовок ключевого слова, я должен использовать функцию, которой нужен идентификатор ключевого слова. Для этого я получаю список ключевых слов с помощью функции GetKeywordList();и он возвращает массив. Я получаю числовой идентификатор последнего элемента из этого массива, который является недавно вставленным ключевым словом. Затем получите доступ к aKeywordListмассив, используя последний идентификатор массива элементов, и добавьте .Idкоторый получит идентификатор этого ключевого слова. Затем, используя идентификатор ключевого слова с функцией SetKeywordCaption, возможность редактировать заголовок ключевого слова.

Чтобы добавить информацию, связанную с данными, у меня есть функция использования, которая требует topic idа также keyword id. Я получаю список тем, используя функцию GetTopicList. Я получаю идентификатор темы пять ( topic_array[(5-1)].ID) и шестая тема( topic_array[(6-1)].ID). Затем воспользовались функцией AssociateTopicWithKeywordчтобы связать ключевое слово с темами.

Вызовите функцию helpndoc:

Объект.функция

бывший ( HndKeywords.CreateKeyword;)

      var new_keyword                :=HndKeywords.CreateKeyword;
var aKeywordList                =HndKeywords.GetKeywordList() ;
//get keyword added last
var newlyaddedkeyword_array_id  =length(aKeywordList) - 1 ;
var newlyaddedkeyword__id       =aKeywordList[newlyaddedkeyword_array_id].Id;
var edit_keywordcaption         =HndKeywords.SetKeywordCaption(newlyaddedkeyword__id, "Edited keyword");
var topic_array=HndTopics.GetTopicList; 
var keywordtopics         =HndTopicsKeywords.AssociateTopicWithKeyword(topic_array[4].ID,newlyaddedkeyword__id);//parameter : topic id and keyword id
var keywordtopics2          =HndTopicsKeywords.AssociateTopicWithKeyword(topic_array[5].ID,newlyaddedkeyword__id);

Видеть:HndKeywords- Свойства и методы для ключевых слов