Создание тематических разделов в файле справки

Создание и настройка нового проекта

Для создания нового проекта файла справки с возможностью последующего экспорта в файл формата CHM в Dr.Explain выберите пункт «Создать новый проект» в стартовом окне программы, либо перейдите в пункт «Файл -> Создать» главного меню программы.

Рис. 2. Стартовое окно программы Dr.Explain

Перейдите в пункт меню «Настройки -> Настройки проекта» и в открывшемся диалоговом окне перейдите в раздел «CHM экспорт -> Управление Help ID». Для осуществления последующей привязки проекта Delphi к темам файла справки установите флаг «Экспорт Help ID в CHM». Нажмите кнопку «OK» для применения настроек к проекту.

Рис. 3. Окно «Настройки проекта»

После применения настроек для каждой уже созданной темы и каждой новой создаваемой в дальнейшем теме будет автоматически присвоен уникальный цифровой идентификатор HelpID.

Создание тематических разделов в файле справки

Удобная структура файла справки достигается путем создания тематических разделов на формы и объекты описываемого приложения.

Создайте темы файла справки, перейдя в пункт меню «Настройки -> Добавить тему», или нажмите правой кнопкой мыши на дерево проекта в левой части экрана, после чего в открывшемся меню выберите пункт «Добавить -> Добавить тему». Для полного описания Delphi-приложения создайте темы для каждого его объекта. В таком случае в приложении по нажатию клавиши F1 будет открываться информация об объекте, на котором находится фокус.

Рис. 4. Дерево проекта Dr.Explain

В дереве проекта укажите название созданных тем и определите их порядок, используя соответствующие пункты меню.

Перейдите в нужную тему в дереве проекта и в окне редактора введите содержимое раздела в свободной форме. В окне редактора имеется стандартный функционал для форматирования текста.

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

Рис. 5. Ключевые слова

Для создания описания конкретного объекта Delphi-приложения (в том числе и формы в приложении) также можно воспользоваться кнопкой «Схватить экран».

Рис. 6. Окно «Захват проекта»

В открывшемся диалоговом окне нажмите на пиктограмму «Accessible-объект» или «Win32-окно», после чего перейдите в окно приложения Delphi и выберите описываемый в разделе объект одним из указанных способов:

· Нажмите на клавишу PrtScr;

· Нажмите на объект, удерживая нажатой клавишу Ctrl;

· Поочередно кликните двумя кнопками мыши по объекту.

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

Рис. 7. Результат выполнения захвата объекта

Дата добавления: 2015-10-31