Статьи

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


Введение

Данная статья посвящена созданию файла справки в формате CHM и его последующей интеграции в книгу Microsoft Excel. Из статьи вы узнаете:

  • как создать и настроить проект в программе Dr.Explain;
  • как работать со структурой файла справки;
  • как создать аннотированное изображение книги Microsoft Excel;
  • как сохранить проект;
  • как экспортировать проект в СHM файл;
  • как создать элемент вызова файла справки в Microsoft Excel и настроить соответствующий элементу макрос.



Установка Dr.Explain

Для загрузки установочного файла программы Dr.Explain воспользуйтесь кнопкой «Скачать бесплатно» на официальном сайте продукта по адресу http://www.drexplain.ru/. После окончания загрузки запустите файл. Для успешного завершения стандартного процесса установки следуйте указаниям мастера (Рисунок 1).

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

Рисунок 1. Мастер установки «Dr.Explain»


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

Для создания нового проекта файла справки, выберите пункт «Создать новый проект» в окне «Проекты Dr.Explain» (Рисунок 2) и нажмите «ОК», либо используйте пункт «Создать» в меню «Файл».

Рисунок 2. Окно «Проекты Dr.Explain»

Для изменения параметров экспорта в формат CHM воспользуйтесь пунктом меню «Настройки -> Настройки проекта -> CHM экспорт».


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

Чтобы структура файла справки была удобной необходимо создать отдельные тематические разделы для описания различных элементов описываемой книги Microsoft Excel.

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

Рисунок 3. Дерево проекта «Dr.Explain»

Для изменения названий тем и их порядка, используйте следующие пункты меню «Переименовать», «Выше» и «Ниже».

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

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

Рисунок 4. Ключевые слова

Для наглядного описания книги Microsoft Excel, а также её отдельных элементов воспользуйтесь функцией «Захват объекта» (Рисунок 5) — кнопка «Схватить экран».

Рисунок 5. Окно «Захват объекта»

В окне захвата нажмите или отметьте поле «Accessible-объект» или «Win32-окно», после чего перейдите в окно Microsoft Excel и выберите описываемый в разделе объект одним из указанных в окне захвата способов.

После захвата объекта в окне редактора будет создана тема, содержащая аннотированное изображение интерфейса приложения (Рисунок 6). Функционал редактора позволяет добавлять и удалять аннотацию отдельных элементов интерфейса, менять порядок следования описания различных элементов.

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


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

Перед тем как приступить к экспорту документа воспользуйтесь функцией предварительного просмотра. Для этого используйте кнопку «Просмотр CHM» в верхней части окна текущего проекта. В режиме предварительного просмотра убедитесь в правильном отображении всех страниц и разделов документа. При необходимости вернитесь в режим редактирования и внесите требуемые изменения.

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


Экспорт проекта в CHM-файл

После того, как все разделы будут заполнены необходимо экспортировать проект, для этого используйте «Настройки -> Экспорт в CHM» главного меню. Для проверки корректности проекта перед экспортом, отметьте поле «Запустить проверку проекта перед экспортом». Если необходимо открыть файл справки сразу после экспорта, установите флаг «Открыть CHM файл». Для перезаписи существующего файла справки без подтверждения пользователем установите флаг «Перезаписать молча». После установки необходимых параметров нажмите кнопку «Начать экспорт». В результате в окне «Экспорт в CHM» (Рисунок 7) будет отображаться отчет о ходе процесса. По окончании процедуры экспорта нажмите кнопку «Закрыть».

Рисунок 7. Окно «Экспорт в CHM»


Интеграция CHM-файла в книгу Microsoft Excel

Для вызова файла справки из книги Microsoft Excel необходимо создать объект, который будет выполнять вызов соответствующего CHM-файла. Таким объектом может являться изображение, фигура либо надпись.

Для создания объекта выполните следующие действия:

  • откройте интересующую книгу в Microsoft Excel;
  • откройте лист, на котором хотите создать элемент вызова файла справки;
  • выделите ячейку или область из нескольких ячеек, в которой должен располагаться элемент вызова справки;
  • добавьте элемент. Для добавления рисунка или фигуры используйте одноименные кнопки подраздела «Иллюстрации» в разделе «Вставка» главного меню, для добавления надписи используйте одноименную кнопку подраздела «Текст» в разделе «Вставка»;
  • если необходимо, измените расположение элемента. Для этого перетащите его мышью на свободное поле;
  • после размещения элемента, создайте подпись для него, например, «Справка»;
  • вызовите контекстное меню нажатием правой кнопкой мыши на добавленном объекте (Рисунок 8);
  • выберите пункт "Назначить макрос" в открывшемся окне нажать правка, после чего откроется окно редактора кода Microsoft Visual Basic (Рисунок 9);



Рисунок 8. Контекстное меню объекта

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

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

Sub Прямоугольник1_Щелчок()
Call Shell("explorer.exe " & ActiveWorkbook.Path & "\help.chm", vbNormalFocus)
End Sub

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


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

Sub Прямоугольник1_Щелчок()
Shell "cmd /cstartD:\work\techwrite\help.chm"
EndSub

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

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

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

  • вызовите контекстное меню нажатием правой кнопкой мыши на добавленном объекте (Рисунок 8);
  • выберите пункт «Гиперссылка»;
  • в открывшемся окне укажите размещение CHM-файла. Для удобства поиска в окно настройки гиперссылки встроен проводник;
  • при необходимости можно ввести текст всплывающей подсказки, для этого используйте кнопку «Подсказка»;
  • после того как гиперссылка настроена, нажмите кнопку «ОК».


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