# Подключение справки

Модуль «Подключения справки» (admin-modules-help-XXX.jar) позволяет связать пункт меню со страницей в Интернете (URL), либо подключить справочный файл. В случае использования пункта меню для открытия справки, в браузере открывается либо страница в Интернете, либо справочный файл системы. Но пункт меню может быть связан с интерфейсным модулем (см. настройки меню). В этом случае справочный файл открывается в браузере из интерфейса модуля.

Внешний вид формы подключения справки, представленный на скриншоте, включает три панели. В левой части отображается список Разделов приложения. В центральной части (Навигация) представлен список пунктов меню, связанный с выделенным разделом. В правой части (Панель редактирования) отображаются параметры выделенного пункта меню и настройки справки.

Пункты меню в интерфейсе могут иметь разные расцветки. Красным цветом отображаются пункты меню, пока еще не связанные с модулями. Малиновым цветом отображаются пункты меню, которые связаны с модулями, но к которым файлы/справки еще не подключены. Зеленый цвет имеют пункты меню для вызова непосредственно справки/помощи, но для которых ещё не не определен URL. Пункты меню с уже определенными параметрами справки отображаются Черным цветом.

Примечание.
1. Пункт меню может быть связан либо с модулем приложения, либо со справкой. Это определяется в Настройках меню. Соответственно страницы в интернете (файлы справки), открываемые в браузере, могут быть подключены непосредственно к пункту меню, либо к связанному с пунктом меню модулю.
2. Чтобы вызвать файл-справку из интерфейсного модуля необходимо, чтобы наименование модуля (artifactId) и наименование файла-справки без расширения совпадали. К примеру, как представлено на скриншоте, файл admin-modules-help.html можно открыть в браузере из интерфейсного модуля admin-modules-help-1.0.0.jar.

## Справка в Интернете

На следующем рисунке представлена панель навигации раздела «Справки». К выделенному пункту меню «Классификатор ОКАТО» подключается страница в интернете. Для этого, выбирается кнопка URL; поля, связанные с локальным файлом, блокируются. В поле «URL страницы в интернете» необходимо определить адрес и нажать кнопку Сохранить.

После сохранения записи программа не позволит изменить связанную с пунктом меню страницу на локальный файл. Чтобы переключить пункт меню со страницы в интернете (URL), на локальный файл, либо наоборот, необходимо сначала Удалить запись, и после этого, подключить справку.

На заметку. Для выделенного пункта меню поле «Наименование модуля» не заполнено; это связано с тем, что к пункту меню подключается справка.

## Локальный справочный файл

Чтобы загрузить справочный файл в систему необходимо предварительно разместить файл в поддиректории «/doc», а используемые в справке изображения в поддиректории «/doc/images». При сохранении справки проверяется наличие файла и его изображения в соответствующих поддиректориях.

После выделения пункта меню в панели навигации и определения флага «Файл» можно выбрать файл справки в отдельном стандартном окне нажатием на кнопку . Выбранный файл отображается в нередактируемых компонентах формы (Наименование, Размер файла, Дата изменения). Кроме этого, выполняется проверка наличия файлов изображений, используемых в справке. Если все используемые изображения найдены в поддиректории «/doc/images», то в поле Количество изображений появится соответствующая запись «n из n», где n - количество используемых в справке изображений (дублирование не учитывается). В противном случае, надпись подсветится красным цветом и текст будет отображать существующее соотношение изображений (кол-во в поддиректории и кол-во в справке). Список изображений, используемых в справке можно просмотреть в отдельном окне

Примечание. Если пункт меню должен быть связан с модулем, который еще не подключен к системе, то форма не позволит загрузить в систему файл справки.

## Вызов локального файла справки

При вызове локальной справки система проверяет наличие соответствующего файла в поддиректории «/doc». Если файл справки не найден, то он будет выгружен из системы (базы данных), включая связанные с файлом изображения. Используемые в справке изображения выгружаются в поддиректорию «/doc/images». Таким образом, вновь подключенный к системе интерфейсный модуль со справкой не нужно устанавливать на компьютеры пользователей, использующих общее информационное пространство; при необходимости приложение выгружает из системы (базы данных) отсутствующие файлы помощи в локальные поддиректории.

Примечание. Если в базе данных более «свежий» файл, чем в локальной директории по параметру «Дата последнего изменения» (lastModified), то файл справки и его изображения будут автоматически обновлены.

## Просмотр локальной справки

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

На скриншоте представлен файл локальной справки admin-modules-help.html, в который внесены следующие изменения :

- в справке появилось изображение «db-exclamation.png» (в БД отсутствует);
- из справки удалено изображение «image.png» (локально отсутствует);
- изменилось изображение «admin-modules-help2.png».

В результате внесенных изменений в справочный файл в соответствующих ячейках установлены флаги отличий. Если сейчас нажать на кнопку «Сохранить», то соответствующие файлы будут записаны в систему и при повторном открытии окна расхождений между локальной справкой и справкой в БД не будет.