Документация Avanpost IDM 7 : 5.9. Настройка пользовательской справки

Документация Avanpost IDM 7 : 5.9. Настройка пользовательской справки

Для настройки отображения пользовательской справки необходимо:

  1. Указать путь к папке справки в файле конфигурации:

    Пример

    "UserGuideDirectory": "/opt/avanpost/idm/web/AppData/UserGuide/"
  2. Разместить структуру справки. В каталог UserGuide необходимо поместить содержимое экспорта (например, Confluence), включая:
    • index.html
    • папки с ресурсами (css, js, images)

    Важно!

    Структура должна сохраняться полностью как в экспорте
  3. Проверка index.html. Файл index.html должен:
    • быть в корне экспортированной структуры;
    • не содержать ссылок, зависящих от внешнего окружения Confluence;
    • корректно ссылаться на локальные ресурсы (относительные пути).
  4. Стили IDM
    Для корректного отображения рекомендуется добавить пользовательские стили.
    .toc-macro { display: none !important; }

Если API возвращает HTML, но в UI пусто, обычно причина одна из следующих:

  • неверный путь в UserGuideDirectory
  • отсутствует или не найден index.html
  • нарушена структура экспортированной папки (не сохранена иерархия Confluence)
  • ресурсы (css/js) не доступны по относительным путям
  • браузер блокирует рендер из-за некорректных скриптов из Confluence-экспорта

Обсуждение