Использовать WebHelp как источник контекстной помощи

Обычно Контекстная Помощь отображает контент из онлайн-публикации. Однако если вы размещаете документацию в формате WebHelp на своем сервере, а не на портале Документерра, вы можете использовать её в качестве источника. 

Чтобы реализовать контекстную помощь на основе WebHelp, выполните следующие действия:

  1. Перейдите в Свойства → Контекстная Помощь на любой странице.
  2. В разделе HTML код контекстной помощи вы увидите HTML-код, сгенерированный системой. Найдите строку, содержащую ссылку на скрипт контекстной помощи:Строка кода в разделе "HTML код контекстной помощи"
  3. Скачайте файл скрипта с вашего портала по указанному URL.
  4. Разместите его вместе с контентом HTML 5 WebHelp.
  5. Обновите URL в сниппетах контекстной помощи, чтобы они указывали на новое расположение скрипта.
  6. Измените URL страниц в сниппетах так, чтобы они ссылались на HTML-файлы вашего WebHelp, а не на портал. URL хранятся в параметре data-chpw-contentUrl:URL страницы в data-chpw-contentUrl

После этих действий вы сможете использовать контекстную помощь для своей документации в формате WebHelp.

Встроенный поиск WebHelp

Вы можете встроить панель поиска WebHelp в веб-приложении. Для этого:

  • Используйте файл search.html в качестве значения параметра data-chpw-contentUrl.
  • Укажите параметр noredirect в URL файла search.html.

Опционально, вы можете настроить автоматический поиск по заранее заданному запросу, передав его через параметр q в URL. Например: search.html?noredirect=1&q=test