Для настройки отображения пользовательской справки необходимо:
- Указать путь к папке справки в файле конфигурации:
Пример
"UserGuideDirectory": "/opt/avanpost/idm/web/AppData/UserGuide/"
- Разместить структуру справки. В каталог
UserGuideнеобходимо поместить содержимое экспорта (например, Confluence), включая:- index.html
- папки с ресурсами (css, js, images)
Важно!
Структура должна сохраняться полностью как в экспорте - Проверка index.html. Файл index.html должен:
- быть в корне экспортированной структуры;
- не содержать ссылок, зависящих от внешнего окружения Confluence;
- корректно ссылаться на локальные ресурсы (относительные пути).
- Стили IDM
Для корректного отображения рекомендуется добавить пользовательские стили..toc-macro { display: none !important; }
Если API возвращает HTML, но в UI пусто, обычно причина одна из следующих:
- неверный путь в UserGuideDirectory
- отсутствует или не найден index.html
- нарушена структура экспортированной папки (не сохранена иерархия Confluence)
- ресурсы (css/js) не доступны по относительным путям
- браузер блокирует рендер из-за некорректных скриптов из Confluence-экспорта