Статьи

Создание help-файла (справки) в формате CHM для MS Access-приложения в Dr.Explain

Программа Dr.Explain предназначена для создания структурированных документов, содержащих текстовую, графическую и видео информацию. Dr.Explain позволяет удобно и быстро создавать файлы справки, руководства пользователя и другие документы. Благодаря функции захвата и анализа окна приложения можно без труда создать исчерпывающее описание любого интерфейса, в том числе приложения созданного на базе Microsoft Access. А использование функции экспорта созданного документа в форматы: HTML, CHM, RTF или PDF позволит не только включить созданное руководство в состав пакета документации, или подготовить его для использования в web, но и интегрировать в виде справочной системы непосредственно в приложение.

В данной инструкции описан процесс создания в программе Dr. Explain файла справки для Microsoft Access приложения и его последующая интеграция в формы базы данных.



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

При запуске программы Dr. Explain автоматически открывается окно "Проекты Dr.Explain" (Рисунок 1).

Рисунок 1 - Окно "Проекты Dr.Explain"

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

Пункт "Импортировать внешние файлы" позволяет загрузить основное содержимое документа из файлов CHM, HTML, XML, HLP, TXT, RTF и документов Microsoft Word.

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

Рисунок 2 - Окно текущего проекта



Создание и редактирование основных разделов документа

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

Создание и редактирование текстовых разделов

Для заполнения страниц документа, необходимо вводить либо вставлять из буфера обмена текст в основной области редактирования страницы. Для работы с текстом предусмотрены основные элементы управления (Рисунок 3).

Рисунок 3 - Элементы управления для редактирования текста

Возможности редактирования включают в себя основные стандартные функции, такие как: изменение стиля, изменение шрифта, его размера, цвета и способа начертания (жирный, курсив и подчеркнутый, верхний/нижний индекс), выключка теста (по левому краю, по центру, по правому краю и по ширине), создание списков и проверка орфографии. Также предусмотрена возможность вставки различных объектов, таких как: ссылки, изображения, видеоролики, таблицы, переменные, html - фрагменты, горизонтальные линии, заголовки темы, изображения экрана, контрола и оглавления раздела.

Работа с элементами редактирования в целом аналогична работе с одноименными функциями в любом текстовом редакторе, например MS Word.

Создание описания интерфейса приложения

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

Чтобы создать такой раздел нажмите кнопку "Схватить экран" в главном меню программы, после чего откроется окно "Захват объекта" (Рисунок 4).

Рисунок 4 - Окно "Захват объекта"

Далее выберите интересующее приложение и захватите его нажатием клавиши PrtScr (Print Screen), либо Ctrl +Клик левой кнопкой мыши, либо одновременным кликом правой и левой кнопок мыши.

Захваченный экран будет автоматически проанализирован и в окне программы Dr. Explain появится дополнительная область для работы с аннотированным изображением (Рисунок 5), при этом в основной области редактирования так же отображается аннотированное изображение и пронумерованные блоки с изображением отдельных элементов для их последовательного описания (Рисунок 6).

Рисунок 5 - Область работы с аннотированным изображением

Рисунок 6 - Основная область редактирования после добавления аннотированного изображения

Для редактирования аннотированного изображения в программе предусмотрено три режима, которые переключаются кнопками: "Дизайнер", "Области контролов" и "Редактор экрана", расположенными в левой части области работы с изображением (Рисунок 5).

Режим "Дизайнер" позволяет добавлять, удалять, скрывать нумерованные линии-выноски с названиями контролов, изменять расположение линий и названий, выравнивать взаимное расположение названий контролов, и настраивать общий стиль выносок. Также в режиме "Дизайнер" можно изменить размеры изображения или заменить захваченное изображение интерфейса повторным захватом экрана, либо изображением из файла или буфера обмена. Все перечисленные действия выполняются с помощью кнопок, расположенных в верхней части области работы с изображением (Рисунок 7).

Рисунок 7 - Кнопки редактирования аннотированного изображения

Для добавления, скрытия и удаления линий-выносок используйте кнопки . Для того чтобы изменить расположение линии-выноски и соответствующего ей названия выделите левой кнопкой мыши линию, затем захватите элемент, который необходимо переместить (название с номером, либо свободный конец линии-выноски ) и перетащите его на нужное место.

Чтобы изменить область контрола, которой соответствует определенная линия-выноска нажмите сначала кнопку , которая отобразит все области контролов, затем выделите область контрола, которую хотите изменить, захватите ее и перетащите на нужное место. Для изменения размеров области после ее выделения потяните левой кнопкой мыши за соответствующий край.

После того как вы создали все необходимые линии-выноски и указали соответствующие им области контролов, необходимо выровнять расположение названий. Для этого, зажав левую кнопку мыши на свободном поле, растяните область выделения на нужные элементы. После выделения элементов воспользуйтесь кнопками выравнивания и распределения .

Кнопка открывает окно настроек аннотирования и области дизайнера. Здесь можно настроить стиль аннотаций и тень для изображения (Рисунок 8).

Рисунок 8 - Настройка стиля аннотаций

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

В режиме "Области контролов" отображается полный список всех имеющихся контролов. При выделении позиции списка соответствующая ей область выделяется в окне изображения, а в основной области редактирования выделяется текстовый блок соответствующий данному контролу. В данном режиме можно добавить, удалить и скрыть/отобразить отдельные контролы.

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

Режим "Редактор экрана" позволяет добавлять надписи непосредственно на изображение. Для редактирования текста доступны основные стандартные функции.

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

При заполнении названия элемента интерфейса в текстовом блоке, автоматически изменяется название соответствующей линии-выноски и название контрола в списке в режиме "Области контролов".

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

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

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

Программа Dr. Explain позволяет создать документ или отдельные его разделы, импортировав содержимое из внешнего файла. Данная функция поддерживает импорт из следующих источников: Compiled HTML help (CHM) файлов, одиночных HTML файлов, HLP файлов, RTF файлов, документов Microsoft Word, а также из папок с файлами HTML, TXT и XML.



Редактирование структуры документа

Для создания новых страниц, разделов и подразделов, а также для редактирования структуры документа предназначена область списка в левой верхней части окна текущего проекта (Рисунок 9).

Рисунок 9 - Область списка страниц проекта

Для изменения порядка следования разделов и страниц воспользуйтесь пунктами "Выше"/"Ниже" контекстного меню, которое открывается при нажатии правой кнопки мыши на соответствующей позиции списка. Для переименования страницы выделите ее нажатием левой кнопки мыши, затем повторно щелкните по ее названию.

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

Кнопка включает/отключает запрет внесения изменений для выбранной позиции списка.

Особенности структуры файла справки Microsoft Access приложения

Приложения Microsoft Access, как правило, являются надстройками над базами данных, поэтому для них характерно наличие в одном приложении нескольких различных форм с отличающимся интерфейсом. При этом каждая из таких форм может содержать большое количество различных полей для ввода информации, а так же те или иные элементы управления. Функционал программы Dr.Explain позволяет создать документ, структура которого будет максимально соответствовать структуре описываемого приложения.

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

  • кликните правой кнопкой мыши на позиции с названием проекта, которая находится в самом верху списка страниц и разделов;
  • в открывшемся меню выберите пункт "Добавить";
  • во вложенном меню выберите пункт "Добавить тему с аннотированным экраном" (для создания раздела с описанием главного интерфейса приложения);
  • во вложенном меню выберите пункт "Добавить тему" (для создания текстовых разделов с описанием отдельных форм).

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



Работа с начальной страницей и страницей оглавления. Создание ключевых слов.

Начальная страница и страница оглавления автоматически включаются в структуру документа при создании нового проекта.

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

Страница "Оглавление" заполняется автоматически в соответствии со структурой документа (Рисунок 10). Редактирование оглавления сводится к изменению заголовка страницы и скрытию/отображению по необходимости отдельных разделов, подразделов и страниц.

Рисунок 10 - Редактирование страницы "Оглавление"

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

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

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

Для создания ключевых слов используйте область работы с ключевыми словами (Рисунок 11), которая открывается в левой нижней части окна текущего проекта после нажатия на кнопку "Ключевые слова", расположенную под областью списка разделов, подразделов и страниц. Предложенные элементы управления позволяют добавлять и удалять термины, а также настроить ссылки на соответствующие каждому термину разделы и страницы документа.

Рисунок 11 - Область работы с ключевыми словами



Предварительный просмотр и экспорт документа. Сохранение проекта.

После того как работа над документом завершена, необходимо экспортировать его в интересующий формат. Dr. Explain позволяет сохранять созданные документы в форматах HTML, CHM, RTF и PDF. Перед тем как приступить к экспорту документа воспользуйтесь функцией предварительного просмотра (Рисунок 12), для этого используйте кнопки в верхней части окна текущего проекта.

Рисунок 12 - Предварительный просмотр документа в формате CHM

Кнопка "Редактор" возвращает окно текущего проекта в режим редактирования документа. Обратите внимание, что функция предварительного просмотра не доступна для формата RTF.

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

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

Для экспорта в интересующий формат используйте кнопки в основной панели элементов управления окна Dr.Explain.

Для дальнейшей интеграции созданного файла справки в приложение Microsoft Access рекомендуется использовать формат CHM. После нажатия кнопки , открывается окно "Экспорт в CHM". В этом окне предлагается провести проверку документа перед началом экспорта и открыть экспортированный файл по завершении процесса.

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

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



Интеграция файла справки в MS Acсess приложение

Для интеграции созданного файла справки в приложение необходимо создать в формах базы данных элемент управления, который будет вызывать файл справки (Рисунок 13).

Рисунок 13 - Форма "Заявка на аренду" с кнопкой "Справка"

Для этого выполните следующие действия:

  • откройте интересующее приложение в Microsoft Access;
  • откройте форму, в которой хотите создать элемент вызова файла справки;
  • перейдите в режим конструктор, для этого щелкните по форме правой кнопкой мыши и выберите в меню пункт "Конструктор";
  • выберите элемент "Кнопка" в открывшемся разделе "Элементы управления" главной панели быстрого доступа Microsoft Access (панель расположенная в верхней части окна Microsoft Access);
  • разместите элемент на свободном поле выбранной формы;
  • после размещения элемента, в панели справа отображаются его свойства, если панель свойств отсутствует, то нажмите кнопку "Страница свойств" в разделе "Сервис" панели быстрого доступа;
  • в окне свойств в закладке "Другие" введите название элемента, например "Help" в поле "Имя";
  • если требуется введите текст всплывающей подсказки, в одноименное поле;
  • в закладке макет в поле "Подпись" введите подпись, которая будет отображаться на кнопке, например "Справка";
  • затем перейдите к закладке "События"и нажмите кнопку в поле "Нажатие кнопки";
  • в открывшемся окне выберите пункт "Программы" и нажмите "ОК", после чего откроется окно кода элемента в приложении Microsoft Visual Basic (Рисунок 14);

Рисунок 14 - Код элемента в Microsoft Visual Basic

  • в строке "Private Sub Help_Click()" отображается имя вашего элемента (в данном случае "Help"). Введите ниже строку - Call Shell("explorer.exe " & CurrentProject.Path & "\help.chm", vbNormalFocus), где help.chm -имя файла справки в формате CHM. После чего весь код элемента управления должен иметь вид:

Private Sub Help_Click()

Call Shell("explorer.exe " & CurrentProject.Path & "\help.chm", vbNormalFocus)

End Sub

  • закройте окно Microsoft Visual Basic;
  • сохраните форму;
  • проверьте корректную работу элемента управления, для этого откройте форму и нажмите кнопку "Справка", после чего должен открыться файл справки созданный ранее в программе Dr.Explain;
  • повторите описанную процедуру для всех форм, в которые необходимо вставить элемент вызова справки.

ОБРАТИТЕ ВНИМАНИЕ! Для корректной работы элемента вызова файла справки необходимо, чтобы файл в формате CHM и файл базы данных находились в одной директории. Если есть необходимость разместить файл справки отдельно от файла базы данных, то используйте такую строку кода элемента управления Shell "cmd /cstart D:\work\techwrite\help.chm", где D:\work\techwrite\help.chm - полный путь до файла справки в формате CHM. Код в целом будет иметь вид:

Private Sub Help_Click()

Shell "cmd /cstart D:\work\techwrite\help.chm"

End Sub

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

Будьте внимательны при вводе кодов управляющих элементов, строго соблюдайте синтаксис, приведенный в примерах, это является обязательным условием правильной работы элемента вызова файла справки.