Help file for excel

Введение

Данная статья посвящена созданию файла справки в формате 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:worktechwritehelp.chm», где D:worktechwritehelp.chm — полный путь до файла справки в формате CHM. Код в целом будет иметь вид:


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


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

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

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

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

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

Смотрите также

• Создание help-файла (справки) в формате CHM для Visual Basic (VB.NET)-приложения для Windows при помощи Dr.Explain
• Создание help-файла (справки) в формате CHM для MS Access-приложения для Windows в Dr.Explain
• Делайте правильно! Публикуем онлайн-документацию на сайте проекта

Dennis Crane

Introduction

This article is devoted to creation of help file in CHM format and its further integration into the Microsoft Excel workbook. From the article you will know:

· How to create and adjust a project Dr.Explain program;

· How to work with a help file structure;

· How to create an annotated image of Microsoft Excel workbook;

· How to save a project;

· How to export a project to CHM format;

· How to create a help file call item in Microsoft Excel and how to set a corresponding macros.

Installing Dr.Explain

To download Dr.Explain installation program, click «Free download» button on the product web-site http://www.drexplain.com. After finishing, run a downloaded program. To complete an installation process, follow the setup wizard instructions (Picture 1).

You can use a trial version; it has the same functional as a full version; however, all images in exported file will have watermarks.

Picture 1. Dr.Explain setup wizard

Creating and saving a new project

To create a new help file project select «Create a new project» radio button in the «Dr.Explain projects» window (Picture 2) and then press «OK». Also you can use «Create» item in the «File» menu.

Picture 2. «Dr.Explain projects» window

To change CHM format export parameters use «Options -> Project settings -> Export to CHM».

Creating help file topics

To make help file structure handy, you have to create separate topics for describing various Microsoft Excel workbook elements.

New topic can be created either by clicking «Options -> Add topic» in the main menu, or by using «Add -> Add topic» pop-up menu item, which can be activated by right-click on any project tree item (Picture 3). To make an exhaustive workbook description you have to create topics for every its element.

Picture 3. «Dr.Explain» project tree

To change order of topics and their names use «Rename», «Move Up» and «Move Down» pop-up menu items. To fill out the particular topic, select it in the project tree and then enter its content in the editor window. There is a standard text editing toolkit as well as some tools for working with images, videos, tables and variables (variables usage allows you to replace recurrent data with variable; in this case if you change variable value, corresponding text will be changed in the whole document).

For increasing a convenience of help file searching you have to create a list of keywords. You can add and delete keywords using buttons located on the panel which can be shown up by pressing the «Keywords» button (Picture 4). To set properties of keywords to topic link, select a corresponding topic in the tree project, and enter labels for the keywords you want to associate the topic with.

Picture 4. Keywords

To make an illustrative description of Microsoft Excel workbook as well as its separate components use «Capture an object» function (Picture 5) – «Snapshot» button.

Picture 5. «Capture an object» window

In capture window check «Accessible-object» or «Win32-window» boxes, then go to Microsoft Excel window and select describable object by one of mentioned in the window ways.

After that a new topic containing annotated interface image will be created in the editor window (Picture 6). Using editor you can add and delete single elements annotations and change order of various items.

Picture 6. Result of object capturing

Previewing and saving a new project

Before you start document export, use the preview function. For this click «CHM preview» button on the top of the current project window. In the preview mode make sure all pages and topics are shown properly. Go back to editing mode and make desired changes if necessary.

If you want to resume your work with the project later it is recommended to save the project. For this use the «File -> Save as» main menu item. After you choose it, the standard save file window will come up where you can enter a file name or point its location.

Exporting project to CHM file

After you fill all topics out you should export your project. For this click «Options -> Export to CHM» in the main menu. If you would like to validate the project before exporting process check «Run the validation tool before exporting». If you want generated file to be open immediately after the exporting process, tick «Open CHM file» check box. To overwrite an existing file with no user confirmation tick «Overwrite silently» check box. After you set all desired parameters click «Start export» button. You will see «Export to CHM file» window where exporting process report will be shown.

Picture 7. «Export to CHM file» window

Integrating CHM file into Microsoft Excel workbook

To open a help file from Microsoft Excel workbook you should create an object which calls a corresponding CHM file. Such object can be an image, a figure or a text box.

To create the object:

1. Open a desired workbook in Microsoft Excel;
2. Open a sheet where you want to place a help file call element;
3. Select a cell or a range of cells where you want to locate this element;
4. Add the element. To add an image or a figure, use the corresponding buttons on the «Illustrations» panel of the «Insert» tab on the main toolbar. To add a text box, use a corresponding button on the on the «Text» panel of the «Insert» tab on the main toolbar;
5. Change element location if necessary. Just drag it by mouse to the desired cell;
6. After placing the element you can create its title. For example «Help»;
7. Open a context menu by right click on the added object (Picture 8);
8. Select «Assign macro» menu item. Click «Edit» in the appeared window, after that Microsoft Visual Basic editor window will come up (Picture 9);

Picture 8. Context object menu

Picture 9. Element code in Microsoft Visual Basic editor

1. You can see your element’s name in the following string: «Sub Rectangle1_Click()» (in our example this is «Rectangle1»). Enter the following string below — Call Shell(«explorer.exe » & ActiveWorkbook.Path & «help.chm», vbNormalFocus), where help.chm is the help filename in CHM format. After all changes element code should has the following look:

Sub Rectangle1_Click()
Call Shell("explorer.exe " & ActiveWorkbook.Path & "help.chm", vbNormalFocus)
End Sub

1. Close the Microsoft Visual Basic editor window;
2. Make sure your control element works properly. Just open the form and click «Help» button. Corresponding help file created in Dr.Explain should be open;
3. Repeat described procedure for each sheet where you want to insert a help file call element.

PLEASE NOTE! To make a help file call element work properly, you have to put the CHM file and the Microsoft Excel workbook in the same folder. If it is necessary to put the help file separately from the workbook file; you have to enter the following string in the control element code: Shell «cmd /cstart D:worktechwritehelp.chm», where D:worktechwritehelp.chm is the full path to the help file in CHM format. The code will look like this:

Sub Rectangle1_Click()
Shell "cmd /cstart D:worktechwritehelp.chm"
End Sub

In this case, every time you change the help file location you have to change the path in the control element code to the actual one.

Be careful in entering control element codes; strictly follow the syntax shown in the examples. This is necessary condition for proper work of control elements.

You can use a hyperlink bound to an object to open a help file. To create a hyperlink, perform the following steps:

1. Right-click on the added object to open a context menu (Picture 8);
2. Click on «Hyperlink» menu item;
3. Enter a file location in the «Insert hyperlink» dialog;
4. If you would like to set a pop-up hint, use a «ScreenTip» button;
5. Click «OK» when finished.

Please note the file path you enter for the hyperlink is a relational one. So every time you change the workbook and help file locations relatively to each other, you have to update a help file path.

See also

• How to Create Help Files for Visual Basic (VBA.NET) Windows-Application in Dr.Explain
• How to Create Help File for MS Access (VBA) Windows-Application in Dr.Explain
• 16 Reasons Why Only Your Users Do Not Read User Documentation