Помимо встроенных возможностей документирования, в Системе предусмотрена возможность интегрирования с внешними системами создания файлов документации.

Возможности подобного интегрирования будут рассмотрены далее на примере программного обеспечения HELP&MANUAL версии 5.6.0 (страница для скачивания здесь ). HELP&MANUAL является инструментом для создания документации, а также системой управления контентом. Данный продукт является коммерческим.

- Скачать дистрибутив программы с сайта разработчика ( http://www.helpandmanual.com/downloads.html ) 

- Запустить исполняемый файл установщика hmsetup.exe . Начнется процесс установки.

Первый экран установки программы - приветствие:

Нажать "Next".

Экран лицензионного соглашения:

Выбрать пункт "I accept the agreement", нажать "Next".

Экран выбора директории установки:

Здесь необходимо выбрать папку на жестком диске компьютера для установки Help&Manual, нажать "Next".

Экран выбора компонентов программы для установки:

Можно оставить без изменений, нажать "Next".

Экран выбора наименования группы программ в меню "Start" ("Пуск"):

Нажать "Next".

Экран дополнительных установок:

Здесь можно указать, должен ли установщик разместить значок Help&Manual для запуска программы на рабочем столе компьютера. Сделать выбор, нажать "Next".

Сводный экран установки программы:

Здесь указаны все параметры установки программы, выбранные на предыдущих шагах. Если необходимо внести изменения в параметры, можно воспользоваться кнопкой "Back". Если все параметры верны, нажать кнопку "Install".

Начнется процесс установки программного обеспечения:

После установки будет выведен полседний экран:

Чекбокс "Launch Help&Manual" позволяет запустить программное обеспечение сразу после нажатия на кнопку "Finish".

При первом запуске программы будет выведен запрос на ввод код активации полного функционала программы:

Здесь необходимо указать серийный номер (Serial Number) и код активации (Activation Code). Данная информация доступна после приобретения программы. После ввода нажать кнопку "ОК". Программа готова для работы.

После запуска программы будет выведено окно приветствия:

Для создания нового проекта документации необходимо воспользоваться кнопкой  или комбинацией клавиш "Alt+1".

Откроется окно выбора параметров нового проекта:

Оставляем параметры без изменений и нажимаем кнопку "Next".

Следующее окно параметров:

В поле "Output File"  необходимо указать название и место расположения на жестком диске файла проекта. Расширение файла оставляем без изменения. В поле "Project Title" можно ввести наименование проекта документации. В поле "Project Language" указывается язык проекта.

Важно!

В поле "Character Set" должно быть установлено значение "RUSSIAN_CHARSET".

Нажать кнопку "Next".

Окно создания структуры проекта документации:

В этом окне можно задать предварительную структуру будущего документа. Пункты оглавления можно создавать, удалять, перемещать по списку. Структуру проекта можно будет изменять в дальнейшем в процессе работы. После нажатия кнопки "ОК" структура документа, описанная здесь, будет создана автоматически.

Главное окно программы:

В левой части расположено навигационное дерево статей проекта документации, в правой отображается содержимое статей.

После того, как статьи созданы, необходимо добавить ключевые слова и фразы, для этого необходимо перейти на вкладку "Topic Options":

 Откроется окно установки свойств статьи:

Здесь в поле "Keywords" необходимо указать ключевые слова и фразы, по которым будет осуществляться переход из системы в соответствующую статью.

После того как все необходимые статьи созданы, ключевые фразы добавлены, файл документации нужно сохранить в формате chm. Для этого используется кнопка "Publish".

После ее нажатия будет выведено окно выбора формата конечного файла:

Здесь выбирается вкладка "HTML Help (.chm)", указывается путь на жестком диске для сохранения.

После нажатия кнопки "ОК" файл будет сохранен в нужном формате.

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

Для примера разберем связывание соответствующей статьи файла документации и формы Зарегистрировать, вызываемой с помощью пункта контекстного меню "Зарегистрировать" из таблицы Абитуриенты бакалавриата раздела Абитуриенты бакалавриата текущего набора участка Абитуриент.

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

Важно!

Созданный в программе Help&Manual файл документации, должен находится в одной папке с запускаемым файлом DataBrowser.exe обозревателя DataMill.

Подпрограмма "Зарегистрировать" ("Register") является дочерней по отношению к классу "Абитуриент бакалавриата" ("TBachAbiturSt").

В Системе нужно открыть раздел Системная форма участка Администратору. На вкладке Классы при помощи фильтра по имени или наименованию найти класс "Абитуриент бакалавриата" ("TBachAbiturSt"). В подчиненном представлении перейти на вкладку Подпрограммы и найти подпрограмму "Зарегистрировать" ("Register"). В подчиненном представлении перейти на вкладку Ключи контекстной помощи, вызвать контекстное меню и воспользоваться пунктом "Создать".

Откроется окно ввода параметров:

В поле "Ключевое словосочетание" указывается ключевое слово или фраза, в том виде как они прописаны в программе Help&Manual в свойствах соответствующей статьи.

В поле "Хранилище" указывается имя chm-файла документации без расширения, который содержит в себе данную статью.

После нажатия кнопки "Ок" ключ будет добавлен в таблицу.

Таким образом, после вызова справки из формы "Зарегистрировать" пользователь увидит соответствующую статью:

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